Tivoli Header
Tivoli Storage Manager Using the Application Program Interface
The dsmGroupHandler function call performs an action on a
logical file group depending on the input that is given. The client
relates a number of individual objects together to reference and manage on the
TSM server as a logical group. For more information, see "File Grouping".
Syntax
dsInt16_t dsmGroupHandler (dsmGroupHandlerIn_t *dsmGroupHandlerInP,
dsmGroupHandlerOut_t *dsmGroupHandlerOutP);
Parameters
- dsmGroupHandlerIn_t *dsmGroupHandlerInP (I)
- Passes group attributes to the API.
- groupType
- The type of the group. Values include:
- DSM_GROUPTYPE_PEER A peer group.
- actionType
- The action to be executed. Values include:
- DSM_GROUP_ACTION_OPEN Creates a new group.
- DSM_GROUP_ACTION_CLOSE Commits and saves an open group.
- DSM_GROUP_ACTION_ADD Appends to a group.
- DSM_GROUP_ACTION_ASSIGNTO Assigns to another group.
- DSM_GROUP_ACTION_REMOVE Removes a member from a group.
- memberType.
- The group type of the object. Values include:
- DSM_MEMBERTYPE_LEADER Group leader.
- DSM_MEMBERTYPE_MEMBER Group member.
- *uniqueGroupTagP
- A unique string ID that is associated with a group.
- leaderObjId
- The Object ID for the group leader.
- *objNameP
- A pointer to the object name of the group leader.
- memberObjList
- A list of objects to remove or assign.
- dsmGroupHandlerOut_t *dsmGroupHandlerOutP (O)
- Passes the address of the structure that the API completes. The
structure version number is returned.
Return Codes
The return code numbers are provided in parentheses ( ).
Table 32. Return Codes for dsmGroupHandler
Return Code
| Explanation
|
DSM_RC_ABORT_INVALID_GROUP_ACTION (237)
| An invalid operation was attempted on a group leader or member.
|
[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]