Keyed — UNKNOWN MANUAL SECTION

NAME

Tcl_GetKeyedListField, Tcl_SetKeyedListField, Tcl_DeleteKeyedListField - Keyed list management routines.

SYNOPSIS

#include <tclExtend.h>
int
Tcl_GetKeyedListField (interp, fieldName, keyedList, fieldValuePtr);
char ∗
Tcl_SetKeyedListField (interp, fieldName, fieldvalue, keyedList);
char ∗
Tcl_DeleteKeyedListField (interp, fieldName, keyedList);

ARGUMENTS

Tcl_Interp∗interp(in) Interpreter to use for error reporting.

const char∗fieldName(in) The name of the field (the key) to perform the operation on.

const char∗keyedList(in) The keyed list to perform the operation on.

char∗∗fieldValuePtr(out) A pointer to a dynamicly allocated string containing the field value is returned here.

DESCRIPTION

These routines perform operations on keyed lists. See the Extended Tcl man page for a description of keyed lists.

Tcl_GetKeyedListField retrieves a field value from a keyed list. It returns TCL_OK if the field was found, TCL_BREAK if the field was not found and TCL_ERROR if an error occured. NULL maybe specifled for fieldValuePtr to check for the presences of a field without actually extracting the value.

Tcl_SetKeyedListField sets a field value in keyed list. It returns a pointer to a dynamically allocated string containing the new list, or NULL if an error occured.

Tcl_DeleteKeyedListField deletes a field from keyed list. It returns a pointer to a dynamically allocated string containing the new list, or NULL if an error occured.

KEYWORDS

lists, keyed