IOpcPartUri::ComparePartUri method

Returns an integer that indicates whether the URIs represented by the current part URI object and a specified part URI object are equivalent.

Syntax

HRESULT ComparePartUri(
  IOpcPartUri *partUri,
  INT32       *comparisonResult
);

Parameters

partUri

A pointer to the IOpcPartUri interface of the part URI object to compare with the current part URI object.

comparisonResult

Receives an integer that indicates whether the two part URI objects are equivalent.

Value Meaning
<0
The current part URI object is less than the input part URI object that is passed in partUri.
0
The current part URI object is equivalent to the input part URI object that is passed in partUri.
>0
The current part URI object is greater than the input part URI object that is passed in partUri.

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
At least one of the partUri, and comparisonResult parameters is NULL.

Remarks

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

   
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

IOpcPartUri

Overviews

Packaging API Reference

Packaging API Samples

Parts Overview

Platform Update for Windows Vista

Reference