Previous: SDDS_SetColumnsOfInterest
Up: Manual Pages
Next: SDDS_SetRowFlags
Previous Page: SDDS_SetColumnsOfInterest
Next Page: SDDS_SetRowFlags
- name:
SDDS_SetParameters
- description:
Sets the value of one or more parameters for the current data table of a data set.
Must be preceeded by a call to SDDS_StartTable to initialize the table.
- synopsis:
#include "SDDS.h"
long SDDS_SetParameters(SDDS_TABLE *SDDS_table, long mode, name-or-index, value-or-pointer, ..., terminator)
- arguments:
- SDDS_table : Address of the SDDS_TABLE structure for the data set.
- mode:
A bit-wise combination of the constants
SDDS_SET_BY_INDEX, SDDS_SET_BY_NAME, SDDS_PASS_BY_VALUE, and SDDS_PASS_BY_REFERENCE,
which are defined in SDDS.h. One and only one of SDDS_SET_BY_INDEX and SDDS_SET_BY_NAME
must be set, indicating that the parameters to be set are indicated by index number or by name, respectively.
One and only one of SDDS_PASS_BY_VALUE and SDDS_PASS_BY_REFERENCE must be set, indicating that
the values for the parameters are passed by value or by reference, respectively.
The syntax for the four possible combinations is
- mode = SDDS_SET_BY_INDEX | SDDS_PASS_BY_VALUE:
long SDDS_SetParameters(SDDS_TABLE *SDDS_table, long mode, long index1, value1, long index2, value2, ..., -1)
- mode = SDDS_SET_BY_INDEX | SDDS_PASS_BY_REFERENCE:
long SDDS_SetParameters(SDDS_TABLE *SDDS_table, long mode, long index1, void *data1, long index2, void *data2, ..., -1)
- mode = SDDS_SET_BY_NAME | SDDS_PASS_BY_VALUE:
long SDDS_SetParameters(SDDS_TABLE *SDDS_table, long mode, char *name1, value1, char *name2, value2, ..., NULL)
- mode = SDDS_SET_BY_NAME | SDDS_PASS_BY_REFERENCE:
long SDDS_SetParameters(SDDS_TABLE *SDDS_table, long mode, char *name1, void *data1, char *name2, void *data2, ..., NULL)
Note that for data of type SDDS_STRING, pass-by-value means passing an item of type char *, while
pass by reference means passing an item of type char **.
- return value:
Returns 1 on success. On failure, returns 0 and records an error message.
- see also: