int tsmSetTspecField ( TsmConnection connect, Pyramid *tspec )

Associates a pyramid tspec structure with a connection

Documentation

Associates a pyramid tspec structure with a connection.

For example, if you are creating a new dataset then you need to create a tspec file for this dataset. You would do this by first creating the tspec structure (e.g. with tsmCreateTspec), then associating this structure with the connection (this function), then you could call tsmWriteTspec to write the tspec file out to disk.

N.B. this function will take a complete *copy* of the tspec structure. The memory allocated for this copy will of course be deallocated when you do a tsmDisconnect. If the connection already has a tspec structure associated with it, then this will be deallocated for you before taking a copy of the new tspec structure.

N.B.2. the tsmConnect call will automatically read in a tspec for a dataset if it exists, so the tspec field of the connection will already be filled out in this case.

Returns:
TRUE if all went well, FALSE if something went wrong
Parameters:
connect - a dataset connection, as returned by tsmConnect
tspec - the Pyramid tspec structure to associate with connection
Author:
Martin Reddy
Version:
4 February 1998
See Also:
tsmWriteTspec, tspCreateTspec


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

Back to tsmApi Home Page