PACKAGE_FIRST

Returns the header information for the first package in the package list.

Syntax

CALL PACKAGE_FIRST(pkgListId, packageId, numEntries, desc, dateTime, nameValue, channelt, rc<, properties, propValue1, ...propValueN>);

pkgListId

Numeric, output.
Identifies the list of retrieved packages.

packageId

Numeric, output.
Identifies the retrieved package.

numEntries

Numeric, output.
Returns the number of entries in the package.

desc

Character, output.
Returns a description of the package.

dateTime

Numeric, output.
Returns the date and time that the package was published, in GMT format.

nameValue

Character, output.
Returns the name/value pairs assigned to the package. Name/value pairs are site-specific; they are used for the purpose of filtering.

channel

Character, output.
Returns the name of a channel to which the package was published.

rc

Numeric, output.
Receives a return code.

properties

Character, input.
Identifies a comma-separated list of optional property names to be returned from the package. Valid property names are as follows:

• ABSTRACT
• EXPIRATION_DATETIME

propValue1, ...propValueN

Character/numeric, output.
Returns one value for each specified property. The order of the values matches the order of the property names in the properties parameter. Valid property values are defined as follows:

ABSTRACT

Character string variable.
If specified, is returned to the ABSTRACT variable.

EXPIRATION_DATETIME

Numeric variable.
The package expiration date/time stamp is returned to the EXPIRATION_DATETIME variable.

Examples

The following example opens the JSMITH queue and retrieves the descriptive header information for all packages, then returns the header information for the first package.

plist=0;
qname = "MQSERIES://LOCAL:JSMITH";
rc=0;
total=0;
nameValue='';
CALL RETRIEVE_PACKAGE(plist, "FROM_QUEUE", qname, total, rc);

packageId = 0;
desc='';
num=0;
dt=0;
nv='';
ch='';
rc=0; 
CALL PACKAGE_FIRST(plist, packageId, num, desc, dt, nv, ch, rc);

The following example demonstrates the use of properties.

plist=0;
qname = "MQSERIES://LOCAL:JSMITH";
rc=0;
total=0;
nameValue='';
CALL RETRIEVE_PACKAGE(list, "FROM_QUEUE", qname, total, rc);

packageId = 0;
desc='';
num=0;
exp=0;
abstract='';
dt=0;
nv='';
ch='';
rc=0; 
props='ABSTRACT, EXPIRATION_DATETIME';
CALL PACKAGE_FIRST(plist, packageId, num, desc, dt, nv, ch, rc, props, 
                   abstract, exp);