← 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_DRM_system.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_DRM_system.html
 
1
<HTML>
 
2
<BODY BGCOLOR=white>
 
3
<PRE>
 
4
<!-- Manpage converted by man2html 3.0.1 -->
 
5
NAME
 
6
     drmaa_strerror,      drmaa_get_contact,       drmaa_version,
 
7
     drmaa_get_DRM_system - Miscellaneous DRMAA functions.
 
8
 
 
9
SYNOPSIS
 
10
     #include "drmaa.h"
 
11
 
 
12
     const char *drmaa_strerror(
 
13
          int drmaa_errno
 
14
     );
 
15
 
 
16
     int drmaa_get_contact(
 
17
          char *contact,
 
18
          size_t contact_len,
 
19
          char *error_diagnosis,
 
20
          size_t error_diag_len
 
21
     );
 
22
 
 
23
     int drmaa_version(
 
24
          unsigned int *major,
 
25
          unsigned int *minor,
 
26
          char *error_diagnosis,
 
27
          size_t error_diag_len
 
28
     );
 
29
 
 
30
     int drmaa_get_DRM_system(
 
31
          char *drm_system,
 
32
          size_t drm_system_len,
 
33
          char *error_diagnosis,
 
34
          size_t error_diag_len
 
35
     );
 
36
 
 
37
     int drmaa_get_DRMAA_implementation(
 
38
          char *drm_impl,
 
39
          size_t drm_impl_len,
 
40
          char *error_diagnosis,
 
41
          size_t error_diag_len
 
42
     );
 
43
 
 
44
DESCRIPTION
 
45
     The drmaa_strerror() function returns a message text associ-
 
46
     ated  with  the DRMAA error number, <I>drmaa</I>_<I>errno</I>. For invalid
 
47
     DRMAA error codes `NULL' is returned.
 
48
 
 
49
  drmaa_get_contact()
 
50
     The drmaa_get_contact() returns an opaque string  containing
 
51
     contact  information related to the current DRMAA session to
 
52
     be used with the <B><A HREF="../htmlman3/drmaa_init.html">drmaa_init(3)</A></B> function. In the  1.0  imple-
 
53
     mentation,   the  opaque  string  contains  the  information
 
54
     required by drmaa_init() to reconnect to the current session
 
55
     instead  of  creating  a new session. In the 0.95 implemena-
 
56
     tion, however, the drmaa_get_contact() function  returns  an
 
57
     empty string, and the <I>contact</I> parameter has no effect on the
 
58
     <B><A HREF="../htmlman3/drmaa_init.html">drmaa_init(3)</A></B> function.
 
59
 
 
60
     The drmaa_get_contact()  function  returns  the  same  value
 
61
     before and after <B><A HREF="../htmlman3/drmaa_init.html">drmaa_init(3)</A></B> is called.
 
62
 
 
63
  drmaa_version()
 
64
     The  drmaa_version()  function  returns  into  the  integers
 
65
     pointed  to  by <I>major</I> and <I>minor</I>, the major and minor version
 
66
     numbers of the DRMAA library.  For  a  DRMAA  1.0  compliant
 
67
     implementation  `1'  and  `0'  will be returned in <I>major</I> and
 
68
     <I>minor</I>, respectively.
 
69
 
 
70
  drmaa_get_DRM_system()
 
71
     The drmaa_get_DRM_system() function returns into  <I>drm</I>_<I>system</I>
 
72
     up  to <I>drm</I>_<I>system</I>_<I>len</I> characters of a string containing Grid
 
73
     Engine product and version information.
 
74
 
 
75
     The drmaa_get_DRM_system() function returns the  same  value
 
76
     before and after <B><A HREF="../htmlman3/drmaa_init.html">drmaa_init(3)</A></B> is called.
 
77
 
 
78
  drmaa_get_DRMAA_implementation()
 
79
     The drmaa_get_DRMAA_implementation() function  returns  into
 
