IOpcSignatureReference::GetId method (msopc.h)

Article
10/13/2021

Gets the identifier for the reference.

Syntax

HRESULT GetId(
  [out, retval] LPWSTR *referenceId
);

Parameters

[out, retval] referenceId

An identifier for the reference.

If the identifier is not set, referenceId will be the empty string, "".

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 referenceId parameter is NULL.

Remarks

This method allocates memory used by the string returned in referenceId. If the method succeeds, call the CoTaskMemFree function to free the memory.

Providing an identifier for a reference is optional. If used, the identifier is serialized as the optional Id attribute of a Reference element in the signature markup.

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

Share via