SECTION 2 String List Helper Functions

Functions
int	drmaa_get_next_attr_name (drmaa_attr_names_t *values, char *value, size_t value_len)
int	drmaa_get_next_attr_value (drmaa_attr_values_t *values, char *value, size_t value_len)
int	drmaa_get_next_job_id (drmaa_job_ids_t *values, char *value, size_t value_len)
int	drmaa_get_num_attr_names (drmaa_attr_names_t *values, size_t *size)
int	drmaa_get_num_attr_values (drmaa_attr_values_t *values, size_t *size)
int	drmaa_get_num_job_ids (drmaa_job_ids_t *values, size_t *size)
void	drmaa_release_attr_names (drmaa_attr_names_t *values)
void	drmaa_release_attr_values (drmaa_attr_values_t *values)
void	drmaa_release_job_ids (drmaa_job_ids_t *values)

---

Function Documentation

int drmaa_get_next_attr_name	(	drmaa_attr_names_t *	values,
		char *	value,
		size_t	value_len
	)

This function gets the next name of a drmaa_attr_names_t list. Each call to this function returns a different value of the list. DRMAA_ATTR_BUFFER can be used to instantiate value_len, and to define the value buffer in the form char value[DRMAA_ATTR_BUFFER].

Parameters:

	values	The names list.
	value	The value buffer
	value_len	The length of value buffer, if the value is greater than value_len, the value string will be truncated.

Returns:

• DRMAA_ERRNO_SUCCESS on success
• DRMAA_ERRNO_INVALID_ARGUMENT if values is NULL
• DRMAA_ERRNO_NO_ACTIVE_SESSION no active session
• DRMAA_ERRNO_NO_MORE_ELEMENTS no more attribute names are available A Subsequent call to drmaa_get_next_attr_value() will return the first name again.

int drmaa_get_next_attr_value	(	drmaa_attr_values_t *	values,
		char *	value,
		size_t	value_len
	)

This function gets the next value of a drmaa_attr_values_t list. Each call to this function returns a different value of the list. DRMAA_ATTR_BUFFER can be used to instantiate value_len, and to define the value buffer in the form char value[DRMAA_ATTR_BUFFER].

Parameters:

	values	The value list.
	value	The value buffer
	value_len	The length of value buffer, if the value is greater than value_len, the value string will be truncated.

Returns:

• DRMAA_ERRNO_SUCCESS on success
• DRMAA_ERRNO_INVALID_ARGUMENT if values is NULL
• DRMAA_ERRNO_NO_ACTIVE_SESSION no active session
• DRMAA_ERRNO_NO_MORE_ELEMENTS no more attribute names are available A Subsequent call to drmaa_get_next_attr_value() will return the first value again.

int drmaa_get_next_job_id	(	drmaa_job_ids_t *	values,
		char *	value,
		size_t	value_len
	)

This function gets the next jobid of a drmaa_job_ids_t list. Each call to this function returns a different jobid of the list. DRMAA_GW_JOBID_BUFFER can be used to instantiate value_len, and to define the value buffer in the form char value[DRMAA_GW_JOBID_BUFFER].

Parameters:

	values	The jobid list.
	value	The value buffer, it should be of length.
	value_len	The length of value buffer, if the value is greater than value_len, the value string will be truncated.

Returns:

• DRMAA_ERRNO_SUCCESS on success
• DRMAA_ERRNO_INVALID_ARGUMENT if values is NULL
• DRMAA_ERRNO_NO_ACTIVE_SESSION no active session
• DRMAA_ERRNO_NO_MORE_ELEMENTS no more attribute names are available A Subsequent call to drmaa_get_next_job_id() will return the first jobid again.

int drmaa_get_num_attr_names	(	drmaa_attr_names_t *	values,
		size_t *	size
	)

This function stores the number of names in drmaa_attr_names_t list in size.

Parameters:

	values	The names list.
	size	The number of elements in the attribute list

Returns:

• DRMAA_ERRNO_SUCCESS on success
• DRMAA_ERRNO_INVALID_ARGUMENT if values is NULL
• DRMAA_ERRNO_NO_ACTIVE_SESSION no active session

int drmaa_get_num_attr_values	(	drmaa_attr_values_t *	values,
		size_t *	size
	)

This function stores the number of values in drmaa_attr_values_t list in size.

Parameters:

	values	The attributes list.
	size	The number of elements in the values list

Returns:

• DRMAA_ERRNO_SUCCESS on success
• DRMAA_ERRNO_INVALID_ARGUMENT if values is NULL
• DRMAA_ERRNO_NO_ACTIVE_SESSION no active session

int drmaa_get_num_job_ids	(	drmaa_job_ids_t *	values,
		size_t *	size
	)

This function stores the number of ids in a drmaa_job_ids_t list in size.

Parameters:

	values	The job ids list.
	size	The number of job ids in the list

Returns:

• DRMAA_ERRNO_SUCCESS on success
• DRMAA_ERRNO_INVALID_ARGUMENT if values is NULL
• DRMAA_ERRNO_NO_ACTIVE_SESSION no active session

void drmaa_release_attr_names

(

drmaa_attr_names_t *

values

)

This function de-allocates memory of drmaa_attr_names_t list. The drmaa_attr_names_t list MUST be previously allocated by a drmaa_wait() function call.

Parameters:

values

The drmaa_attr_names_t list.

void drmaa_release_attr_values

(

drmaa_attr_values_t *

values

)

This function de-allocates memory of drmaa_attr_values_t list. The drmaa_attr_values_t list MUST be previously allocated by a drmaa_get_attribute_names() or drmaa_get_vector_attribute_names()

Parameters:

values

The drmaa_attr_values_t list.

void drmaa_release_job_ids

(

drmaa_job_ids_t *

values

)

This function de-allocates memory of drmaa_job_ids_t list. The drmaa_job_ids_t list MUST be previously allocated by a drmaa_run_bulk_jobs() function call.

Parameters:

values

The drmaa_job_ids_t list.