All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

System Interface CATIUnknownList

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIUnknownList
 

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


interface CATIUnknownList

Interface to handle a list of IUnknown interface pointers.
Role: The first element in the list has index 0.

See also:
CATIUnknownListImpl


Method Index


o Add(unsigned int,IUnknown*)
Adds an element at a given position in the list.
o Count(unsigned int*)
Returns the count of elements in the list.
o Item(unsigned int,IUnknown**)
Returns the iPosition-th element.
o Remove(IUnknown*)
Removes the first occurence of an element from the list.
o Remove(unsigned int)
Removes the occurence of an element which position is indicated by iPosition from the list.

Methods


o Add
public virtual HRESULT Add( const unsigned int iPosition,
IUnknown* iItem)= 0
Adds an element at a given position in the list.
Parameters:
iPosition
Position of the added element in the list.
iItem
Element to be added.
Returns:
If iPosition does not respect respect the following rule: 0 <= position < Count, E_FAIL is returned. The element to add must not be a NULL reference or E_POINTER will be returned.
o Count
public virtual HRESULT Count(unsigned int* oCount)= 0
Returns the count of elements in the list.
Parameters:
oCount
Count of elements
o Item
public virtual HRESULT Item( const unsigned int iPosition,
IUnknown** oItem)= 0
Returns the iPosition-th element.
Parameters:
iPosition
Element to be returned.
oItem
Returned element.
Returns:
If iPosition does not respect respect the following rule: 0 <= position < Count, E_FAIL is returned.
o Remove
public virtual HRESULT Remove(IUnknown* iItem)= 0
Removes the first occurence of an element from the list.
Parameters:
iItem
Element to be removed.
Returns:
If the element cannot be found in the list, E_FAIL is returned.
o Remove
public virtual HRESULT Remove( const unsigned int iPosition)= 0
Removes the occurence of an element which position is indicated by iPosition from the list.
Parameters:
iPosition
position of the element to be removed.
Returns:
Returns:
If iPosition does not respect respect the following rule: 0 <= position < Count, E_FAIL is returned.

This object is included in the file: CATIUnknownList.h

Copyright © 2003, Dassault Systèmes. All rights reserved.