IOpcRelationshipEnumerator::MovePrevious method (msopc.h)

Article
10/13/2021

Moves the current position of the enumerator to the previous IOpcRelationship interface pointer.

Syntax

HRESULT MovePrevious(
  [out, retval] BOOL *hasPrevious
);

Parameters

[out, retval] hasPrevious

A Boolean value that indicates the status of the IOpcRelationship interface pointer at the current position.

The value of hasPrevious is only valid when the method succeeds.

Value	Meaning
TRUE	The current position of the enumerator has been moved to the previous pointer in the collection, and that pointer is valid.
FALSE	The current position of the enumerator has been moved past the beginning of the enumerator and is no longer valid.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code/value	Description
S_OK	The method succeeded.
E_POINTER	The hasPrevious parameter is NULL.
OPC_E_ENUM_COLLECTION_CHANGED 0x80510050	The enumerator is invalid because the underlying set has changed.
OPC_E_ENUM_CANNOT_MOVE_PREVIOUS 0x80510052	The current position already precedes the first item of the enumerator.

Remarks

When an enumerator is created, the current position precedes the first pointer. To set the current position to the first pointer of the enumerator, call the MoveNext method after creating the enumerator.

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

Share via