GetStringField

The function get_string_field retrieves the string type field data by field ordinal number or field name.

int get_string_field (

int rmsHandle,          // open RMS file handle

int fldidx,                    // 0 based field sequence number

int elemidx,                    // 0 base field element number

char *buf,                    // pointer to the buffer to store the string

int nsize                    // the buffer size in byte

);

int get_string_field (

int rmsHandle,          // open RMS file handle

const char *fldname,          // pointer to the field name

int elemidx,                    // 0 base field element number

char *buf,                    // pointer to the buffer to store the string

int nsize                    // the buffer size in byte

);

Parameters

rmsHandle

Open RMS file handle

fldidx

0 based field sequence number

elemidx

0 base field element number

fldname

Pointer to the field name

buf

Pointer to the buffer to store the string data

nsize

The buffer size

Return Values

On success, get_string_field returns the length of the string.  If failed, it returns 0.

See Also

get_char_fieldget_char_field, get_integer_fieldget_integer_field, get_long_fieldget_long_field, get_real_fieldget_real_field, get_money_fieldget_money_field,  get_date_fieldget_date_field, get_time_fieldget_time_field, get_boolean_fieldget_boolean_field.