← Back to branch summary

~ubuntu-branches/ubuntu/utopic/gridengine/utopic

« back to all changes in this revision

Viewing changes to doc/htmlman/htmlman3/_lNm2Str.html

  • Committer: Bazaar Package Importer
  • Author(s): Mark Hymers
  • Date: 2008-06-25 22:36:13 UTC
  • Revision ID: james.westby@ubuntu.com-20080625223613-tvd9xlhuoct9kyhm
Tags: upstream-6.2~beta2
Import upstream version 6.2~beta2

Show diffs side-by-side

added added

removed removed

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