Tivoli Header

Tivoli Storage Manager Using the Application Program Interface

dsmSetUp

The dsmSetUp function call overwrites environment variable values. Call dsmSetUp before dsmInitEx. The values that were passed in the envSetUp structure will overwrite any existing environment variables or defaults. If you specify NULL for a field, values will be taken from the environment. If you do not set a value, the values will be taken from the defaults.

For UNIX Only: For versions 3.1.6 through version 4.1.2, you cannot use the Trusted Communication Agent in multi-thread mode. If you want to use passwordaccess generate, you must be a TSM-authorized user. For version 4.2 and beyond, this is no longer true.

Note:
If you use dsmSetUp, always call dsmTerminate before dsmCleanUp.

Syntax

dsInt16_t DSMLINKAGE dsmSetUp
        (dsBool_t    mtFlag,
         envSetUp    *envSetUpP);         

Parameters

dsBool_t mtFlag (I)
This parameter specifies if the API will be used in a single thread, or a multi-thread mode. Values include:
   DSM_SINGLETHREAD
   DSM_MULTITHREAD
Note:
The multi-thread flag must be on for LAN-free data transfer to occur.

envSetUp *envSetUpP(I)
This parameter is a pointer to the structure that holds the overwrite values. Specify NULL if you do not want to override existing environment variables. The fields in the envSetUp structure include:
dsmiDir A fully-qualified directory path that contains a message file on UNIX. It also specifies the dsmtca and the dsm.sys directories.
dsmiConfig The fully-qualified name of the client options file.
dsmiLog The fully-qualified path of the error log directory.
argv Pass the argv[0] name of the calling program if the application must run as TSM-authorized. See "Using Passwordaccess Generate Without TCA" for more information.
logName The file name for an error log if the application does not use dsierror.log.

Return Codes

The return code numbers are provided in parentheses ( ).

Table 44. Return Codes for dsmSetUp

Return Code Explanation
DSM_RC_INVALID_OPT (-0400) An invalid option was found.
DSM_RC_NO_HOST_ADDR (-0405) The TCPSERVERADDRESS for this server is not defined in the server name stanza in the system options file.
DSM_RC_NO_OPT_FILE (0406) The options file specified by filename cannot be found.
DSM_RC_MACHINE_SAME (0408) The NODENAME defined in the options file cannot be the same as the system HostName.
DSM_RC_INVALID_SERVER (0409) The system options file does not contain the SERVERNAME option.
DSM_RC_INVALID_KEYWORD (0410) An invalid option keyword was found in the dsmInitEx configuration file, the option string, dsm.sys, or dsm.opt.
DSM_RC_PATTERN_TOO_COMPLEX (0411) The include or exclude pattern issued is too complex to be accurately interpreted by TSM.
DSM_RC_NO_CLOSING_BRACKET (0412) The include or exclude pattern is incorrectly constructed. The closing bracket is missing.
DSM_RC_NLS_CANT_OPEN_TXT (0610) The system is unable to open the message text file.
DSM_RC_NLS_INVALID_CNTL_REC (0612) The system is unable to use the message text file.
DSM_RC_NOT_ADSM_AUTHORIZED (0927) You must be the TSM-Authorized user to have multithreading and passwordaccess generate.
DSM_RC_NO_INCLEXCL_FILE (2229) The include-exclude file was not found.
DSM_RC_NO_SYS_OR_INCLEXCL (2230) Either the dsm.sys or the include-exclude file was not found.


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