File: drmaa_set_attribute.html

package info (click to toggle)
gridengine 6.2-4
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 51,532 kB
  • ctags: 51,172
  • sloc: ansic: 418,155; java: 37,080; sh: 22,593; jsp: 7,699; makefile: 5,292; csh: 4,244; xml: 2,901; cpp: 2,086; perl: 1,895; tcl: 1,188; lisp: 669; ruby: 642; yacc: 393; lex: 266
file content (272 lines) | stat: -rw-r--r-- 8,791 bytes parent folder | download | duplicates (10)
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
<HTML>
<BODY BGCOLOR=white>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
NAME
     drmaa_allocate_job_template,      drmaa_delete_job_template,
     drmaa_set_attribute,                    drmaa_get_attribute,
     drmaa_set_vector_attribute,      drmaa_get_vector_attribute,
     drmaa_get_next_attr_value,        drmaa_get_num_attr_values,
     drmaa_release_attr_values - Grid Engine DRMAA  job  template
     handling

SYNOPSIS
     #include "drmaa.h"

     int drmaa_allocate_job_template(
          drmaa_job_template_t **jt,
          char *error_diagnosis,
          size_t error_diag_len
     );

     int drmaa_delete_job_template(
          drmaa_job_template_t *jt,
          char *error_diagnosis,
          size_t error_diag_len
     );

     int drmaa_set_attribute(
          drmaa_job_template_t *jt,
          const char *name,
          const char *value,
          char *error_diagnosis,
          size_t error_diag_len
     );

     int drmaa_get_attribute(
          drmaa_job_template_t *jt,
          const char *name,
          char *value,
          size_t value_len,
          char *error_diagnosis,
          size_t error_diag_len
     );

     int drmaa_set_vector_attribute(
          drmaa_job_template_t *jt,
          const char *name,
          const char *value[],
          char *error_diagnosis,
          size_t error_diag_len
     );

     int drmaa_get_vector_attribute(
          drmaa_job_template_t *jt,
          const char *name,
          drmaa_attr_values_t **values,
          char *error_diagnosis,
          size_t error_diag_len
     );

     int drmaa_get_next_attr_value(
          drmaa_attr_values_t* values,
          char *value,
          int value_len
     );

     int drmaa_get_num_attr_values(
          drmaa_attr_values_t* values,
          int *size
     );

     void drmaa_release_attr_values(
          drmaa_attr_values_t* values
     );

DESCRIPTION
     The drmaa_allocate_job_template() function allocates  a  new
     DRMAA  job  template  into  <I>jt</I>. DRMAA job templates describe
     specifics of jobs that are submitted using  <B><A HREF="../htmlman3/drmaa_run_job.html">drmaa_run_job(3)</A></B>
     and <B><A HREF="../htmlman3/drmaa_run_bulk_jobs.html">drmaa_run_bulk_jobs(3)</A></B>.

  drmaa_delete_job_template()
     The  drmaa_delete_job_template()   function   releases   all
     resources  associated  with  the DRMAA job template <I>jt</I>. Jobs
     that were submitted using the job template are not affected.

  drmaa_set_attribute()
     The drmaa_set_attribute() function stores  the  <I>value</I>  under
     <I>name</I>  for the given DRMAA job template, <I>jt</I> . Only non-vector
     attributes may be passed.

  drmaa_get_attribute()
     The drmaa_get_attribute() function returns into <I>value</I> up  to
     <I>value</I>_<I>len</I>  bytes  from  the string stored for the non-vector
     attribute, <I>name</I>, in the DRMAA job template, <I>jt</I>.

  drmaa_set_vector_attribute()
     The drmaa_set_vector_attribute() function stores the strings
     in <I>value</I> under <I>name</I> in the list of vector attributes for the
     given DRMAA job template, <I>jt</I> . Only vector attributes may be
     passed. The <I>value</I> pointer array must be <I>NULL</I> terminated.

  drmaa_get_vector_attribute()
     The  drmaa_get_vector_attribute()  function   returns   into
     <I>values</I> a DRMAA attribute string vector containing all string
     values stored in the vector attribute, <I>name</I>. The  values  in
     the  DRMAA  values  string  vector  can  be  extracted using
     <B><A HREF="../htmlman3/drmaa_get_next_attr_value.html">drmaa_get_next_attr_value(3)</A></B>.  The caller is responsible for
     releasing  the  DRMAA  values  string  vector  returned into
     <I>values</I> using <B><A HREF="../htmlman3/drmaa_release_attr_values.html">drmaa_release_attr_values(3)</A></B>.

  drmaa_get_next_attr_value()
     Each time drmaa_get_next_attr_value() is called  it  returns
     into <I>value</I> up to <I>value</I>_<I>len</I> bytes of the next entry stored in
     the DRMAA values string vector, <I>values</I>.  With the DRMAA  1.0
     library,   once   the   values   list  has  been  exhausted,
     DRMAA_ERRNO_NO_MORE_ELEMENTS is returned.   With  the  DRMAA
     0.95  library,  once  the  values  list  has been exhausted,
     DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE is returned.   In  order
     to  use the DRMAA 0.95 library, you must define the DRMAA_95
     macro, either in your application directly or through a com-
     piler flag, such as -DDRMAA_95.

  drmaa_get_num_attr_values()
     The drmaa_get_num_attr_values() returns into <I>size</I> the number
     of entries in the DRMAA values string vector.  This function
     is only available in the 1.0 implementation.

  drmaa_release_attr_values()
     The  drmaa_release_attr_values()   function   releases   all
     resources  associated  with  the DRMAA values string vector,
     <I>values</I>.

