IOpcDigitalSignature::GetSignatureMethod method

Gets the signature method used to calculate the value in the SignatureValue element of the signature markup.

Syntax


HRESULT GetSignatureMethod(
  [out, retval] LPCWSTR *signatureMethod
);

Parameters

signatureMethod [out, retval]

A pointer to the signature method.

Return value

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

Return codeDescription
S_OK

The method succeeded.

E_POINTER

The signatureMethod parameter is NULL.

 

Remarks

This method allocates memory used by the string that is returned in signatureMethod. If the method succeeds, call the CoTaskMemFree function to free the memory.

To set the signature method before the signature is generated, call the IOpcSigningOptions::SetSignatureMethod method.

To access the signature method before the signature is generated, call the IOpcSigningOptions::GetSignatureMethod. To access the signature method after the signature is generated, call the IOpcDigitalSignature::GetSignatureMethod method. Both methods retrieve the value that was set by IOpcSigningOptions::SetSignatureMethod.

Important  A valid signature method must be set before the signature is generated by calling the IOpcDigitalSignatureManager::Sign method.
 

When a signature is generated it is serialized as signature markup. The signature method is used to calculate the value in the SignatureValue element in the signature markup.

When a signature is validated, the signature method is used to recalculate that value, and the recalculated value is compared to the value in the SignatureValue element in the signature markup.

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

Msopc.h

IDL

OpcDigitalSignature.idl

See also

IOpcDigitalSignature
Overviews
Getting Started with the Packaging API
Packaging API Programming Guide
Reference
IOpcDigitalSignatureManager
IOpcSigningOptions
Core Packaging Interfaces
Packaging Digital Signature Interfaces
Packaging Interfaces
Packaging API Reference
Packaging API Samples

 

 

Community Additions

ADD
Show: