RETRIEVE_NESTED

Retrieves the descriptive header information for a nested package entry.

Syntax

CALL RETRIEVE_NESTED(entryId, packageId, numEntries, desc, dateTime, nameValue, rc);

entryId

Numeric, input.
Identifies the nested package entry.

packageId

Numeric, output.
Returns the identifier of the nested package.

numEntries

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

desc

Character, output.
Returns the description of the nested package entry.

dateTime

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

nameValue

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

rc

Numeric, output.
Receives a return code.

Details

The descriptive header information that is returned on this CALL routine includes the nested package description, name/value string, datetime stamp, and total number of entries that are contained in the nested package.

The returned packageId can then be used on subsequent ENTRY_FIRST and ENTRY_NEXT calls to retrieve the entry information.

Package identifiers that are returned on the RETRIEVE_NESTED CALL routine cannot be used on the PACKAGE_DESTROY CALL routine. The RETRIEVE_NESTED CALL routine supports only top-level packages, excluding nested packages. When PACKAGE_DESTROY is called on a top-level package, all entries, including all nested packages and their entries, are removed from the queue.

The following example retrieves the descriptive header information for the nested package entry associated with entryId.

   packageId=0;
   num=0;
   desc='';
   dt=0;
   nv='';
   rc=0;
   CALL RETRIEVE_NESTED(entryId, packageId, 
      num, desc, dt, nv, rc);