ENTRY_FIRST

Rreturns header information for the first entry in a package.

Syntax

CALL ENTRY_FIRST(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

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 ENTRY_FIRST CALL routine repositions the entry cursor to the start of the list of entries. When the packages are retrieved by way of the RETRIEVE_PACKAGE, CALL routine, 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 the ENTRY_NEXT CALL routine.

The userSpecString parameter is returned to provide further content information about the entry. The value returned is the value that was provided by the publisher at insert time. At this time, 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.

The following example returns header information for the first entry in the package.

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