← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/htmlman/htmlman3/drmaa_get_vector_attribute.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/drmaa_get_vector_attribute.html
 
1
<HTML>
 
2
<BODY BGCOLOR=white>
 
3
<PRE>
 
4
<!-- Manpage converted by man2html 3.0.1 -->
 
5
NAME
 
6
     drmaa_allocate_job_template,      drmaa_delete_job_template,
 
7
     drmaa_set_attribute,                    drmaa_get_attribute,
 
8
     drmaa_set_vector_attribute,      drmaa_get_vector_attribute,
 
9
     drmaa_get_next_attr_value,        drmaa_get_num_attr_values,
 
10
     drmaa_release_attr_values - Grid Engine DRMAA  job  template
 
11
     handling
 
12
 
 
13
SYNOPSIS
 
14
     #include "drmaa.h"
 
15
 
 
16
     int drmaa_allocate_job_template(
 
17
          drmaa_job_template_t **jt,
 
18
          char *error_diagnosis,
 
19
          size_t error_diag_len
 
20
     );
 
21
 
 
22
     int drmaa_delete_job_template(
 
23
          drmaa_job_template_t *jt,
 
24
          char *error_diagnosis,
 
25
          size_t error_diag_len
 
26
     );
 
27
 
 
28
     int drmaa_set_attribute(
 
29
          drmaa_job_template_t *jt,
 
30
          const char *name,
 
31
          const char *value,
 
32
          char *error_diagnosis,
 
33
          size_t error_diag_len
 
34
     );
 
35
 
 
36
     int drmaa_get_attribute(
 
37
          drmaa_job_template_t *jt,
 
38
          const char *name,
 
39
          char *value,
 
40
          size_t value_len,
 
41
          char *error_diagnosis,
 
42
          size_t error_diag_len
 
43
     );
 
44
 
 
45
     int drmaa_set_vector_attribute(
 
46
          drmaa_job_template_t *jt,
 
47
          const char *name,
 
48
          const char *value[],
 
49
          char *error_diagnosis,
 
50
          size_t error_diag_len
 
51
     );
 
52
 
 
53
     int drmaa_get_vector_attribute(
 
54
          drmaa_job_template_t *jt,
 
55
          const char *name,
 
56
          drmaa_attr_values_t **values,
 
57
          char *error_diagnosis,
 
58
          size_t error_diag_len
 
59
     );
 
60
 
 
61
     int drmaa_get_next_attr_value(
 
62
          drmaa_attr_values_t* values,
 
63
          char *value,
 
64
          int value_len
 
65
     );
 
66
 
 
67
     int drmaa_get_num_attr_values(
 
68
          drmaa_attr_values_t* values,
 
69
          int *size
 
70
     );
 
71
 
 
72
     void drmaa_release_attr_values(
 
73
          drmaa_attr_values_t* values
 
74
     );
 
75
 
 
76
DESCRIPTION
 
77
     The drmaa_allocate_job_template() function allocates  a  new
 
78
     DRMAA  job  template  into  <I>jt</I>. DRMAA job templates describe
 
79
     specifics of jobs that are submitted using  <B><A HREF="../htmlman3/drmaa_run_job.html">drmaa_run_job(3)</A></B>
 
80
     and <B><A HREF="../htmlman3/drmaa_run_bulk_jobs.html">drmaa_run_bulk_jobs(3)</A></B>.
 
81
 
 
82
  drmaa_delete_job_template()
 
83
     The  drmaa_delete_job_template()   function   releases   all
 
84
     resources  associated  with  the DRMAA job template <I>jt</I>. Jobs
 
85
     that were submitted using the job template are not affected.
 
86
 
 
87
  drmaa_set_attribute()
 
88
     The drmaa_set_attribute() function stores  the  <I>value</I>  under
 
89
     <I>name</I>  for the given DRMAA job template, <I>jt</I> . Only non-vector
 
90
     attributes may be passed.
 
91
 
 
92
  drmaa_get_attribute()
 
93
     The drmaa_get_attribute() function returns into <I>value</I> up  to
 
94
     <I>value</I>_<I>len</I>  bytes  from  the string stored for the non-vector
 
95
     attribute, <I>name</I>, in the DRMAA job template, <I>jt</I>.
 
96
 
 
97
  drmaa_set_vector_attribute()
 
98
     The drmaa_set_vector_attribute() function stores the strings
 
99
     in <I>value</I> under <I>name</I> in the list of vector attributes for the
 
100
     given DRMAA job template, <I>jt</I> . Only vector attributes may be
 
101
     passed. The <I>value</I> pointer array must be <I>NULL</I> terminated.
 
102
 
 
103
  drmaa_get_vector_attribute()
 
104
     The  drmaa_get_vector_attribute()  function   returns   into
 
105
     <I>values</I> a DRMAA attribute string vector containing all string
 
106
     values stored in the vector attribute, <I>name</I>. The  values  in
 
107
     the  DRMAA  values  string  vector  can  be  extracted using
 
108
     <B><A HREF="../htmlman3/drmaa_get_next_attr_value.html">drmaa_get_next_attr_value(3)</A></B>.  The caller is responsible for
 
109
     releasing  the  DRMAA  values  string  vector  returned into
 
110
     <I>values</I> using <B><A HREF="../htmlman3/drmaa_release_attr_values.html">drmaa_release_attr_values(3)</A></B>.
 
111
 
 
112
  drmaa_get_next_attr_value()
 
113
     Each time drmaa_get_next_attr_value() is called  it  returns
 
114
     into <I>value</I> up to <I>value</I>_<I>len</I> bytes of the next entry stored in
 
