IXpsSignatureRequest::GetRequestId method
Gets the unique identifier of the signature request.
Syntax
HRESULT GetRequestId(
[out, retval] LPWSTR *requestId
);
Parameters
- requestId [out, retval]
The unique identifier of the signature request.
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 | requestId 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 requestId. If requestId is not NULL, use the CoTaskMemFree function to free the memory.
The requestId parameter receives the value of the SpotID attribute of the SignatureDefinition element. The SpotID attribute is required and should follow the xs:ID (XML ID) format; however, existing SignatureDefinitions parts are not checked for adherence to the recommended format. Some XPS documents that were produced by Windows Presentation Foundation (WPF) applications may have an ID that starts with a digit.
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 |