IOpcDigitalSignature::GetSignatureId method

Gets the value of the Id attribute from the Signature element of the signature markup.

Syntax


HRESULT GetSignatureId(
  [out, retval] LPCWSTR *signatureId
);

Parameters

signatureId [out, retval]

A pointer to the Id attribute value of the signature markup Signature element.

If the Signature element does not have an Id attribute value, signatureId will be the empty string.

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 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. If this method is not called, the Signature element will not have the Id attribute.

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

To access the Id before the signature is generated, call the IOpcSigningOptions::GetSignatureId. method.

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
IOpcSigningOptions
Core Packaging Interfaces
Packaging Digital Signature Interfaces
Packaging Interfaces
Packaging API Reference
Packaging API Samples

 

 

Community Additions

ADD
Show: