Previous: SDDS_DefineColumn
Up: Manual Pages
Next: SDDS_DeleteColumn
Previous Page: SDDS_DefineColumn
Next Page: SDDS_DeleteColumn

SDDS_DefineParameter

• name:
  SDDS_DefineParameter
• description:
  Processes a definition of a data parameter.
• synopsis: #include "SDDS.h"
  long SDDS_DefineParameter(SDDS_TABLE *SDDS_table, char *name, char *symbol, char *units, char *description, char *format_string, long type, char *fixed_value)
• arguments:
  • SDDS_table : Address of the SDDS_TABLE structure for the data set.
  • name: A NULL-terminated character string giving the name of the parameter. Must be supplied.
  • symbol: A NULL-terminated character string giving the symbol to be used to represent the parameter. If none is desired, pass NULL.
  • units: A NULL-terminated character string giving the units of the parameter. If none is desired, pass NULL.
  • description: A NULL-terminated character string giving a description of the parameter. If none is desired, pass NULL.
  • format_string: A NULL-terminated character string giving a printf format string to be used to print the data for ASCII output. If NULL is passed, a reasonable default will be chosen.
  • type: An integer value specifying the data type of the parameter. Must be one of the following constants, defined in SDDS.h: SDDS_DOUBLE, SDDS_FLOAT, SDDS_LONG, SDDS_SHORT, SDDS_CHARACTER, or SDDS_STRING.
  • fixed_value: A NULL-terminated character string giving the permanent value of the parameter. For data that is not of type SDDS_STRING, the string should be prepared using, for example, sprintf.
• return value:
  On success, returns the index of the newly-defined parameter. Returns -1 on failure and records an error message.
• see also:
  • SDDS_GetParameterDefinition
  • SDDS_GetParameterInformation
  • SDDS_GetParameterNames
  • SDDS_NumberOfErrors
  • SDDS_PrintErrors