1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
<HTML>
<BODY BGCOLOR=white>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
NAME
lInit, lNm2Str (_lNm2Str), lStr2Nm (_lStr2Nm), lCountDescr,
lCopyDescr, lGetPosInDescr, lDumpDescr, lUndumpDescr, lWri-
teDescr
generic list manipulation and information functions
SYNOPSIS
#include "cull.h"
void lInit( lNameSpace *namev );
char* lNm2Str( int nm );
char* _lNm2Str( lNameSpace *nsp, int nm );
int lStr2Nm( char *str );
int _lStr2Nm( lNameSpace *nsp, char *str );
int lCountDescr( lDescr *descriptor );
lDescr* lCopyDescr( lDescr *descriptor );
int lGetPosInDescr( lDescr *descriptor, int nm );
void lWriteDescr( lDescr *descriptor );
int lDumpDescr(
FILE *file,
lDescr *descriptor,
int indent
);
lDescr* lUndumpDescr( FILE *file );
DESCRIPTION
lInit
initializes the name to string conversion. Names are
represented by unique numbers which are mapped to their
corresponding strings. The function argument is a
pointer to a <I>lNameSpace</I> array.
lNm2Str, _lNm2Str
converts the field names (represented by numbers) to
the corresponding strings. If the NameSpace has been
initialized with lInit() the corresponding string is
returned, otherwise the string "Nameindex = n" is
returned, where n is replaced by the field number
representing nm. _<I>lNm2Str</I> converts the field names
(represented by numbers) to the corresponding strings.
A NameSpace is delivered explicitly. The corresponding
string is returned, otherwise the string "Nameindex =
n" is returned, where n is replaced by the field number
representing nm.
lStr2Nm, _lStr2Nm
converts the string field names to the corresponding
field id's. If the <I>NameSpace</I> has been initialized with
lInit() the corresponding field id is returned, other-
wise <I>NoName</I> is returned. _<I>lStr2Nm</I> converts the string
field names to the corresponding field id's. A
NameSpace is delivered explicitly. The corresponding
field id is returned, if it can be found in the
NameSpace. Otherwise the function returns <I>NoName</I>.
lCountDescr
count the number of fields specified in the descriptor.
The descriptor is delivered as function argument. The
number of fields is returned.
lCopyDescr
duplicate the specified descriptor. The descriptor is
delivered as function argument. A pointer to the
copied descriptor is returned, NULL otherwise.
lGetPosInDescr
get the position of the field named nm from the
descriptor. If the field named nm is not contained in
the descriptor -1 is returned.
lDumpDescr
dump the list descriptor in ASCII format to a file. The
first argument is a FILE pointer of the dump file, the
second argument is the descriptor that shall be dumped
and the third argument is the number of indentation
units for formatting purposes. This function is nor-
mally used only by <B><A HREF="../htmlman3/lDumpList.html">lDumpList(3)</A></B>.
lUndumpDescr
undump the list descriptor from a dump file. A FILE
pointer to the dump file is delivered as function argu-
ment. If no error occurs a pointer to the list descrip-
tor is returned, otherwise NULL is returned. This
function is normally used only by <B><A HREF="../htmlman3/lUndumpList.html">lUndumpList(3)</A></B>.
lWriteDescr
writes a list descriptor to stdout. This function is
used for debugging only.
RETURN VALUES
The functions return -1 or NULL in case of error, otherwise
0 or a valid pointer are returned.
ERRORS
The following errors can occur in the above listed func-
tions. The functions which are affected by a special error
are enumerated in parentheses.
LENAMEOUT
This error occurs, if the name is out of namespace
ranges. (<I>lNm2Str</I>)
LEDESCRNULL
The descriptor argument is NULL. (<I>lCountDescr</I>, <I>lWri-</I>
<I>teDescr</I>, <I>lDumpDescr</I>, <I>lGetPosInDescr</I>)
LEFILENULL
The file pointer delivered is NULL. (<I>lDumpDescr</I>, <I>lUn-</I>
<I>dumpDescr</I>)
LENAMENOT
The specified name is not a field of the specified
descriptor. (<I>lGetPosInDescr</I>)
LEFIELDREAD
Reading a field value from a dump file failed. (<I>lUn-</I>
<I>dumpDescr</I>)
LEFGETDESCR
Reading a descriptor pair from a dump file failed.
(<I>lUndumpDescr</I>)
LESYNTAX
A syntax error occurred (missing opening or closing
brackets). (<I>lUndumpDescr</I>)
SEE ALSO
<B><A HREF="../htmlman1/sge_intro.html">sge_intro(1)</A></B>, <B><A HREF="../htmlman3/list_intro.html">list_intro(3)</A></B>.
COPYRIGHT
See <B><A HREF="../htmlman1/sge_intro.html">sge_intro(1)</A></B> for a full statement of rights and permis-
sions.
</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>
|
