All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPlantShipInterfaces Interface CATIPspGroupable
System.IUnknown
|
+---CATIPspGroupable
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPspGroupable
Interface to query the group object.
Role: To query the group object link to this object.
Method Index
- o
ListGroups(char*,CATIUnknownList**)
- Returns a list of group objects of this object.
- o
OKToRemove(CATIPspGroup*,CATBoolean*)
- Query whether it is OK to remove from the group.
- o
OKToTransfer(CATIPspGroup*,CATBoolean*)
- Query whether it is OK to transfer to another group.
Methods
o ListGroups
-
Returns a list of group objects of this object.
- Parameters:
-
- iClassType
- class type filter
- oListOfGroups
- [out, IUnknown#Release] A list of groups containing this object as a member
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o OKToRemove
-
Query whether it is OK to remove from the group.
- Parameters:
-
- iGroup
- group of the object to query.
(if NULL, assume there is only one group)
- oBYes
- If TRUE, then it is OK to remove from the group
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o OKToTransfer
-
Query whether it is OK to transfer to another group.
- Parameters:
-
- iGroup
- group to transfer object to.
- oBYes
- If TRUE, then it is OK to transfer to the group
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIPspGroupable.h