All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchComponentGroup

System.IUnknown
  |
  +---CATISchComponentGroup
 

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


interface CATISchComponentGroup

Interface to manage Schematic component's group membership.
Role: To add, remove, and list component group members.


Method Index


o AddMember(CATISchAppConnectable*)
Add a member to the component group.
o ListMembers(CATIUnknownList**)
List all connectable members in the group.
o RemoveMember(CATISchAppConnectable*)
Remove a member to the component group.

Methods


o AddMember
public virtual HRESULT AddMember(CATISchAppConnectable* iCntblToAdd) = 0
Add a member to the component group.
Parameters:
iCntblToAdd
The application connectable to be added to the group
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListMembers
public virtual HRESULT ListMembers(CATIUnknownList** oLCntbl) = 0
List all connectable members in the group.
Parameters:
oLGRR
A list of connectables.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o RemoveMember
public virtual HRESULT RemoveMember(CATISchAppConnectable* iCntblToRemove) = 0
Remove a member to the component group.
Parameters:
iCntbleToRemove
The application connectable to be removed from the group
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchComponentGroup.h

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