GetTimeValue

If both a Table of Contents and Search form are not displayed in separate frames along with this one, you may wish to redisplay this book in a frameset, beginning with the first page.

HP Open Source Security for OpenVMS Volume 1:...

API Functions

GetOperationalStatistics

MDS_Initialize

GetTimeValue

Library
Description
Return Value
See Also

Parameters
Notes
Errors

NAME

GetTimeValue: CSSM_GetTimeValue, CSP_GetTimeValue - Get a CSP time value (CDSA)

SYNOPSIS

# include <cssm.h>

API:CSSM_RETURN CSSMAPI CSSM_GetTimeValue(CSSM_CSP_HANDLE CSPHandle,CSSM_ALGORITHMS TimeAlgorithm,CSSM_DATA *TimeData)SPI:CSSM_RETURN CSSMCSPI CSP_GetTimeValue(CSSM_CSP_HANDLE CSPHandle,CSSM_ALGORITHMS TimeAlgorithm,kCSSM_DATA *TimeData)

LIBRARY

Common Security Services Manager library (cdsa$incssm300_shr.exe)

PARAMETERS

`CSPHandle` (input)
		Handle of the Cryptographic Service Provider thatwill perform the operation.
`TimeAlgorithm` (input)
		A CSSM algorithm type that indicates the methodfor fetching the time. The following algorithm types are supported: CSSM_ALGID_UTC Returns a time value in the form YYYYMMDDhhmmss(4 characters for the year; 2 characters each for the month, theday, the hour, the minute, and the second). The time returned isGMT. CSSM_ALGID_RUNNING_COUNTER The current value of a runninghardware counter that operates while the device is in operation.This value can be read from a processor counter provided by someplatform architectures.
`TimeData` (output)
		The time value of counter value returned in responseto the request.

DESCRIPTION

This function returns a time value maintained by a CSP. Thisfeature will be supported primarily by hardware tokens with an onboardreal time clock.

NOTES

The output is returned to the caller either by filling thecaller-specified buffer or by using the application's declared memoryallocation functions to allocate buffer space. To specify a specific,preallocated output buffer, the caller must provide an array ofone or more CSSM_DATA structures, each containing a Length fieldvalue greater than zero and a non-NULL data pointer field value.To specify automatic output buffer allocation by the CSP, the callermust provide an array of one or more CSSM_DATA structures, eachcontaining a Length field value equal to zero and a NULL data pointerfield value. The application is always responsible for deallocatingthe memory when it is no longer needed.

Some tokens require authentication before returning a timevalue.

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particularerror condition. The value CSSM_OK indicates success. All othervalues represent an error condition.

ERRORS

Errors are described in the CDSA Technical Standard.

None specific to this call.