SAS Institute. The Power to Know

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

Previous Page | Next Page

Publishing Packages

INSERT_VIEWER



Inserts a viewer into a package
Syntax
Arguments
Example

Syntax

CALL INSERT_VIEWER(packageId, filename, mimeType, desc, nameValue, rc<, properties, propValue1, ...propValueN>);

Arguments

packageID

identifies the package.

Type: Numeric
Direction: Input
filename

names the viewer, using the following syntax:

  • FILENAME: external_filename

  • FILEREF: sas_fileref

Type: Character
Direction: Input
mimeType

specifies the MIME type, the value of which is determined by the user. Subscribers can filter packages based on MIME type. See Filtering Packages and Package Entries. For suggested values, see filter.

Type: Character
Direction: Input
desc

describes the viewer.

Type: Character
Direction: Input
nameValue

identifies a list of one or more space-separated name/value pairs, each in one of the following forms:

  • name

  • name=value

  • name="value"

  • name="single value with spaces"

  • name=(value)

  • name=("value")

  • name=(value1, "value 2",... valueN)

Name/value pairs are site-specific; they are used for the purpose of filtering. See filtering.

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

  • VIEWER_TYPE

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

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

ENCODING

indicates the character set of the viewer file, such as ISO-8859-1. For details, see Publish and Retrieve Encoding Behavior.

VIEWER_TYPE

indicates the type of the viewer. Valid values are HTML and TEXT. The default value is HTML.

Type: Character
Direction: Input

Example

The following example inserts the external file HVIEWER.HTML into the package that is specified by packageId .

filename = 'filename:/tmp/hviewer.html';
desc = 'HTML viewer';
nameValue = '';
mimeType = 'text/html';
CALL INSERT_VIEWER(packageId, filename,
   mimeType, desc, nameValue, rc);

Previous Page | Next Page | Top of Page