IOpcSigningOptions::GetSignatureId method
Gets the value of the Id attribute from the Signature element.
Syntax
HRESULT GetSignatureId( [out, retval] LPCWSTR *signatureId );
Parameters
- signatureId [out, retval]
-
A pointer to the value of the Id attribute, or the empty string "" if there is no Id.
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 signatureId parameter is NULL. |
Remarks
This method allocates memory used by the string returned in signatureId. If the method succeeds, call the CoTaskMemFree function to free the memory.
The Id attribute of the Signature element is optional.
To set the signature Id, call the IOpcSigningOptions::SetSignatureId method.
To access the Id before the signature is generated, call the IOpcSigningOptions::GetSignatureId. To access the signature Id after the signature is generated, call the IOpcDigitalSignature::GetSignatureId 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
- Digital Signatures Overview
- Getting Started with the Packaging API
- Packaging API Programming Guide
- Reference
- IOpcDigitalSignature
- IOpcDigitalSignatureManager
- Core Packaging Interfaces
- Packaging Digital Signature Interfaces
- Packaging Interfaces
- Packaging API Reference
- Packaging API Samples