RETRIEVE_NESTED

Arguments

entryId

identifies the nested package entry.

Type:	Numeric
Direction:	Input

packageId

returns the identifier of the nested package.

Type:	Numeric
Direction:	Output

numEntries

returns the number of entries in the nested package.

Type:	Numeric
Direction:	Output

desc

returns the description of the nested package entry.

Type:	Character
Direction:	Output

dateTime

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

Type:	Numeric
Direction:	Output

nameValue

returns the name/value pairs assigned to the specified entry. Name/value pairs are site-specific; they are used for the purpose of filtering. See filtering.

Type:	Character
Direction:	Output

rc

receives a return code.

Type:	Numeric
Direction:	Output

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 that is associated with entryId .

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

Copyright © 2008 by SAS Institute Inc., Cary, NC, USA. All rights reserved.