drmaa_misc(3)                  Grid Engine DRMAA                 drmaa_misc(3)



NNAAMMEE
       drmaa_strerror,  drmaa_get_contact, drmaa_version, drmaa_get_DRM_system
       - Miscellaneous DRMAA functions.


SSYYNNOOPPSSIISS
       ##iinncclluuddee ""ddrrmmaaaa..hh""

       ccoonnsstt cchhaarr **ddrrmmaaaa__ssttrreerrrroorr((
              iinntt ddrrmmaaaa__eerrrrnnoo
       ));;

       iinntt ddrrmmaaaa__ggeett__ccoonnttaacctt((
              cchhaarr **ccoonnttaacctt,,
              ssiizzee__tt ccoonnttaacctt__lleenn,,
              cchhaarr **eerrrroorr__ddiiaaggnnoossiiss,,
              ssiizzee__tt eerrrroorr__ddiiaagg__lleenn
       ));;

       iinntt ddrrmmaaaa__vveerrssiioonn((
              uunnssiiggnneedd iinntt **mmaajjoorr,,
              uunnssiiggnneedd iinntt **mmiinnoorr,,
              cchhaarr **eerrrroorr__ddiiaaggnnoossiiss,,
              ssiizzee__tt eerrrroorr__ddiiaagg__lleenn
       ));;

       iinntt ddrrmmaaaa__ggeett__DDRRMM__ssyysstteemm((
              cchhaarr **ddrrmm__ssyysstteemm,,
              ssiizzee__tt ddrrmm__ssyysstteemm__lleenn,,
              cchhaarr **eerrrroorr__ddiiaaggnnoossiiss,,
              ssiizzee__tt eerrrroorr__ddiiaagg__lleenn
       ));;

       iinntt ddrrmmaaaa__ggeett__DDRRMMAAAA__iimmpplleemmeennttaattiioonn((
              cchhaarr **ddrrmm__iimmppll,,
              ssiizzee__tt ddrrmm__iimmppll__lleenn,,
              cchhaarr **eerrrroorr__ddiiaaggnnoossiiss,,
              ssiizzee__tt eerrrroorr__ddiiaagg__lleenn
       ));;


DDEESSCCRRIIPPTTIIOONN
       The drmaa_strerror() function returns a message  text  associated  with
       the  DRMAA  error  number,  _d_r_m_a_a___e_r_r_n_o.  For invalid DRMAA error codes
       `NULL' is returned.

   ddrrmmaaaa__ggeett__ccoonnttaacctt(())
       The drmaa_get_contact() returns an  opaque  string  containing  contact
       information  related  to  the current DRMAA session to be used with the
       _d_r_m_a_a___i_n_i_t(3) function. In the 1.0 implementation,  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  imple-
       mentation,  however,  the drmaa_get_contact() function returns an empty
       string, and the _c_o_n_t_a_c_t parameter has no effect  on  the  _d_r_m_a_a___i_n_i_t(3)
       function.

       The  drmaa_get_contact()  function  returns  the  same value before and
       after _d_r_m_a_a___i_n_i_t(3) is called.


   ddrrmmaaaa__vveerrssiioonn(())
       The drmaa_version() function returns into the integers  pointed  to  by
       _m_a_j_o_r  and  _m_i_n_o_r,  the  major  and  minor version numbers of the DRMAA
       library.  For a DRMAA 1.0 compliant implementation `1' and `0' will  be
       returned in _m_a_j_o_r and _m_i_n_o_r, respectively.


   ddrrmmaaaa__ggeett__DDRRMM__ssyysstteemm(())
       The  drmaa_get_DRM_system()  function  returns  into  _d_r_m___s_y_s_t_e_m  up to
       _d_r_m___s_y_s_t_e_m___l_e_n characters of a string containing  Grid  Engine  product
       and version information.

       The  drmaa_get_DRM_system()  function returns the same value before and
       after _d_r_m_a_a___i_n_i_t(3) is called.


   ddrrmmaaaa__ggeett__DDRRMMAAAA__iimmpplleemmeennttaattiioonn(())
       The drmaa_get_DRMAA_implementation() function returns  into  _d_r_m___s_y_s_t_e_m
       up  to _d_r_m___s_y_s_t_e_m___l_e_n 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 _d_r_m_a_a___i_n_i_t(3) is called.


EENNVVIIRROONNMMEENNTTAALL VVAARRIIAABBLLEESS
       GGEE__RROOOOTT        Specifies  the location of the Grid Engine standard con-
                      figuration files.

       GGEE__CCEELLLL        If 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. ddeeffaauulltt.


       GGEE__DDEEBBUUGG__LLEEVVEELL If 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.

       GGEE__QQMMAASSTTEERR__PPOORRTT
                      If set, specifies the tcp port on which _g_e___q_m_a_s_t_e_r(8) is
                      expected to listen  for  communication  requests.   Most
                      installations  will  use a services map entry instead to
                      define that port.

RREETTUURRNN VVAALLUUEESS
       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 _e_r_r_o_r___d_i_a_g___l_e_n characters of error related  diag-
       nosis information is then provided in the buffer _e_r_r_o_r___d_i_a_g_n_o_s_i_s.


EERRRROORRSS
       The  drmaa_get_contact(),  drmaa_version(), drmaa_get_DRM_system(), and
       drmaa_get_DRMAA_implementation() will fail if:

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

   DDRRMMAAAA__EERRRRNNOO__DDRRMM__CCOOMMMMUUNNIICCAATTIIOONN__FFAAIILLUURREE
       Could not contact DRM system for this request.

   DDRRMMAAAA__EERRRRNNOO__AAUUTTHH__FFAAIILLUURREE
       The specified request is not processed successfully due  to  authoriza-
       tion failure.

   DDRRMMAAAA__EERRRRNNOO__IINNVVAALLIIDD__AARRGGUUMMEENNTT
       The input value for an argument is invalid.

   DDRRMMAAAA__EERRRRNNOO__NNOO__MMEEMMOORRYY
       Failed allocating memory.

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

   DDRRMMAAAA__EERRRRNNOO__NNOO__AACCTTIIVVEE__SSEESSSSIIOONN
       Failed because there is no active session.

SSEEEE AALLSSOO
       _d_r_m_a_a___s_e_s_s_i_o_n(3).




GE 6.2                   $Date: 2007/07/19 09:04:31 $            drmaa_misc(3)
