IOpcUri::GetRelativeUri method (msopc.h)

Forms a relative URI for a specified part, relative to the URI represented by the current OPC URI object.

Syntax

HRESULT GetRelativeUri(
  [in]          IOpcPartUri *targetPartUri,
  [out, retval] IUri        **relativeUri
);

[in] targetPartUri

A pointer to the IOpcPartUri interface of the part URI object that represents the part name from which the relative URI is formed.

[out, retval] relativeUri

A pointer to the IUri interface of the URI of the part, relative to the current OPC URI object.

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	At least one of the targetPartUri, and relativePartUri parameters is NULL.
CreateUri function error	An HRESULT error code from the CreateUri function.
WinINet error	An HRESULT error code from a WinINet API.

Example input and output:

Input IOpcPartUri represents	Current IOpcUri represents	Returned relative IUri represents
/mydoc/markup/page.xml	/mydoc/markup/picture.jpg	picture.jpg
/mydoc/markup/page.xml	/mydoc/picture.jpg	../picture.jpg
/mydoc/markup/page.xml	/mydoc/images/pictures.jpg	../images/pictures.jpg

The behavior and performance of this method is the same on all supported Windows versions. For more information, see Getting Started with the Packaging API, and Platform Update for Windows Vista.

Packaging objects are not thread-safe.

Requirement	Value
Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	msopc.h