4.62 SDDS_GetParameterDefinition

• name:
  SDDS_GetParameterDefinition
• description:
  Returns a pointer to a structure describing a named data parameter.
• synopsis: #include ”SDDS.h”
  PARAMETER_DEFINITION *SDDS_GetParameterDefinition(SDDS_TABLE *SDDS_table, char *name);
  
  typedef struct {  
      char *name, *symbol, *units, *description, *format_string, *fixed_value;  
      int32_t type;  
      /* internal data follows that should not be accessed by users */  
  } PARAMETER_DEFINITION;

• 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 for which the definition is desired.
• return value:
  On success, returns the address of the internally-stored structure containing the definition of the parameter. On failure, returns NULL and records an error message.
• see also:
  • SDDS_GetParameterInformation
  • SDDS_GetParameterNames
  • SDDS_NumberOfErrors
  • SDDS_PrintErrors