6.111 SDDS_VerifyColumnExists

• name:
  SDDS_VerifyColumnExists
• description:
  Returns the index of a named column if it exists as the specified data type.
• synopsis: #include ”SDDS.h”
  int32_t SDDS_VerifyColumnExists(SDDS_TABLE *SDDS_table, int32_t mode, char *name) int32_t SDDS_VerifyColumnExists(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 column in question.
• return value:
  If the desired column exists it returns the index of the SDDS column. Otherwise it returns -1.
  
  On failure, returns zero and records an error message.
• see also:
  • SDDS_GetColumnDefinition
  • SDDS_GetColumnIndex
  • SDDS_GetColumnInformation