Previous: SDDS_GetMatrixOfRows
Up: Manual Pages
Next: SDDS_GetParameterDefinition
Previous Page: SDDS_GetMatrixOfRows
Next Page: SDDS_GetParameterDefinition
- name:
SDDS_GetParameter
- description:
Returns the value of a named parameter of the current data table of a data set.
- synopsis:
#include "SDDS.h"
void *SDDS_GetParameter(SDDS_TABLE *SDDS_table, char *parameter_name, void *memory)
- arguments:
- SDDS_table : Address of the SDDS_TABLE structure for the data set.
- parameter_name: A NULL-terminated character string giving the name of the parameter
for which the value is desired.
- memory: Pointer to memory in which to place the value of the parameter. If NULL,
memory is allocated.
- return value:
On success, returns a pointer to the location in which the data has been placed. The pointer should
be cast to data-type*, where data-type is the data type of the parameter. Note that
for type SDDS_STRING, data-type is char *.
This data is newly-allocated, and may be modified as needed by the caller.
On failure, returns NULL and records an error message.
- see also: