Daylight v4.9
Release Date: 1 February 2008

Name

dt_summary - find the datatype summary of an object

Generic Prototype

dt_summary(dt_Handle) => dt_String

C Prototype

#include "dt_thor.h"

dt_String dt_summary(dt_Integer *len, dt_Handle object)

FORTRAN Prototype

include 'dt_f_thor.inc'

integer*4 dt_f_summary(object, string)

integer*4 object
character*() string

Description

Finds the datatype summary of the object (the _S<> dataitem from the datatype definition TDT). 'object' may be datafield or fieldtypes (THOR) and columns or fieldtypes (Merlin). If the object has no summary in its definition, returns the 'invalid string'.

Return Value

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

Related Topics

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