drmaa_misc(3)                  Grid Engine DRMAA                 drmaa_misc(3)



[1mNAME[0m
       drmaa_strerror,  drmaa_get_contact, drmaa_version, drmaa_get_DRM_system
       - Miscellaneous DRMAA functions.


[1mSYNOPSIS[0m
       [1m#include "drmaa.h"[0m

       [1mconst char *drmaa_strerror([0m
              [1mint drmaa_errno[0m
       [1m);[0m

       [1mint drmaa_get_contact([0m
              [1mchar *contact,[0m
              [1msize_t contact_len,[0m
              [1mchar *error_diagnosis,[0m
              [1msize_t error_diag_len[0m
       [1m);[0m

       [1mint drmaa_version([0m
              [1munsigned int *major,[0m
              [1munsigned int *minor,[0m
              [1mchar *error_diagnosis,[0m
              [1msize_t error_diag_len[0m
       [1m);[0m

       [1mint drmaa_get_DRM_system([0m
              [1mchar *drm_system,[0m
              [1msize_t drm_system_len,[0m
              [1mchar *error_diagnosis,[0m
              [1msize_t error_diag_len[0m
       [1m);[0m

       [1mint drmaa_get_DRMAA_implementation([0m
              [1mchar *drm_impl,[0m
              [1msize_t drm_impl_len,[0m
              [1mchar *error_diagnosis,[0m
              [1msize_t error_diag_len[0m
       [1m);[0m


[1mDESCRIPTION[0m
       The drmaa_strerror() function returns a message  text  associated  with
       the  DRMAA  error  number,  [4mdrmaa_errno[24m.  For invalid DRMAA error codes
       `NULL' is returned.

   [1mdrmaa_get_contact()[0m
       The drmaa_get_contact() returns an  opaque  string  containing  contact
       information  related  to  the current DRMAA session to be used with the
       [4mdrmaa_init[24m(3) function. The  opaque  string  contains  the  information
       required by drmaa_init() to reconnect to the current session instead of
       creating a new session.  [4mdrmaa_init[24m(3) function.

       The drmaa_get_contact() function returns  the  same  value  before  and
       after [4mdrmaa_init[24m(3) is called.


   [1mdrmaa_version()[0m
       The  drmaa_version()  function  returns into the integers pointed to by
       [4mmajor[24m and [4mminor[24m, the major and  minor  version  numbers  of  the  DRMAA
       library.   For a DRMAA 1.0 compliant implementation `1' and `0' will be
       returned in [4mmajor[24m and [4mminor[24m, respectively.


   [1mdrmaa_get_DRM_system()[0m
       The drmaa_get_DRM_system()  function  returns  into  [4mdrm_system[24m  up  to
       [4mdrm_system_len[24m  characters  of  a string containing Grid Engine product
       and version information.

       The drmaa_get_DRM_system() function returns the same value  before  and
       after [4mdrmaa_init[24m(3) is called.


   [1mdrmaa_get_DRMAA_implementation()[0m
       The  drmaa_get_DRMAA_implementation()  function returns into [4mdrm_system[0m
       up to [4mdrm_system_len[24m characters of a string containing the Grid  Engine
       DRMAA  implementation  version information.  In the current implementa-
       tion, 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 [4mdrmaa_init[24m(3) is called.


[1mENVIRONMENTAL VARIABLES[0m
       [1mGE_ROOT        [22mSpecifies the location of the Grid Engine standard  con-
                      figuration files.

       [1mGE_CELL        [22mIf  set,  specifies  the  default Grid Engine cell to be
                      used. To address a Grid Engine cell Grid Engine uses (in
                      the order of precedence):

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

                             The name of the default cell, i.e. [1mdefault[22m.


       [1mGE_DEBUG_LEVEL [22mIf set, specifies that debug information should be writ-
                      ten  to stderr. In addition the level of detail in which
                      debug information is generated is defined.

       [1mGE_QMASTER_PORT[0m
                      If set, specifies the tcp port on which [4mge_qmaster[24m(8) is
                      expected  to  listen  for  communication requests.  Most
                      installations will use a services map entry  instead  to
                      define that port.

[1mRETURN VALUES[0m
       Upon  successful  completion, drmaa_get_contact(), drmaa_version(), and
       drmaa_get_DRM_system() return DRMAA_ERRNO_SUCCESS. Other  values  indi-
       cate  an error.  Up to [4merror_diag_len[24m characters of error related diag-
       nosis information is then provided in the buffer [4merror_diagnosis[24m.


[1mERRORS[0m
       The drmaa_get_contact(), drmaa_version(),  drmaa_get_DRM_system(),  and
       drmaa_get_DRMAA_implementation() will fail if:

   [1mDRMAA_ERRNO_INTERNAL_ERROR[0m
       Unexpected or internal DRMAA error, like system call failure, etc.

   [1mDRMAA_ERRNO_DRM_COMMUNICATION_FAILURE[0m
       Could not contact DRM system for this request.

   [1mDRMAA_ERRNO_AUTH_FAILURE[0m
       The  specified  request is not processed successfully due to authoriza-
       tion failure.

   [1mDRMAA_ERRNO_INVALID_ARGUMENT[0m
       The input value for an argument is invalid.

   [1mDRMAA_ERRNO_NO_MEMORY[0m
       Failed allocating memory.

       The drmaa_get_contact() and drmaa_get_DRM_system() will fail if:

   [1mDRMAA_ERRNO_NO_ACTIVE_SESSION[0m
       Failed because there is no active session.

[1mSEE ALSO[0m
       [4mdrmaa_session[24m(3).




GE 6.2u2                 $Date: 2008/07/08 09:10:04 $            drmaa_misc(3)
