SDDS_SetParametersFromDoubles

[next] [prev] [prev-tail] [tail] [up]

4.101 SDDS_SetParametersFromDoubles

name:
SDDS_SetParametersFromDoubles
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”
int32_t SDDS_SetParametersFromDoubles(SDDS_TABLE *SDDS_table, int32_t 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: int32_t SDDS_SetParametersFromDoubles(SDDS_TABLE *SDDS_table, int32_t mode, int32_t index1, value1, int32_t index2, value2, ..., -1)
  - mode = SDDS_SET_BY_INDEX — SDDS_PASS_BY_REFERENCE: int32_t SDDS_SetParametersFromDoubles(SDDS_TABLE *SDDS_table, int32_t mode, int32_t index1, double *data1, int32_t index2, double *data2, ..., -1)
  - mode = SDDS_SET_BY_NAME — SDDS_PASS_BY_VALUE: int32_t SDDS_SetParametersFromDoubles(SDDS_TABLE *SDDS_table, int32_t mode, char *name1, value1, char *name2, value2, ..., NULL)
  - mode = SDDS_SET_BY_NAME — SDDS_PASS_BY_REFERENCE: int32_t SDDS_SetParametersFromDoubles(SDDS_TABLE *SDDS_table, int32_t mode, char *name1, double *data1, char *name2, double *data2, ..., NULL)
return value:
Returns 1 on success. On failure, returns 0 and records an error message.
see also:

[next] [prev] [prev-tail] [front] [up]