IOpcSigningOptions::SetSignatureId method

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

Syntax


HRESULT SetSignatureId(
  [in] LPCWSTR signatureId
);

Parameters

signatureId [in]

The value of the Id attribute.

Return value

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

Return codeDescription
S_OK

The method succeeded.

E_POINTER

The signatureId parameter is NULL.

 

Remarks

The Id attribute of the Signature element is optional. If this method is not called, the Signature element will not have the Id attribute.

To access the Id before the signature is generated, call the IOpcSigningOptions::GetSignatureId. To access the signature Id after the signature is generated, call the IOpcDigitalSignature::GetSignatureId method.

Thread Safety

Packaging objects are not thread-safe.

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

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Msopc.h

IDL

OpcDigitalSignature.idl

See also

IOpcSigningOptions
Overviews
Getting Started with the Packaging API
Packaging API Programming Guide
Reference
IOpcDigitalSignature
IOpcDigitalSignatureManager
Core Packaging Interfaces
Packaging Digital Signature Interfaces
Packaging Interfaces
Packaging API Reference
Packaging API Samples

 

 

Community Additions

ADD
Show: