Release Date: 1 February 2008
Namedt_thor_tdt2str - convert a TDT into a string representation
Generic Prototypedt_thor_tdt2str(dt_Handle, dt_Boolean) => dt_String
C Prototype#include "dt_thor.h"
dt_String dt_thor_tdt2str(dt_Integer *len, dt_Handle tdt, dt_Boolean expand)
FORTRAN Prototypeinclude 'dt_f_thor.inc'
integer*4 dt_f_thor_tdt2str(tdt, expand, string)
DescriptionConverts the tdt object 'tdt' into its lexical (string) representation.
If 'expand' is FALSE, indirect references in the datatree are not expanded. The string representation will contain the "raw" indirect reference identifiers. If 'expand' is TRUE, indirect references are expanded and the string representation will contain the indirect data.
Although it is possible to manipulate the string representation of a tdt, this practice is discouraged. The primary purpose of this function is for dumping databases for archiving or data exchange. The actual details of the lexical representation of a tdt may change from version to version, so an application which depends upon modification of the string tdts is less portable than one which uses the tdt-toolkit functions, which are guaranteed to be stable between releases.
Return ValueReturns a string containing the lexical representation of the tdt. The tdt2str value of all other objects is defined as the 'invalid string'.
Related Topicsdt_server(3) dt_thor_alloc_dataitem(3) dt_thor_str2tdt(3) dt_thor_tdtget(3) dt_thor_xrefget(3)