INSERT_VIEWER
Inserts a viewer into a package.
Syntax
CALL INSERT_VIEWER(packageId, filename, mimeType,
desc, nameValue, rc
<, properties,
propValue1, ...propValueN>);
- packageID
- Numeric, input.
Identifies the package.
- filename
- Character, input.
Names the viewer, using the following syntax:
- FILENAME: external_filename
- FILEREF: sas_fileref
- mimeType
- Character, input.
Specifies the MIME type, the value of which is determined by the user.
Subscribers can filter packages based on MIME type.
See INSERT_FILE for suggested values.
- desc
- Character, input.
Describes the viewer.
- nameValue
- Character, input.
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.
- rc
- Numeric, output.
Receives a return code.
- properties
- Character, input.
Identifies a comma-separated list of optional property names. Valid property
names are as follows:
- propValue1, ...propValueN
- Character, input.
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
- Character string indicates the character set of the viewer file, such
as ISO-8859-1. Refer to
Publish/Retrieve Encoding Behavior for details.
- VIEWER_TYPE
- Character string indicates the type of the viewer. Valid values are HTML and TEXT. The default value is HTML.
Example
The following example inserts the external file HVIEWER.HTML into the package
specified by packageId.
filename = 'filename:/tmp/hviewer.html';
desc = 'HTML viewer';
nameValue = '';
mimeType = 'text/html';
CALL INSERT_VIEWER(packageId, filename, mimeType, desc, nameValue, rc);
See Also
