IXpsSigningOptions::GetSignatureId method (xpsdigitalsignature.h)

Article
02/22/2024

Gets the value of the Id attribute of the Signature element.

Syntax

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

Parameters

[out, retval] signatureId

The value of the Id attribute of the Signature element. If the Id attribute is not present, the method returns an empty string.

Return value

If the method succeeds, it returns S_OK; otherwise, it returns an HRESULT error code.

Remarks

This method allocates the memory used by the string that is returned in signatureId. If signatureId is not NULL, use the CoTaskMemFree function to free the memory.

The default value of the signature ID is an empty string.

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	xpsdigitalsignature.h