1. drmaa2_jarray_get_session_name(3)
  2. DRMAA2
  3. drmaa2_jarray_get_session_name(3)

NAME

drmaa2_jarray_get_session_name - drmaa2_jarray_get_session_name(3), Returns the name of the job session.

SYNOPSIS

#include "drmaa2.h"

drmaa2_string drmaa2_jarray_get_session_name(const drmaa2_jarray ja)

DESCRIPTION

Returns a newly allocated drmaa2_string copy of the name of the job session the array job belongs to.

RETURN VALUES

Returns a newly allocated drmaa2_string (char *) with the name or NULL in case of an error. The drmaa2_string must be freed from the calling function.

EXAMPLE

/* ... array job id stems from a previous drmaa2_jarray_get_id() call ... */
drmaa2_jarray ja = drmaa2_jsession_get_job_array(js, id);

if (ja != NULL) {
  drmaa2_string name = drmaa2_jarray_get_jsession_name(ja);

  if (name != NULL) {
     /* ... do something with the session name... */

     /* finally free the job template */
     drmaa2_string_free(&name);         
  }

  drmaa2_jarray_free(&ja);
}

SEE ALSO

drmaa2_jarray_free(3), drmaa2_jarray_get_job_template(3), drmaa2_jarray_get_jobs(3), drmaa2_jarray_get_id(3), drmaa2_jsession_get_session_names(3), drmaa2_jsession_get_session_name(3), drmaa2_jsession_get_contact(3), drmaa2_jsession_get_job_array(3), drmaa2_jsession_run_job(3), drmaa2_jsession_run_bulk_jobs(3), drmaa2_jsession_wait_any_started(3), drmaa2_jsession_wait_any_terminated(3), drmaa2_open_jsession(3)

AUTHOR

Copyright Univa Corporation 2013

  1. Univa Corporation
  2. October 2013
  3. drmaa2_jarray_get_session_name(3)