Tivoli Storage Manager Using the Application Program Interface

dsmQueryAccess

The dsmQueryAccess function call queries the server for all access authorization rules for either backup versions or archived copies of your objects. A pointer to an array of access rules is passed in to the call, and the completed array is returned. A pointer to the number of rules is passed in to indicate how many rules are in the array.

Syntax

dsInt16_t DSMLINKAGE dsmQueryAccess 
                   (dsUint32_t            dsmHandle),
                    qryRespAccessData     **accessListP,
                    dsUint16_t            *numberOfRules) ;

Parameters

dsUint32_t dsmHandle (I)

The handle that associates this call with a previous dsmInitEx call.

qryRespAccessData **accessListP (O)

A pointer to an array of qryRespAccessData elements that the API library allocates. Each element corresponds to an access rule. The number of elements in the array is returned in the numberOfRules parameter. The information that is returned in each qryRespAccessData element includes the following:

ruleNumber	The ID for the access rule. This identifies the rule for deletion.
AccessType	The backup or archive type.
Node	The node on which you gave access.
Owner	The user to whom you gave access.
objName	The high-level, or low-level filespace descriptors.

dsUint32_t *numberOfRules (O)

Returns the number of rules in the accessList array.

Return Codes

There are no return codes that are specific to this call.