SAS Institute. The Power to Know

SAS(R) 9.2 Publishing Framework: Developer's Guide

Previous Page | Next Page

Publishing Packages

ENTRY_NEXT



Returns header information from the next entry in a package
Syntax
Arguments
Details

Syntax

CALL ENTRY_NEXT(packageId, entryId, entryType, userSpecString, desc, nameValue, rc<, properties, propValue1, ...propValueN>);

Arguments

packageId

identifies the package.

Type: Numeric
Direction: Input
entryId

returns the identifier of the entry.

Type: Numeric
Direction: Output
entryType

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

  • BINARY

  • CATALOG

  • DATASET

  • FDB

  • HTML

  • MDDB

  • NESTED_PACKAGE

  • REFERENCE

  • SQLVIEW

  • TEXT

  • VIEWER

Type: Character
Direction: Output
userSpecString

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

Type: Character
Direction: Output
desc

returns the entry description from the specified entry.

Type: Character
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
properties

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

  • FILENAME

Type: Character
Direction: 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
Direction: Output

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);

Previous Page | Next Page | Top of Page