All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPlantShipInterfaces Interface CATIPspGroup

System.IUnknown
  |
  +---CATIPspGroup
 

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


interface CATIPspGroup

Interface to manage group members in making logical relationship.
Role: To modify and query members of the group.


Method Index


o AddMember(CATIPspGroupable*)
Add member object to this group object.
o ListMembers(char*,CATIUnknownList**,int)
Returns a list of member objects associated to this group object.
o RemoveMember(CATIPspGroupable*)
Remove member object from this group object.

Methods


o AddMember
public virtual HRESULT AddMember(CATIPspGroupable* iMember)= 0
Add member object to this group object.
Parameters:
iMember
An object to be added
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListMembers
public virtual HRESULT ListMembers( const char* iClassType,
CATIUnknownList** oListOfMembers,
const int iReturnBranchCnx=0 )= 0
Returns a list of member objects associated to this group object.
Parameters:
iClassType
Class Type filter. If null, no filtering will be applied.
oListOfMembers
[out, IUnknown#Release] A list of member objects
iReturnBranchCnx
Optional parameter to indicate if branch connections are returned as members of the group. Default is not to include branch connections.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o RemoveMember
public virtual HRESULT RemoveMember(CATIPspGroupable* iMember)= 0
Remove member object from this group object.
Parameters:
iMember
An object to be removed
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIPspGroup.h

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