ProductStructureInterfaces Interface CATIPrdIterator

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIPrdIterator

Interface to browse on a set of objects.

Method Index

o Next(CATBaseUnknown*&): Retrieves an interface pointer on the next element of the set of objects.
o Next(CATBaseUnknown_var&): Retrieves an interface smart pointer on the next element of the set of objects.

Methods

o Next

public virtual Next( oNext)

Retrieves an interface pointer on the next element of the set of objects.
Role: This method should be used like in the following example:

CATIPrdIterator* pIterator = ... ;
if (pIterator)
{
	CATBaseUnknown* pElement = NULL;
	while (SUCCEEDED(pIterator->Next(pElement)))
	{
		...
		pElement->Release();pElement=NULL;
	}
	pIterator->Release();pIterator=NULL;
}

Parameters:

oNext: [out, CATBaseUnknown#Release] The interface pointer on the next element.

Returns:

An HRESULT value.
Legal values:

S_OK if the next element was successfully retrieved.
E_FAIL if there is no more element to browse.

o Next

public virtual Next( oNext)

Retrieves an interface smart pointer on the next element of the set of objects.

Parameters:

oNext: The interface smart pointer on the next element.

Returns:

An HRESULT value.
Legal values:

S_OK if the next element was successfully retrieved.
E_FAIL if there is no more element to browse.

This object is included in the file: CATIPrdIterator.h
If needed, your Imakefile.mk should include the module: CATProductStructureInterfaces