IOpcSignatureReference::GetUri method

Gets the URI of the referenced XML element.

Syntax


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

Parameters

referenceUri [out, retval]

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 codeDescription
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 StringReferenced ElementElement 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

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

IOpcSignatureReference
Overviews
Getting Started with the Packaging API
Packaging API Programming Guide
Reference
Core Packaging Interfaces
Packaging Digital Signature Interfaces
Packaging Interfaces
Packaging API Reference
Packaging API Samples

 

 

Community Additions

ADD
Show: