IOpcFactory::CreatePackageRootUri method (msopc.h)

Creates an OPC URI object that represents the root of a package.

Syntax

HRESULT CreatePackageRootUri(
  [out, retval] IOpcUri **rootUri
);

Parameters

[out, retval] rootUri

A pointer to the IOpcUri interface of the OPC URI object that represents the URI of the root of a package.

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

Remarks

The URI of the root of a package is always represented as "/".

Support on Previous Windows Versions

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.

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, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	msopc.h

See also

Getting Started with the Packaging API

IOpcFactory

Overviews

Packaging API Programming Guide

Packaging API Reference

Packaging API Samples

Packaging Errors

Platform Update for Windows Vista

Reference