void tsmPrintParams ( TsmConnectionParams params, FILE *handle )

Displays a connection params settings

Documentation

Displays a connection params settings.

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.

This function lets you easily see which hints have been specified so far, and what their values are. If you have not specified a particular hint, then it will be displayed as <not set>.

You can direct the output of this function to any stream, e.g. a file on disk, or stdout, stderr, etc.

Returns:
Nothing (void)
Parameters:
params - the TsmConnectionParams structure to display
handle - the stream to write the description out to
Author:
Martin Reddy
Version:
6 February 1998
See Also:
tsmConnect, tsmInitParams, tsmSetParam, tsmFreeParams


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

Back to tsmApi Home Page