Previous: SDDS_GetParameterDefinition
Up: Manual Pages
Next: SDDS_GetParameterInformation
Previous Page: SDDS_GetParameterDefinition
Next Page: SDDS_GetParameterInformation

SDDS_GetParameterIndex

• name:
  SDDS_GetParameterIndex
• description:
  Returns the index of a named parameter in the data set. This is used with some routines for faster access to the data or to information about the data.
• synopsis: #include "SDDS.h"
  long SDDS_GetParameterIndex(SDDS_TABLE *SDDS_table, char *parameter_name)
• 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 information is desired.
• return value:
  On success, returns a non-negative integer giving the index of the parameter. On failure, returns -1 and records an error message.
• see also:
  • SDDS_GetParameterDefinition
  • SDDS_GetParameterInformation
  • SDDS_GetParameterNames
  • SDDS_NumberOfErrors
  • SDDS_PrintErrors