80
     <I>drm</I>_<I>system</I>  up to <I>drm</I>_<I>system</I>_<I>len</I> characters of a string con-
 
81
     taining the Grid Engine DRMAA implementation version  infor-
 
82
     mation.      In     the    current    implementation,    the
 
83
     drmaa_get_DRMAA_implementation() function returns  the  same
 
84
     result as the drmaa_get_DRM_system() function.
 
85
 
 
86
     The drmaa_get_DRMAA_implementation()  function  returns  the
 
87
     same value before and after <B><A HREF="../htmlman3/drmaa_init.html">drmaa_init(3)</A></B> is called.
 
88
 
 
89
ENVIRONMENTAL VARIABLES
 
90
     SGE_ROOT       Specifies the location  of  the  Grid  Engine
 
91
                    standard configuration files.
 
92
 
 
93
     SGE_CELL       If set, specifies  the  default  Grid  Engine
 
94
                    cell  to  be  used.  To address a Grid Engine
 
95
                    cell Grid Engine uses (in the order  of  pre-
 
96
                    cedence):
 
97
 
 
98
                         The name of the cell  specified  in  the
 
99
                         environment  variable SGE_CELL, if it is
 
100
                         set.
 
101
 
 
102
                         The  name  of  the  default  cell,  i.e.
 
103
                         default.
 
104
 
 
105
 
 
106
     SGE_DEBUG_LEVEL
 
107
                    If  set,  specifies  that  debug  information
 
108
                    should  be written to stderr. In addition the
 
109
                    level of detail in which debug information is
 
110
                    generated is defined.
 
111
 
 
112
     SGE_QMASTER_PORT
 
113
                    If set,  specifies  the  tcp  port  on  which
 
114
                    <B><A HREF="../htmlman8/sge_qmaster.html">sge_qmaster(8)</A></B> is expected to listen for com-
 
115
                    munication requests.  Most installations will
 
116
                    use  a  services  map entry instead to define
 
117
                    that port.
 
118
 
 
119
RETURN VALUES
 
120
     Upon     successful     completion,     drmaa_get_contact(),
 
121
     drmaa_version(),     and    drmaa_get_DRM_system()    return
 
122
     DRMAA_ERRNO_SUCCESS. Other values indicate an error.  Up  to
 
123
     <I>error</I>_<I>diag</I>_<I>len</I>  characters of error related diagnosis infor-
 
124
     mation is then provided in the buffer <I>error</I>_<I>diagnosis</I>.
 
125
 
 
126
ERRORS
 
127
     The          drmaa_get_contact(),           drmaa_version(),
 
128
     drmaa_get_DRM_system(), and drmaa_get_DRMAA_implementation()
 
129
     will fail if:
 
130
 
 
131
  DRMAA_ERRNO_INTERNAL_ERROR
 
132
     Unexpected  or  internal  DRMAA  error,  like  system   call
 
133
     failure, etc.
 
134
 
 
135
  DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE
 
136
     Could not contact DRM system for this request.
 
137
 
 
138
  DRMAA_ERRNO_AUTH_FAILURE
 
139
     The specified request is not processed successfully  due  to
 
140
     authorization failure.
 
141
 
 
142
  DRMAA_ERRNO_INVALID_ARGUMENT
 
143
     The input value for an argument is invalid.
 
144
 
 
145
  DRMAA_ERRNO_NO_MEMORY
 
146
     Failed allocating memory.
 
147
 
 
148
     The drmaa_get_contact() and drmaa_get_DRM_system() will fail
 
149
     if:
 
150
 
 
151
  DRMAA_ERRNO_NO_ACTIVE_SESSION
 
152
     Failed because there is no active session.
 
153
 
 
154
SEE ALSO
 
155
     <B><A HREF="../htmlman3/drmaa_session.html">drmaa_session(3)</A></B>.
 
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>