ENTRY_NEXT

Returns header information from the next entry in a package.

Syntax

CALL ENTRY_NEXT(packageId, entryId, entryType, userSpecString, desc, nameValue, rc);

packageId

Numeric, input.
Identifies the package.

entryId

Numeric, output.
Returns the identifier of the entry.

entryType

Character, output.
Returns the type of the entry. Available types include the following:

• BINARY
• CATALOG
• DATASET
• FDB
• HTML
• MDDB
• NESTED_PACKAGE
• REFERENCE
• SQLVIEW
• TEXT
• VIEWER

userSpecString

Character, output.
Returns a string from the specified entry. See Details for string content.

desc

Character, output.
Returns the entry description from the specified entry.

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 header information returned by this CALL routine identifies the type of the entry and provides descriptive information.

The userSpecString parameter provides content information about the entry. The value returned is the value that was provided by the publisher when the entry was inserted in the package. For this release, only file entries can return a value for this parameter. All other entry types return a blank value. For file entries, this field is the user-specified MIME type.

When a package is retrieved, the entry cursor is positioned at the start of the entry list by default. As a consequence, the ENTRY_FIRST CALL routine does not have to be called before ENTRY_NEXT CALL routine. The ENTRY_FIRST CALL routine can be used at a later time in order to move the entry cursor back to the start of the entry list.

The following example positions the cursor at the start of an entry list.

CALL ENTRY_NEXT(packageId, entryid, type, uSpec, desc, nv,  rc);