Contents Publish Package Interface Previous Next

PACKAGE_NEXT

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

Syntax

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

pkgListId
Numeric, input.
Identifies the list of retrieved packages.

packageId
Numeric, output.
Returns the name of the retrieved package.

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

desc
Character, output.
Describes the package.

dateTime
Numeric, output.
Returns the date and time value 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 the 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 returns the header information for the next package associated with the list of packages named PLIST.

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

The following example uses the ABSTRACT property so that the abstract value is returned in the abs variable.

packageId = 0;
desc='';
num=0;
exp=0;
dt=0;
nv='';
ch='';
abs='';
props="ABSTRACT";
rc=0; 
CALL PACKAGE_NEXT(plist, packageId, num, desc, dt, nv, ch, rc, props, abs);

Contents Publish Package Interface Previous Next