Tivoli Header

Tivoli Storage Manager Using the Application Program Interface

dsmQueryCliOptions

The dsmQueryCliOptions function call queries important option values in the user's option files. A structure of type optStruct is passed in the call and contains the information. This call is performed before dsmInitEx is called, and it determines the setup before the session.

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

Syntax

dsInt16_t dsmQueryCliOptions
    (optStruct     *optstructP);

Parameters

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 appropriate information is entered in the fields in the structure.

The information returned in the optStruct structure is:

dsmiDir The value of the environment DSMI_DIR variable.
dsmiConfig The client option file as specified by the DSMI_CONFIG environment variable.
serverName The name of the TSM server.
commMethod The communication method 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).
passwordAccess The values are: bTrue for generate, and bFalse for prompt.

Return Codes

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


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]