IOpcSignatureReference::GetUri method (msopc.h)

Gets the URI of the referenced XML element.

Syntax

HRESULT GetUri(
  [out, retval] IUri **referenceUri
);

Parameters

[out, retval] referenceUri

A pointer to the URI of the referenced element.

This URI represented by a string is "#" followed by the Id attribute value of the referenced element: "#<elementIdValue>".

For examples, see the Remarks section.

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

Remarks

The URI of the referenced element is serialized in the signature markup as the URI attribute of a Reference element.

The following table shows two examples of the referenceUri parameter value represented as strings.

referenceUri Value as String Referenced Element Element Description
"#idMyCustomObject" "<Object Id="idMyCustomObject">...</Object>" An application-specific Object element.
"#idMyElement" "<Object><MyElement Id="idMyElement">...</MyElement>...</Object>" A child element of an application-specific Object.
 

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

IOpcSignatureReference

Overviews

Packaging API Programming Guide

Packaging API Reference

Packaging API Samples

Packaging Digital Signature Interfaces

Packaging Interfaces

Reference