115
     the DRMAA values string vector, <I>values</I>.  With the DRMAA  1.0
 
116
     library,   once   the   values   list  has  been  exhausted,
 
117
     DRMAA_ERRNO_NO_MORE_ELEMENTS is returned.   With  the  DRMAA
 
118
     0.95  library,  once  the  values  list  has been exhausted,
 
119
     DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE is returned.   In  order
 
120
     to  use the DRMAA 0.95 library, you must define the DRMAA_95
 
121
     macro, either in your application directly or through a com-
 
122
     piler flag, such as -DDRMAA_95.
 
123
 
 
124
  drmaa_get_num_attr_values()
 
125
     The drmaa_get_num_attr_values() returns into <I>size</I> the number
 
126
     of entries in the DRMAA values string vector.  This function
 
127
     is only available in the 1.0 implementation.
 
128
 
 
129
  drmaa_release_attr_values()
 
130
     The  drmaa_release_attr_values()   function   releases   all
 
131
     resources  associated  with  the DRMAA values string vector,
 
132
     <I>values</I>.
 
133
 
 
134
ENVIRONMENTAL VARIABLES
 
135
     SGE_ROOT       Specifies the location  of  the  Grid  Engine
 
136
                    standard configuration files.
 
137
 
 
138
     SGE_CELL       If set, specifies  the  default  Grid  Engine
 
139
                    cell  to  be  used.  To address a Grid Engine
 
140
                    cell Grid Engine uses (in the order  of  pre-
 
141
                    cedence):
 
142
 
 
143
                         The name of the cell  specified  in  the
 
144
                         environment  variable SGE_CELL, if it is
 
145
                         set.
 
146
 
 
147
                         The  name  of  the  default  cell,  i.e.
 
148
                         default.
 
149
 
 
150
 
 
151
     SGE_DEBUG_LEVEL
 
152
                    If  set,  specifies  that  debug  information
 
153
                    should  be written to stderr. In addition the
 
154
                    level of detail in which debug information is
 
155
                    generated is defined.
 
156
 
 
157
     SGE_QMASTER_PORT
 
158
                    If set,  specifies  the  tcp  port  on  which
 
159
                    <B><A HREF="../htmlman8/sge_qmaster.html">sge_qmaster(8)</A></B> is expected to listen for com-
 
160
                    munication requests.  Most installations will
 
161
                    use  a  services  map entry instead to define
 
162
                    that port.
 
163
 
 
164
RETURN VALUES
 
165
     Upon successful  completion,  drmaa_allocate_job_template(),
 
166
     drmaa_delete_job_template(),          drmaa_set_attribute(),
 
167
     drmaa_get_attribute(),         drmaa_set_vector_attribute(),
 
168
     drmaa_get_vector_attribute(),                            and
 
169
     drmaa_get_next_attr_value()   return    DRMAA_ERRNO_SUCCESS.
 
170
     Other  values indicate an error.  Up to <I>error</I>_<I>diag</I>_<I>len</I> char-
 
171
     acters of error related diagnosis information is  then  pro-
 
172
     vided in the buffer <I>error</I>_<I>diagnosis</I>.
 
173
 
 
174
ERRORS
 
175
     The                           drmaa_allocate_job_template(),
 
176
     drmaa_delete_job_template(),          drmaa_set_attribute(),
 
177
     drmaa_get_attribute(),         drmaa_set_vector_attribute(),
 
178
     drmaa_get_vector_attribute(),                            and
 
179
     drmaa_get_next_attr_value() functions will fail if:
 
180
 
 
181
  DRMAA_ERRNO_INTERNAL_ERROR
 
182
     Unexpected  or  internal  DRMAA  error,  like  system   call
 
183
     failure, etc.
 
184
 
 
185
  DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE
 
186
     Could not contact DRM system for this request.
 
187
 
 
188
  DRMAA_ERRNO_AUTH_FAILURE
 
189
     The specified request is not processed successfully  due  to
 
190
     authorization failure.
 
191
 
 
192
  DRMAA_ERRNO_INVALID_ARGUMENT
 
193
     The input value for an argument is invalid.
 
194
 
 
195
  DRMAA_ERRNO_NO_ACTIVE_SESSION
 
196
     Failed because there is no active session.
 
197
 
 
198
  DRMAA_ERRNO_NO_MEMORY
 
199
     Failed allocating memory.
 
200
 
 
201
     The drmaa_set_attribute()  and  drmaa_set_vector_attribute()
 
202
     will fail if:
 
203
 
 
204
  DRMAA_ERRNO_INVALID_ATTRIBUTE_FORMAT
 
205
     The format for the attribute value is invalid.
 
206
 
 
207
  DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
 
208
     The value for the attribute is invalid.
 
209
 
 
210
  DRMAA_ERRNO_CONFLICTING_ATTRIBUTE_VALUES
 
211
     The value of this attribute is conflicting with a previously
 
212
     set attributes.
 
213
     The drmaa_get_attribute()  and  drmaa_get_vector_attribute()
 
214
     will fail if:
 
215
 
 
216
  DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
 
217
     The specified attribute is not set in  the  DRMAA  job  tem-
 
218
     plate.
 
219
 
 
220
     The drmaa_get_next_attr_value() will fail if:
 
221
 
 
222
  DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
 
223
     When there are no more entries in the vector.
 
224
 
 
225
SEE ALSO
 
226
     <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>.
 
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
</PRE>
 
266
<HR>
 
267
<ADDRESS>
 
268
Man(1) output converted with
 
269
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 
270
</ADDRESS>
 
271
</BODY>
 
272
</HTML>