IOpcDigitalSignature::GetSignatureValue method (msopc.h)

Article
10/13/2021

Gets the decoded value in the SignatureValue element of the signature markup.

Syntax

HRESULT GetSignatureValue(
  [out] UINT8  **signatureValue,
  [out] UINT32 *count
);

Parameters

[out] signatureValue

A pointer to a buffer that contains the decoded value in the SignatureValue element of the signature markup.

[out] count

The size of the signatureHashValue buffer.

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	At least one of the signatureValue, and count parameters is NULL.

Remarks

This method allocates memory used by the buffer returned in signatureValue. If the method succeeds, call the CoTaskMemFree function to free the memory.

The SignatureValue element contains a base-64 encoded value that was computed by applying the signature method to the SignedInfo element of the signature markup. To get the signature method, call the GetSignatureMethod method.

When using the APIs to generate a signature, set the signature method by calling the IOpcSigningOptions::SetSignatureMethod 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