IXpsSignature::GetSignatureId method

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

Syntax

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

Parameters

  • sigId [out, retval]
    The value of the Id attribute of the Signature element. If the Id attribute is not present, a NULL pointer is returned.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For return values that are not listed in this table, see XPS Digital Signature API Errors and XPS Document Errors.

Return code Description
S_OK

The method succeeded.

E_POINTER

sigId is NULL.

E_UNEXPECTED

The interface is not connected to the signature manager.

 

Remarks

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

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Xpsdigitalsignature.h

IDL

XpsDigitalSignature.idl

See also

IXpsSignature

IOpcDigitalSignature

IXpsSignatureManager

XPS Digital Signature API Errors

XPS Document Errors

XML Paper Specification