ENTRY_FIRST

Returns header information for the first entry in a package

Syntax

Details

Example

Syntax

CALL ENTRY_FIRST(packageId, entryId, entryType, userSpecString, desc, nameValue,

rc<, properties, propValue1, ...propValueN> );

Required Arguments

packageId: identifies the package.

Type:Numeric, Input

entryId: returns the identifier of the entry.

Type:Numeric, Output

entryType

returns the type of the entry. Available types include the following:

BINARY
CATALOG
DATASET
HTML
MDDB
NESTED_PACKAGE
REFERENCE
SQLVIEW
TEXT
VIEWER

Type:Character, Output

userSpecString: returns a string from the specified entry. For string content, see the Details section.

Type:Character, Output

desc: returns the entry description from the specified entry.

Type:Character, 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.

Type:Character, Output

rc: receives a return code.

Type:Numeric, Output

Optional Arguments

properties

identifies a comma-separated list of optional property names. Valid property names are as follows:

FILENAME

Type:Character, Input

propValue1, …propValueN

returns one value for each specified property name. Valid property names are supported as follows:

FILENAME

output character string variable that returns the name of the file (as it exists in the package).

Type:Character, Output

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.

Example: Using ENTRY_FIRST

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

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