1Tcl_GetKeyedListKeys(TCL)                            Tcl_GetKeyedListKeys(TCL)
2
3
4

NAME

6       TclX_NewKeyedListObj,       TclX_KeyedListGet,       TclX_KeyedListSet,
7       TclX_KeyedListDelete, TclX_KeyedListGetKeys  -  Keyed  list  management
8       routines.
9

SYNOPSIS

11       #include <tclExtend.h>
12
13       Tcl_Obj *
14       TclX_NewKeyedListObj (void);
15
16       int
17       TclX_KeyedListGet (Tcl_Interp *interp,
18                          Tcl_Obj    *keylPtr,
19                          char       *key,
20                          Tcl_Obj   **valuePtrPtr);
21
22       int
23       TclX_KeyedListSet (Tcl_Interp *interp,
24                          Tcl_Obj    *keylPtr,
25                          char       *key,
26                          Tcl_Obj    *valuePtr);
27
28       int
29       TclX_KeyedListDelete (Tcl_Interp *interp,
30                             Tcl_Obj    *keylPtr,
31                             char       *key);
32
33       int
34       TclX_KeyedListGetKeys (Tcl_Interp *interp,
35                              Tcl_Obj    *keylPtr,
36                              char       *key,
37                              Tcl_Obj   **listObjPtrPtr);
38
39
40

DESCRIPTION

42       These routines perform operations on keyed lists.  See the Extended Tcl
43       man page for a description of keyed lists.
44
45   TclX_NewKeyedListObj
46       Create and initialize a new keyed list object.
47
48       Returns:
49         A pointer to the object.
50
51   TclX_KeyedListGet
52         Retrieve a key value from a keyed list.
53
54       Parameters:
55         o interp - Error message will be return in  result  if  there  is  an
56         error.
57         o keylPtr - Keyed list object to get key from.
58         o key - The name of the key to extract.  Will recusively process sub-
59         keys seperated by `.'.
60         o valueObjPtrPtr - If the key is found, a pointer to the key object
61             is returned here.  NULL is returned if the key is not present.
62
63       Returns:
64         o TCL_OK - If the key value was returned.
65         o TCL_BREAK - If the key was not found.
66         o TCL_ERROR - If an error occured.
67
68   TclX_KeyedListSet
69         Set a key value in keyed list object.
70
71       Parameters:
72         o interp - Error message will be return in result object.
73         o keylPtr - Keyed list object to update.
74         o key - The name of the key to extract.  Will recusively process sub-
75         key seperated by `.'.
76         o valueObjPtr - The value to set for the key.
77
78       Returns:
79           TCL_OK or TCL_ERROR.
80
81   TclX_KeyedListDelete
82         Delete a key value from keyed list.
83
84       Parameters:
85         o  interp  -  Error  message  will be return in result if there is an
86         error.
87         o keylPtr - Keyed list object to update.
88         o key - The name of the key to extract.  Will recusively process sub-
89         key seperated by `.'.
90
91       Returns:
92         o TCL_OK - If the key was deleted.
93         o TCL_BREAK - If the key was not found.
94         o TCL_ERROR - If an error occured.
95
96   TclX_KeyedListGetKeys
97         Retrieve a list of keyed list keys.
98
99       Parameters:
100         o  interp  -  Error  message  will be return in result if there is an
101         error.
102         o keylPtr - Keyed list object to get key from.
103         o key - The name of the key to get the sub keys for.  NULL  or  empty
104         to retrieve all top level keys.
105         o listObjPtrPtr - List object is returned here with key as values.
106
107       Returns:
108         o TCL_OK - If the zero or more key where returned.
109         o TCL_BREAK - If the key was not found.
110         o TCL_ERROR - If an error occured.
111
112
113
114
115
116Tcl                                                  Tcl_GetKeyedListKeys(TCL)