Next: SDDS_SetParameters
Up: Manual Pages
Previous: SDDS_SetColumnFromLongs
Contents
SDDS_SetColumnsOfInterest
- name:
SDDS_SetColumnsOfInterest
- description:
Modifies the acceptance status of the columns of the current data table of a data set using the column names and information supplied by the caller.
- synopsis: #include "SDDS.h"
long SDDS_SetColumnsOfInterest(SDDS_TABLE *SDDS_table, long mode, ...);
- arguments:
- SDDS_table: Address of the SDDS_TABLE structure for the data set.
- mode: One of the constants SDDS_NAME_ARRAY, SDDS_NAMES_STRING, SDDS_NAME_STRINGS, or SDDS_MATCH_STRING, defined in SDDS.h. The calling syntax for each of these modes is:
- SDDS_NAME_ARRAY - SDDS_SetColumnsOfInterest(SDDS_TABLE *SDDS_table, SDDS_NAME_ARRAY, long n_entries, char **name), where name is an array of pointers to n_entries NULL-terminated character strings. The columns named in these strings are added to the list of columns deemed to be ``of interest'' by the caller. The order in which the caller gives the column names is recorded, and calls to SDDS_GetRow and SDDS_GetMatrixOfRows return the columns in this order.
- SDDS_NAMES_STRING - SDDS_SetColumnsOfInterest(SDDS_TABLE *SDDS_table, SDDS_NAMES_STRING, char *string), where string is a NULL-terminated character string giving the names of the columns of interest separated by white-space. The columns named in these strings are added to the list of columns deemed to be ``of interest'' by the caller. The order in which the caller gives the column names is recorded, and calls to SDDS_GetRow and SDDS_GetMatrixOfRows return the columns in this order.
- SDDS_NAME_STRINGS - SDDS_SetColumnsOfInterest(SDDS_TABLE *SDDS_table, SDDS_NAME_STRINGS, char *string, ..., NULL), where string and all following arguments are NULL-terminated character strings, each giving the name of a column. The list is terminated by the value NULL. The columns named in these strings are added to the list of columns deemed to be ``of interest'' by the caller. The order in which the caller gives the column names is recorded, and calls to SDDS_GetRow and SDDS_GetMatrixOfRows return the columns in this order.
- SDDS_MATCH_STRING - SDDS_SetColumnsOfInterest(SDDS_TABLE *SDDS_table, SDDS_MATCH_STRING, char *string, long logic_mode), where string is a wildcard-containing, NULL-terminated character string to which column names will be matched. The columns so matched are added to the list of columns deemed to be ``of interest'' by the caller. The order in which the caller gives the column names is recorded, and calls to SDDS_GetRow and SDDS_GetMatrixOfRows return the columns in this order. See the manual page for SDDS_Logic for a discussion of the logic_mode parameter.
- return value:
Returns 1 on success. On failure, returns 0 and records an error message.
- see also:
Next: SDDS_SetParameters
Up: Manual Pages
Previous: SDDS_SetColumnFromLongs
Contents
Robert Soliday
2006-06-29