Tivoli Storage Manager Using the Application Program Interface

dsmQuerySessOptions

The dsmQuerySessOptions function call queries important option values that are valid in the specified session in dsmHandle. A structure of type optStruct is passed in the call and contains the information.

This call is started after a successful dsmInitEx call. The values that are returned might be different from the values returned on a dsmQueryCliOptions call, depending on values that are passed to the dsmInitEx call, primarily optString, and optFile. For information about option precedence, see Understanding Configuration Files and Options Files.

Syntax

dsInt16_t dsmQuerySessOptions
    (dsUint32_t    dsmHandle,
    optStruct      *optstructP);

Parameters

dsUint32_t dsmhandle(I)

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

optStruct *optstructP (I/O)

This parameter passes the address of the structure that the API completes. The application client is responsible for allocating storage for the structure. On successful return, the fields in the structure are completed with the appropriate information.

The information returned in the optStruct structure is:

dsmiDir	The value of the DSMI_DIR environment variable.
dsmiConfig	The dsm.opt file that the DSMI_CONFIG environment variable specifies.
serverName	The name of the TSM server stanza in the options file.
commMethod	The communication method that was selected. See the #defines for DSM_COMM_* in the dsmapitd.h file.
serverAddress	The address of the server that is based on the communication method.
nodeName	The name of the client's node (machine).
compression	The value of the compression option (bTrue=on and bFalse=off).
compressAlways	The value of the compressalways option (bTrue=on and bFalse=off).
passwordAccess	Value bTrue for generate, and bFalse for prompt.

For more information about options, see Tivoli Storage Manager Installing and Using the Backup-Archive Client for your operating system.

Return Codes

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