4.102 SDDS_VerifyParameterExists

• name:
  SDDS_VerifyParameterExists
• description:
  Returns the index of a named parameter if it exists as the specified data type.
• synopsis: #include ”SDDS.h”
  int32_t SDDS_VerifyParameterExists(SDDS_TABLE *SDDS_table, int32_t mode, char *name) int32_t SDDS_VerifyParameterExists(SDDS_TABLE *SDDS_table, int32_t mode, int32_t type, char *name)
• arguments:
  • SDDS_table: Address of the SDDS_TABLE structure for the data set.
  • mode: Valid modes are FIND_SPECIFIED_TYPE, FIND_ANY_TYPE, FIND_NUMERIC_TYPE, FIND_FLOATING_TYPE, FIND_INTEGER_TYPE
  • type: If mode is FIND_SPECIFIED_TYPE it expects an SDDS data type.
  • name: Name of the parameter in question.
• return value:
  If the desired parameter exists it returns the index of the SDDS parameter. Otherwise it returns -1.
  
  On failure, returns zero and records an error message.
• see also:
  • SDDS_GetParameterDefinition
  • SDDS_GetParameterIndex
  • SDDS_GetParameterInformation