Daylight v4.9
Release Date: 1 February 2008

Name

dt_description - retrieve the datatype description dataitem

Generic Prototype

dt_description(dt_Handle) => dt_String

C Prototype

#include "dt_thor.h"

dt_String dt_description(dt_Integer *len, dt_Handle object)

FORTRAN Prototype

include 'dt_f_thor.inc'

integer*4 dt_f_description(object, string)

integer*4 object
character*() string

Description

Finds the datatype description of the object (the _D<> dataitem from the datatype-definition TDT). 'object' may be datafield or fieldtypes (THOR) and columns or fieldtypes (Merlin).

Return Value

Returns a string. For objects other than datafields, fieldtypes, and columns, the description is defined as the 'invalid string'.

Related Topics

dt_briefname(3) dt_comments(3) dt_datatype(3) dt_dfnorm(3) dt_dfnormdata(3) dt_fieldtype(3) dt_getdatatype(3) dt_membership(3) dt_owner(3) dt_summary(3) dt_tag(3)