Next: SDDS_GetTypeSize
Up: Manual Pages
Previous: SDDS_GetParameterType
Contents
SDDS_GetRow
- name:
SDDS_GetRow
- description:
Returns a pointer to a specified row of homogeneous data values from a table. The columns included are those declared to be ``of interest'' by calling, for example, SDDS_SetColumnsOfInterest. The rows available are those declared to be of interest by calling, for example, SDDS_SetRowsOfInterest.
- synopsis: #include "SDDS.h"
void *SDDS_GetRow(SDDS_TABLE *SDDS_table, long srow_index, void *memory);
- arguments:
- SDDS_table: Address of the SDDS_TABLE structure for the data set.
- srow_index: Index of the row desired in the list of selected rows (or ``rows of interest'').
- memory: Address of location into which to write the data values. If NULL, memory is allocated for this purpose.
- return value:
On success, returns the address of the first item of the row. This pointer should be cast to data-type*, where data-type is the data type of the columns selected. Note that for type SDDS_STRING, data-type is char *. The data is stored in newly-allocated memory (or in the memory passed by the caller), and may be modified as needed by the caller.
On failure, returns NULL and records an error message.
Next: SDDS_GetTypeSize
Up: Manual Pages
Previous: SDDS_GetParameterType
Contents
Robert Soliday
2006-06-29