Previous: SDDS_GetArray
Up: Manual Pages
Next: SDDS_GetArrayIndex
Previous Page: SDDS_GetArray
Next Page: SDDS_GetArrayIndex

SDDS_GetArrayDefinition

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

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