Knowledge Center         Contents    Previous  Next    
Platform Computing Corp.

lsb_readframejob()

Returns all frame jobs information which matchs the specified parameters and fills related information into the frame job information table.

DESCRIPTION

lsb_readframejob() gets all frame jobs information that matches the specified parameters and fills related information into the frame job information table. lsb_readframejob is a wrapper of lsb_openjobinfo(), lsb_readjobinfo(), and lsb_closejobinfo(). Memory allocated in frameJobInfoTbl will be freed by user.

The fields in the frameJobInfo structure have the following meaning:

jobGid

The job ID that the LSF system assigned to the frame job array.

maxJob

The max job number in one frame job array.

userName

The user submitted the frame job array.

jobName

The full job name of the frame job array. frameElementPtr The pointer to frame job array table.

The fields in the frameElementInfo structure have the following meaning:

jobindex

The job index in the frame job array.

jobState

The job status.

start

The start frame of this frame job.

end

The end frame of this frame job.

step

The step of this frame job.

chunk

The chunk size of this frame job.

SYNOPSIS

#include <lsf/lsbatch.h>
int lsb_readframejob(LS_LONG_INT jobId, char *frameName, 
    char *user, char *queue, char *host, int options, 
    struct frameJobInfo **frameJobInfoTbl)

struct frameJobInfo {
/* jobid of the job array */
    int jobGid;
/* job number in a job array */
    int maxJob;
/* user name */
    char userName[MAX_LSB_NAME_LEN];
/* full job name */
    char jobName[MAXLINELEN];
/* pointer to job array table */
    struct frameElementInfo *frameElementPtr;
};

struct frameElementInfo {
/* job index in a job array */
    int jobindex;
/* job status */
    int jobState;
/* start frame */
    int start;
/* end frame */
    int end;
/* step size */
    int step;
/* chunk size */
    int chunk;
}; 

PARAMETERS

jobId

Get information about the frame jobs with the given job ID. If jobID is 0, get information about frame jobs which satisfy the other specifications. If a job in a job array is to be modified, use the array form jobID[i] where jobID is the job array name, and i is the index value.

*frameName

Get information about frame jobs with the given frame name.

*user

Get information about frame jobs submitted by the named user or user group, or by all users if user is all. If user is NULL, the user invoking this routine is assumed.

*queue

Get information about frame jobs belonging to the named queue. If queue is NULL, jobs in all queues of the batch system will be considered.

*host

Get information about frame jobs on the named host, host group or cluster name. If host is NULL, jobs on all hosts of the batch system will be considered.

options

<lsf/lsbatch.h> defines the following flags constructed from bits. Use the bitwise OR to set more than one flag.

**frameJobInfoTbl

The result of all frame jobs information.

RETURN VALUES

integer:Length of frame job information table

Function was successful.

integer:-1

Function failed.

ERRORS

If the function fails, lsberrno is set to indicate the error.

SEE ALSO

Related API

lsb_openjobinfo()

lsb_readjobinfo()

lsb_closejobinfo()

Equivalent line command

none

Files

none


Platform Computing Inc.
www.platform.com
Knowledge Center         Contents    Previous  Next