IOpcSigningOptions::SetTimeFormat method
Sets the format of the string retrieved by the IOpcDigitalSignature::GetSigningTime method.
Syntax
HRESULT SetTimeFormat(
[in] OPC_SIGNATURE_TIME_FORMAT timeFormat
);
Parameters
- timeFormat [in]
-
The value that describes the format of the string retrieved by the IOpcDigitalSignature::GetSigningTime method.
Return value
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
| Return code | Description |
|---|---|
|
The method succeeded. |
|
The value passed in the timeFormat parameter is not a valid OPC_SIGNATURE_TIME_FORMAT enumeration value. |
Remarks
This method changes the format of the signing time string from the default format, OPC_SIGNATURE_TIME_FORMAT_MILLISECONDS, to a format that is specified by the caller.
To access the format of the signing time string before the signature is generated, call the IOpcSigningOptions::GetTimeFormat method. To access the format 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
|
Minimum supported client | Windows 7 [desktop apps only] |
|---|---|
|
Minimum supported server | Windows Server 2008 R2 [desktop apps only] |
|
Header |
|
|
IDL |
|
See also
- IOpcSigningOptions
- Overviews
- Getting Started with the Packaging API
- Packaging API Programming Guide
- Reference
- IOpcDigitalSignature
- OPC_SIGNATURE_TIME_FORMAT
- Core Packaging Interfaces
- Packaging Digital Signature Interfaces
- Packaging Interfaces
- Packaging API Reference
- Packaging API Samples