VUTIL   (RPGLE)

Vector Utilities
More ....

Procedures  [top]

vutil_listActiveSubsystemJobs exported
List Active Jobs in Subsystem
vutil_listFileMembers exported
List file member names
vutil_listJobLibraryList exported
List Job Library List
vutil_listJobs exported
List jobs
vutil_listObjects exported
List objects
vutil_listRecordFormats exported
List record format names

Copybooks  [top]

VECTOR_H
VUTIL_H
QUSLMBR_H
QUSLRCD_H
QUSLOBJ_H
QUSRJOBI_H
QUSLJOB_H
USRSPC_H
API_ERR_H
PARMEVAL_H
LIBC_H
QSYSINC/QRPGLESRC,QUSEC

Detailed Description  [top]

This module contains several procedures which uses the vector procedures for storing simple data.

An entry of the vector either contains only one data which can be processed as is or multiple data which can be processed using the datastructure templates in the copybook VUTIL_H.
Author:
Mihael Schmidt
Date:
24.07.2008

Procedure Documentation  [top]

vutil_listActiveSubsystemJobs  [top]

Pointer vutil_listActiveSubsystemJobs ( Character, Character )
All active jobs of the specified subsystem will be added to the vector. The entries of the vector are qualified job names which consist of the following parts:
  • CHAR (10) - Job Name
  • CHAR (10) - User Name
  • CHAR (6) - Job Number
The datastructure template vutil_tmpl_job can be used for the entries.
Subsystem monitor jobs are exluded.
Parameters:
Character (10) — Subsystemdescription library
Character (10) — Subsystemdescription name
Return value:
Pointer — Pointer to the vector or *null if any error occured
Exported.
Author:
Mihael Schmidt
Date:
29.04.2008
Info:
The user calling this procedure must have *JOBCTL authorities else this procedure returns *null.

vutil_listFileMembers  [top]

Pointer vutil_listFileMembers ( Character, Character )
All member names of a file are placed into a vector. This vector is returned to the caller. On any error *null is returned.
Parameters:
Character (10) — Library name
Character (10) — File name
Return value:
Pointer — Pointer to the vector or *null if any error occurs
Exported.
Author:
Mihael Schmidt
Date:
27.07.2008

vutil_listJobLibraryList  [top]

Pointer vutil_listJobLibraryList ( Character, Character, Integer )
All libraries of the library list of the specified job will be added in the order of the library list returned in a vector.

The qualified job name consists of the following parts:
  • CHAR (10) - Job Name
  • CHAR (10) - User Name
  • CHAR (6) - Job Number

If both parameters are passed then the library list of the job with the qualified job name will be retrieved.
Parameters:
Character (26) — Qualified Job Name (optinal, default = current job)
Character (16) — Internal Job Number (optinal)
Numeric (Integer) (10) — Library parts (see VUTIL_H Constants)
Return value:
Pointer — Pointer to the vector or *null if any error occured
Exported.
Author:
Mihael Schmidt
Date:
10.04.2008

vutil_listJobs  [top]

Pointer vutil_listJobs ( Character, Character, Character )
Returns a list of qualified job names which matches the passed parameters.

The qualified job name consists of the following parts:
  • CHAR (10) - Job Name
  • CHAR (10) - User Name
  • CHAR (6) - Job Number


Valid values for the job status are : *ACTIVE, *JOBQ, *OUTQ, *ALL.
Parameters:
Character (26) — Qualified job name
Character (10) — Job status (default: *ALL)
Character (4) — Active job status (optional)
Return value:
Pointer — Vector with qualified job entries or *null on error
Exported.
Author:
Mihael Schmidt
Date:
16.04.2009
Info:
For valid values for the parameters look at the i5/OS API QUSLJOB and QUSRJOBI.

vutil_listObjects  [top]

Pointer vutil_listObjects ( Character, Character, Character )
All object names are placed into a vector. This vector is returned to the caller. On any error *null is returned.

The entries in the vector have the following format:
  • 10A Library name
  • 10A Object name
  • 10A Object type


As this procedure utilizes the QUSLOBJ i5/OS API the parameters here accept the same names and generic names for library, name and object type.
Parameters:
Character (10) — Library
Character (10) — Object name (default: *all)
Character (10) — Object type (default: *all)
Exported.

vutil_listRecordFormats  [top]

Pointer vutil_listRecordFormats ( Character, Character )
All record format names of a file are placed into a vector. This vector is returned to the caller. On any error *null is returned.
Parameters:
Character (10) — Library name
Character (10) — File name
Return value:
Pointer — Pointer to the vector or *null if any error occured
Exported.
Author:
Mihael Schmidt
Date:
27.07.2008
Generated on Tue May 26 07:57:35 CEST 2009