Contents Developing Windows Clients  

ResultPackageFileEntry Object

Describes the available result package file entry object actions.

ResultPackageFileEntry Full Description

Attributes

ResultPackage Property
Index Property
Description Property
NameValues Property
MIMEType Property
OriginalFileName Property

Methods

GetNameValuePairs Method
Open Method

Description

This object facilitates result package file entry manipulation. You may obtain attributes associated with the file entry, retrieve the file associated with the file entry, or create the file associated with the file 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 file entry within containing result package.

Type: Long

Description

Identifies which result package entry corresponds to this object.

Example

Usage

Readonly Property Description

File entry description.

Type: String

Description

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

Example

Usage

Readonly Property NameValues

File entry name/value pairs.

Type: String

Description

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

Example

Usage

Readonly Property MIMEType

File entry MIME type.

Type: String

Description

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

Example

Usage

Readonly Property OriginalFileName

Original file name.

Type: String

Description

Use this property to obtain the original file name associated with this file entry.

Example

Usage

Method GetNameValuePairs

File 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

NameValues

Method Open

Open the file associated with this file entry.

Description

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

Usage

Parameters

Name Direction Type Description
mode  in  StreamOpenMode  Specifies whether the stream will allow reading, writing, or update. If the containing ResultPackage is read-only (see BrowseResultPackage or BrowseOnly), the Open::mode must be StreamOpenModeForReading.  
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.  

Returns Object

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

Example

See Also

Contents Developing Windows Clients