Returns string data from specified field.
Syntax
intl DlFieldGetString (DlFieldId hField, const char *form, char *buffer, intl bufSize)
Arguments
hField
Handle to field, as returned by DlFieldGet. Input
*form
The form in which the data is to be returned. Input
| *form | Return Format |
|---|---|
| SDESC | Short (32 character) description of the data. |
| LDESC | Long (256 character) description of the data. |
| printf string |
Returns formatted value data. Format specifications are identical to that used in the "C" function printf. Example: "%d total population" |
*buffer
Location to store the returned data. Output
bufSize
Maximum size of data to return in buffer. Input
Return Value
Returns TRUE if successful, else FALSE.
Notes
DlFieldGetString returns the string data contained within a specified field in the data file. You can specify the form in which the data will be returned with the argument form. Valid forms are a printf string, "SDESC" for a short (32 character) description explaining the data, or "LDESC" for a long (256 character) description of the data. These descriptions are the same descriptions that you can get using the DlFieldGetValueAttribute function. However, while DlFieldGetValueAttribute searches the data file for a given field, DlFieldGetString will return a description for the specific data value that the record pointer is currently on, as set with DlFileSearch.
See Also
DlFileSearch, DlFieldGetAttribute, DlFieldGetNum