IOpcSigningOptions::SetSignaturePartName method (msopc.h)

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

Syntax

HRESULT SetSignaturePartName(
  [in] IOpcPartUri *signaturePartName
);

Parameters

[in] signaturePartName

An IOpcPartUri interface pointer that represents the part name of the part where the signature markup is stored, or NULL to generate a part name when the signature is created.

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.

Remarks

Until the signature is generated, the part name of the signature part that stores the signature markup can be changed. To set a new part name, call this method with the signaturePartName parameter value set to an IOpcPartUri interface pointer that represents the new name. To clear an existing part name, set the signaturePartName parameter value to NULL.

To access the signature part name before the signature is generated, call the IOpcSigningOptions::GetSignaturePartName. 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

See also

Core Packaging Interfaces

Getting Started with the Packaging API

IOpcDigitalSignature

IOpcSigningOptions

Overviews

Packaging API Programming Guide

Packaging API Reference

Packaging API Samples

Packaging Digital Signature Interfaces

Packaging Interfaces

Reference