SAS Institute. The Power to Know

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

Previous Page | Next Page

Publishing Packages

RETRIEVE_VIEWER



Retrieves a viewer entry from a package
Syntax
Arguments
Details

Syntax

CALL RETRIEVE_VIEWER(entryId, filename, rc<, properties, propValue1, ...propValueN>);

Arguments

entryId

identifies the file entry.

Type: Numeric
Direction: Input
filename

specifies the name of the file or fileref, using the following syntax:

  • FILENAME: external_filename

  • FILEREF: SAS_fileref

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

  • ENCODING

Type: Character
Direction: Input
propValue1, ...propValueN

specifies one value for each specified property name. The order of the property values must match the order of the property names in the properties parameter. Valid property values are defined as follows:

ENCODING

input character string that indicates the target encoding for the retrieved viewer file. An example of a target encoding value is ISO-8859-1. For further information, see Publish and Retrieve Encoding Behavior.

Type: Character
Direction: Input

Details

Specifying "FILENAME:" , without an external filename, applies to the retrieved file the same name that was used when the file was initially inserted into the package.

The following example retrieves a viewer from a package.

fname = "filename: /users/jsmith.bin";
CALL RETRIEVE_VIEWER(entryId, fname, rc);

Previous Page | Next Page | Top of Page