ENVIRONMENTAL VARIABLES
     SGE_ROOT       Specifies the location  of  the  Grid  Engine
                    standard configuration files.

     SGE_CELL       If set, specifies  the  default  Grid  Engine
                    cell  to  be  used.  To address a Grid Engine
                    cell Grid Engine uses (in the order  of  pre-
                    cedence):

                         The name of the cell  specified  in  the
                         environment  variable SGE_CELL, if it is
                         set.

                         The  name  of  the  default  cell,  i.e.
                         default.


     SGE_DEBUG_LEVEL
                    If  set,  specifies  that  debug  information
                    should  be written to stderr. In addition the
                    level of detail in which debug information is
                    generated is defined.

     SGE_QMASTER_PORT
                    If set,  specifies  the  tcp  port  on  which
                    <B><A HREF="../htmlman8/sge_qmaster.html">sge_qmaster(8)</A></B> is expected to listen for com-
                    munication requests.  Most installations will
                    use  a  services  map entry instead to define
                    that port.

RETURN VALUES
     Upon successful  completion,  drmaa_allocate_job_template(),
     drmaa_delete_job_template(),          drmaa_set_attribute(),
     drmaa_get_attribute(),         drmaa_set_vector_attribute(),
     drmaa_get_vector_attribute(),                            and
     drmaa_get_next_attr_value()   return    DRMAA_ERRNO_SUCCESS.
     Other  values indicate an error.  Up to <I>error</I>_<I>diag</I>_<I>len</I> char-
     acters of error related diagnosis information is  then  pro-
     vided in the buffer <I>error</I>_<I>diagnosis</I>.

ERRORS
     The                           drmaa_allocate_job_template(),
     drmaa_delete_job_template(),          drmaa_set_attribute(),
     drmaa_get_attribute(),         drmaa_set_vector_attribute(),
     drmaa_get_vector_attribute(),                            and
     drmaa_get_next_attr_value() functions will fail if:

  DRMAA_ERRNO_INTERNAL_ERROR
     Unexpected  or  internal  DRMAA  error,  like  system   call
     failure, etc.

  DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE
     Could not contact DRM system for this request.

  DRMAA_ERRNO_AUTH_FAILURE
     The specified request is not processed successfully  due  to
     authorization failure.

  DRMAA_ERRNO_INVALID_ARGUMENT
     The input value for an argument is invalid.

  DRMAA_ERRNO_NO_ACTIVE_SESSION
     Failed because there is no active session.

  DRMAA_ERRNO_NO_MEMORY
     Failed allocating memory.

     The drmaa_set_attribute()  and  drmaa_set_vector_attribute()
     will fail if:

  DRMAA_ERRNO_INVALID_ATTRIBUTE_FORMAT
     The format for the attribute value is invalid.

  DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
     The value for the attribute is invalid.

  DRMAA_ERRNO_CONFLICTING_ATTRIBUTE_VALUES
     The value of this attribute is conflicting with a previously
     set attributes.
     The drmaa_get_attribute()  and  drmaa_get_vector_attribute()
     will fail if:

  DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
     The specified attribute is not set in  the  DRMAA  job  tem-
     plate.

     The drmaa_get_next_attr_value() will fail if:

  DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
     When there are no more entries in the vector.

SEE ALSO
     <B><A HREF="../htmlman3/drmaa_submit.html">drmaa_submit(3)</A></B>and <B><A HREF="../htmlman3/drmaa_attributes.html">drmaa_attributes(3)</A></B>.






































</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>