IOpcSigningOptions::GetSignaturePartName method (msopc.h)

Article
02/22/2024

Gets the part name of the signature part where the signature markup will be stored.

Syntax

HRESULT GetSignaturePartName(
  [out, retval] IOpcPartUri **signaturePartName
);

Parameters

[out, retval] signaturePartName

An IOpcPartUri interface pointer that represents the part name of the part where the signature markup is stored, or NULL if the part name has not been set by a call to the SetSignaturePartName method.

Return value

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

Return code	Description
S_OK	The method succeeded.
E_POINTER	The signaturePartName parameter is NULL.

Remarks

To set the part name of the signature part that stores the signature markup, call the IOpcSigningOptions::SetSignaturePartName method.

To access the signature part name after the signature is generated, call the IOpcDigitalSignature::GetSignaturePartName method.

The signature part that stores signature markup is specific to the signature.

Thread Safety

Packaging objects are not thread-safe.

For more information, see the Getting Started with the Packaging API.

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