IOpcSigningOptions::GetTimeFormat method (msopc.h)

Article
02/22/2024

Gets the format of the string retrieved by the IOpcDigitalSignature::GetSigningTime method.

Syntax

HRESULT GetTimeFormat(
  [out, retval] OPC_SIGNATURE_TIME_FORMAT *timeFormat
);

Parameters

[out, retval] timeFormat

The value that describes the format of the signingTime parameter of GetSigningTime.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
E_POINTER	The timeFormat parameter is NULL.

Remarks

The default format of the signing time string is OPC_SIGNATURE_TIME_FORMAT_MILLISECONDS. To change the format of the signing time string, call the IOpcSigningOptions::SetTimeFormat method.

To access the format of the signing time string after the signature has been generated, call the IOpcDigitalSignature::GetTimeFormat method.

Thread Safety

Packaging objects are not thread-safe.

For more information, see the Getting Started with the Packaging API.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	msopc.h