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> );

Required Arguments

pkgListId
identifies the list of retrieved packages.
Type:Numeric, Input
packageId
returns the name of the retrieved package.
Type:Numeric, Output
numEntries
returns the total number of entries in the package.
Type:Numeric, Output
desc
describes the package.
Type:Character, Output
dateTime
returns the date and time value that the package was published, in GMT format.
Type:Numeric, Output
nameValue
returns the name/value pairs assigned to the package. Name/value pairs are site-specific; they are used for the purpose of filtering.
Type:Character, Output
channel
returns the name of the channel to which the package was published.
Type:Character, Output
rc
receives a return code.
Type:Numeric, Output

Optional Arguments

properties
identifies a comma-separated list of optional property names to be returned from the package. Valid property names are as follows:
  • ABSTRACT
  • EXPIRATION_DATETIME
Type:Character, Input
propValue1, …propValueN
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, if specified, is returned as the package expiration date/time stamp to the EXPIRATION_DATETIME variable. The date/time stamp is in GMT format.
Type:Character or Numeric, Output

Examples

Example 1: Using PACKAGE_NEXT

The following example returns the header information for the next package that is 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);

Example 2: Using PACKAGE_NEXT with the ABSTRACT Property

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);