Contents Developing Windows Clients  

ResultPackageViewerEntry Object

Describes the available result package viewer entry object actions.

ResultPackageViewerEntry Full Description

Attributes

ResultPackage Property
Index Property
Description Property
NameValues Property
MIMEType Property
Encoding Property

Methods

GetNameValuePairs Method
GetViewerDependencies Method
OpenViewer Method
OpenAppliedViewer Method

Description

This object facilitates result package viewer entry manipulation. You may obtain attributes associated with the viewer entry, retrieve the viewer associated with the viewer entry, retrieve the applied viewer, or create the file associated with the viewer entry.

Readonly Property ResultPackage

The parent of this object.

Type: ResultPackage

Description

Use this property to navigate back to the ResultPackage object which is the parent of this object.

Example

Usage

Readonly Property Index

Index of viewer entry within containing result package.

Type: Long

Description

Identifies which result package entry corresponds to this object.

Example

Usage

Readonly Property Description

Viewer entry description.

Type: String

Description

Use this property to obtain the description associated with this viewer entry. The description is assigned when the viewer entry is created.

Example

Usage

Readonly Property NameValues

Viewer entry name/value pairs.

Type: String

Description

Use this property to obtain the name/value pairs associated with this viewer entry. The name/value pairs are assigned when the viewer entry is created.

Example

Usage

Readonly Property MIMEType

Viewer entry MIME type.

Type: String

Description

Use this property to obtain the MIME type associated with this viewer entry. The MIME type is assigned when the viewer entry is created.

Example

Usage

Readonly Property Encoding

The viewer entry encoding.

Type: String

Description

Use this property to obtain the encoding of the data as it exists in the viewer stream, before reading or writing.

Example

Usage

Recoding should only be used for text data that is being transferred with the binary stream. It is specifically provided to transfer HTML where a "meta charset" tag is used.

Method GetNameValuePairs

Viewer entry parsed name/value pairs.

Description

Call this method to return a two dimensional string array containing the parsed name/value pairs.

Usage

Parameters

Name Direction Type Description
nvPairs  out  String(row,col)  A two dimensional string array containing the parsed name/value pairs. The two dimensional string array is populated in the following manner: 
   For the NameValues: "name1 name2=a name3=(b,c)"
   GetNameValuePairs would return:
                 Column 0   Column 1
        Row 0    "name1"
        Row 1    "name2"    "a"
        Row 2    "name3"    "b"
        Row 3               "c"
 

Example

See Also

Method GetViewerDependencies

Viewer entry package entry dependencies.

Description

Call this method to obtain a single dimensional string array containing the names of the resolved viewer dependencies. The names are used as result package entry identifiers by the GetDependency method.

Usage

Parameters

Name Direction Type Description
entryType  out  PackageType(index)  A single dimensional array containing the PackageType constant identifying the entry type.  
viewerDependency  out  String(index)  A single dimensional string array containing the resolved viewer dependency names. To access a dependency, pass the viewer dependency name as the GetDependency::viewerDependency parameter.  

Example

See Also

GetDependency

Method OpenViewer

Open the viewer source.

Description

Call this method to open the viewer source file associated with this viewer entry.

Usage

Parameters

Name Direction Type Description
maxLineLength  in  Long  The maximum length of any line that will be in the file. This is only applicable to text files. Binary files ignore this parameter. This is typically set to some larger value than is actually used. If a huge number is specified, some hosts will adjust this down to a more reasonable value. This value can be obtained from TruncationLength. Lines longer than this specified maxLineLength will be truncated.  
callerEncoding  in  String  Encoding of the data desired by the caller in a read.  

Returns Object

Returns the newly created BinaryStream object. Note that there can more than one Stream object reading from the same ResultPackageViewerEntry object.

Example

See Also

Method OpenAppliedViewer

Open the file containing the viewer applied to a package.

Description

Call this method to open the applied viewer result file associated with this viewer entry.

Usage

Parameters

Name Direction Type Description
maxLineLength  in  Long  The maximum length of any line that will be in the file. This is only applicable to text files. Binary files ignore this parameter. This is typically set to some larger value than is actually used. If a huge number is specified, some hosts will adjust this down to a more reasonable value. This value can be obtained from TruncationLength. Lines longer than this specified maxLineLength will be truncated.  
callerEncoding  in  String  Encoding of the data desired by the caller in a read.  

Returns Object

Returns the newly created BinaryStream object. Note that there can more than one Stream object reading from the same ResultPackageViewerEntry object.

Example

See Also

Contents Developing Windows Clients