AfrFoundation CATAfrCommandHeaderArgsIterator

Usage: you must use this class as is. You should never derive it.

public class CATAfrCommandHeaderArgsIterator

Class representing an iterator for a command header argument list.

See class.

Constructor and Destructor Index


o ~CATAfrCommandHeaderArgsIterator()
Please use only CATAfrCommandHeaderArgs::CreateIterator to create and Release to delete.

Method Index


o Current(CATAfrCommandHeaderArg&)
Get the current element in the list.
o First(CATAfrCommandHeaderArg&)
Get the first element in the list.
o Next(CATAfrCommandHeaderArg&)
Get the next element in the list.
o Remove()
Remove the current element in the list.
o Set(CATBaseUnknown_var)
Change the value of the current element.

Constructor and Destructor


o ~CATAfrCommandHeaderArgsIterator
public virtual ~CATAfrCommandHeaderArgsIterator()
Please use only CATAfrCommandHeaderArgs::CreateIterator to create and Release to delete.

Methods


o Current
public Current( oNext)
Get the current element in the list.
The current element is the element returned by the last call to First or Next method.
Returns E_FAIL and gives NULL_var when current element was not previously set.
Returns E_ACCESSDENIED and gives NULL_var if the list is unusable.
Parameters:
The
argument to set.
o First
public First( oFirst)
Get the first element in the list.

Returns E_FAIL and gives NULL_var if the list is empty.
Returns E_ACCESSDENIED and gives NULL_var if the list is unusable.
Parameters:
The
argument to set.
o Next
public Next( oNext)
Get the next element in the list.

Returns E_FAIL and gives NULL_var when reaching the end of the list.
Returns E_ACCESSDENIED and gives NULL_var if the list is unusable.
Parameters:
The
argument to set.
o Remove
public Remove()
Remove the current element in the list.
Returns E_ACCESSDENIED if the list is unusable.
Returns E_FAIL if the pointer is not well positionned.
Special notice on removal: if several iterators concurrently scan the same argument list, removing an argument in one iterator might impact the scan in the others. Next, Remove and Set methods will have to check the current element still exists before doing their job and return an error if it does not exist. As soon as an iterator removes an argument, all the other existing iterators that reference this argument as the current element become unusable until you call its First method again.
Parameters:
The
argument to remove.
o Set
public Set( ihValue)
Change the value of the current element.
Returns E_ACCESSDENIED if the list is unusable.
Returns E_INVALIDARG if the new value type is not compatible with the old value type.
Returns E_FAIL if the pointer is not well positionned.
Parameters:
The
value.
This object is included in the file: CATAfrCommandHeaderArgsIterator.h
If needed, your Imakefile.mk should include the module: CATAfrFoundation

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.