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
drmaa_strerror, drmaa_get_contact, drmaa_version,
drmaa_get_DRM_system - Miscellaneous DRMAA functions.
SYNOPSIS
#include "drmaa.h"
const char *drmaa_strerror(
int drmaa_errno
);
int drmaa_get_contact(
char *contact,
size_t contact_len,
char *error_diagnosis,
size_t error_diag_len
);
int drmaa_version(
unsigned int *major,
unsigned int *minor,
char *error_diagnosis,
size_t error_diag_len
);
int drmaa_get_DRM_system(
char *drm_system,
size_t drm_system_len,
char *error_diagnosis,
size_t error_diag_len
);
int drmaa_get_DRMAA_implementation(
char *drm_impl,
size_t drm_impl_len,
char *error_diagnosis,
size_t error_diag_len
);
DESCRIPTION
The drmaa_strerror() function returns a message text associ-
ated with the DRMAA error number, <I>drmaa</I>_<I>errno</I>. For invalid
DRMAA error codes `NULL' is returned.
drmaa_get_contact()
The drmaa_get_contact() returns an opaque string containing
contact information related to the current DRMAA session to
be used with the <B><A HREF="../htmlman3/drmaa_init.html">drmaa_init(3)</A></B> function. In the 1.0 imple-
mentation, the opaque string contains the information
required by drmaa_init() to reconnect to the current session
instead of creating a new session. In the 0.95 implemena-
tion, however, the drmaa_get_contact() function returns an
empty string, and the <I>contact</I> parameter has no effect on the
<B><A HREF="../htmlman3/drmaa_init.html">drmaa_init(3)</A></B> function.
The drmaa_get_contact() function returns the same value
before and after <B><A HREF="../htmlman3/drmaa_init.html">drmaa_init(3)</A></B> is called.
drmaa_version()
The drmaa_version() function returns into the integers
pointed to by <I>major</I> and <I>minor</I>, the major and minor version
numbers of the DRMAA library. For a DRMAA 1.0 compliant
implementation `1' and `0' will be returned in <I>major</I> and
<I>minor</I>, respectively.
drmaa_get_DRM_system()
The drmaa_get_DRM_system() function returns into <I>drm</I>_<I>system</I>
up to <I>drm</I>_<I>system</I>_<I>len</I> characters of a string containing Grid
Engine product and version information.
The drmaa_get_DRM_system() function returns the same value
before and after <B><A HREF="../htmlman3/drmaa_init.html">drmaa_init(3)</A></B> is called.
drmaa_get_DRMAA_implementation()
The drmaa_get_DRMAA_implementation() function returns into
<I>drm</I>_<I>system</I> up to <I>drm</I>_<I>system</I>_<I>len</I> characters of a string con-
taining the Grid Engine DRMAA implementation version infor-
mation. In the current implementation, the
drmaa_get_DRMAA_implementation() function returns the same
result as the drmaa_get_DRM_system() function.
The drmaa_get_DRMAA_implementation() function returns the
same value before and after <B><A HREF="../htmlman3/drmaa_init.html">drmaa_init(3)</A></B> is called.
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_get_contact(),
drmaa_version(), and drmaa_get_DRM_system() return
DRMAA_ERRNO_SUCCESS. Other values indicate an error. Up to
<I>error</I>_<I>diag</I>_<I>len</I> characters of error related diagnosis infor-
mation is then provided in the buffer <I>error</I>_<I>diagnosis</I>.
ERRORS
The drmaa_get_contact(), drmaa_version(),
drmaa_get_DRM_system(), and drmaa_get_DRMAA_implementation()
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_MEMORY
Failed allocating memory.
The drmaa_get_contact() and drmaa_get_DRM_system() will fail
if:
DRMAA_ERRNO_NO_ACTIVE_SESSION
Failed because there is no active session.
SEE ALSO
<B><A HREF="../htmlman3/drmaa_session.html">drmaa_session(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>
|