int tsmInitParams ( TsmConnectionParams *params )

Initialises a connection params structure

Documentation

Initialises a connection params structure.

The connection params structure is an extensible means to provide optional hints to tsmConnect. These are used to specify a continuum from the specific dataset you want to open to general properties about a dataset that you are looking for.

You must call this function before calling tsmSetParam, and you should free up the param structure when you're finished with it by using tsmFreeParams.

Returns:
TRUE if all went just peachy, FALSE if it went pear shaped
Parameters:
params - a pointer to a TsmConnectionParams to allocate.
Author:
Martin Reddy
Version:
6 February 1998
See Also:
tsmConnect, tsmSetParam, tsmFreeParams, tsmPrintParams


TSMAPI_RELEASE 2.1 - Release Date: 2001/01/10 19:01:12

Back to tsmApi Home Page