RETRIEVE_VIEWER

Retrieves a viewer entry from a package

Syntax

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

Required Arguments

entryId
identifies the file entry.
Type:Numeric, Input
filename
specifies the name of the file or fileref, using the following syntax:
  • FILENAME: external_filename
  • FILEREF: SAS_fileref
Type:Character, Input
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:
  • ENCODING
Type:Character, 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.
Type:Character, 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.

Example: Using RETRIEVE_VIEWER

The following example retrieves a viewer from a package.
fname = "filename: /users/jsmith.bin";
CALL RETRIEVE_VIEWER(entryId, fname, rc);