Previous: SDDS_GetColumn
Up: Manual Pages
Next: SDDS_GetColumnInDoubles
Previous Page: SDDS_GetColumn
Next Page: SDDS_GetColumnInDoubles

SDDS_GetColumnDefinition

• name:
  SDDS_GetColumnDefinition
• description:
  Returns a pointer to a structure describing a named data column.
• synopsis: #include "SDDS.h"
  COLUMN_DEFINITION *SDDS_GetColumnDefinition(SDDS_TABLE *SDDS_table, char *name)

  typedef struct {
      char *name, *symbol, *units, *description, *format_string;
      long type, field_length;
      /* internal data follows that should not be accessed by users */
      } COLUMN_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 column for which the definition is desired.
• return value:
  On success, returns the address of the internally-stored structure containing the definition of the column. On failure, returns NULL and records an error message.
• see also:
  • SDDS_GetColumnInformation
  • SDDS_GetColumnNames
  • SDDS_NumberOfErrors
  • SDDS_PrintErrors