Contents Developing Windows Clients  

ResultPackageHTMLEntry Object

Describes the available result package HTML set entry object actions.

ResultPackageHTMLEntry Full Description

Attributes

ResultPackage Property
Index Property
Description Property
NameValues Property
FrameIncluded Property
FrameEncoding Property
FrameURL Property
ContentsIncluded Property
ContentsEncoding Property
ContentsURL Property
PageIncluded Property
PageEncoding Property
PageURL Property

Methods

GetNameValuePairs Method
OpenFrame Method
OpenContents Method
OpenPage Method
ListBodyItems Method
OpenBodyItem Method
AddCompanions Method
ListCompanions Method
OpenCompanion Method

Description

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

Type: Long

Description

Identifies which result package entry corresponds to this object.

Example

Usage

Readonly Property Description

HTML set entry description.

Type: String

Description

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

Example

Usage

Readonly Property NameValues

HTML set entry name/value pairs.

Type: String

Description

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

Example

Usage

Readonly Property FrameIncluded

True when HTML set contains a frame stream.

Type: Boolean

Description

Use this property to determine if the HTML set entry has a frame stream.

Example

Usage

Readonly Property FrameEncoding

The HTML set frame stream encoding.

Type: String

Description

Use this property to obtain the encoding of the data as it exists in the frame 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.

Readonly Property FrameURL

The HTML set frame stream URL.

Type: String

Description

Use this property to obtain the frame stream URL assigned when the HTML set was created.

Example

Usage

Readonly Property ContentsIncluded

True when HTML set contains a contents stream.

Type: Boolean

Description

Use this property to determine if the HTML set entry has a contents stream.

Example

Usage

Readonly Property ContentsEncoding

The HTML set contents stream encoding.

Type: String

Description

Use this property to obtain the encoding of the data as it exists in the contents 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.

Readonly Property ContentsURL

The HTML set contents stream URL.

Type: String

Description

Use this property to obtain the contents stream URL assigned when the HTML set was created.

Example

Usage

Readonly Property PageIncluded

True when HTML set contains a page stream.

Type: Boolean

Description

Use this property to determine if the HTML set entry has a page stream.

Example

Usage

Readonly Property PageEncoding

The HTML set page stream encoding.

Type: String

Description

Use this property to obtain the encoding of the data as it exists in the page 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.

Readonly Property PageURL

The HTML set page stream URL.

Type: String

Description

Use this property to obtain the page stream URL assigned when the HTML set was created.

Example

Usage

Method GetNameValuePairs

HTML set 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
nvParis  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 OpenFrame

Open the HTML set frame stream.

Description

Call this method to open the stream associated with this HTML set frame stream. Data in the frame stream can be recoded based on the values specified in FrameEncoding and callerEncoding.

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 OpenFrame::mode must be StreamOpenModeForReading.  
callerEncoding  in  String  Encoding of the data desired by the caller in a read, or supplied by the caller in a write.  

Returns BinaryStream

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

Example

See Also

Method OpenContents

Open the HTML set contents stream.

Description

Call this method to open the stream associated with this HTML set contents stream. Data in the contents stream can be recoded based on the values specified in ContentsEncoding and callerEncoding.

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 OpenContents::mode must be StreamOpenModeForReading.  
callerEncoding  in  String  Encoding of the data desired by the caller in a read, or supplied by the caller in a write.  

Returns BinaryStream

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

Example

See Also

Method OpenPage

Open the HTML set page stream.

Description

Call this method to open the stream associated with this HTML set page stream. Data in the page stream can be recoded based on the values specified in PageEncoding and callerEncoding.

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 OpenPage::mode must be StreamOpenModeForReading.  
callerEncoding  in  String  Encoding of the data desired by the caller in a read, or supplied by the caller in a write.  

Returns BinaryStream

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

Example

See Also

Method ListBodyItems

List the body items contained in this HTML entry instance.

Description

Call this method to obtain each HTML body item url and its encoding.

Usage

Parameters

Name Direction Type Description
url  out  String(index)  The URL assigned to the body item when the body was created.  
encoding  out  String(index)  The encoding of the data as it exists in the body stream, before reading or writing.  

Example

See Also

Method OpenBodyItem

Open the body item identified by the index given.

Description

Call this method to open the stream associated with this body stream. Data in the body stream can be recoded based on the values specified in callerEncoding.

Usage

Parameters

Name Direction Type Description
index  in  Long  The index of the body item in which to obtain a stream.  
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 OpenBodyItem::mode must be StreamOpenModeForReading.  
callerEncoding  in  String  Encoding of the data desired by the caller in a read, or supplied by the caller in a write.  

Returns BinaryStream

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

Example

See Also

Method AddCompanions

Adds companion items to the HTML entry.

Description

Call this method to add companion items to this HTML entry. The containing ResultPackage can not be read-only (see BrowseResultPackage or BrowseOnly).

Usage

Parameters

Name Direction Type Description
type  in  FileSpecType(index)  A one dimensional array containing FileSpecType constants identifying the type of companion stream filenames specified.  
name  in  String(index)  A one dimensional array containing the name of the companion streams in which to add to our HTML entry.  
url  in  String(index)  A one dimensional array containing the URL of the companion streams in which to add to our HTML entry.  

Example

See Also

Method ListCompanions

List the companion items contained in this HTML entry instance.

Description

Call this method to obtain each HTML companion item URL and its encoding.

Usage

Parameters

Name Direction Type Description
url  out  String(index)  The URL assigned to the companion item when the companion was placed in this HTML entry.  
encoding  out  String(index)  The encoding of the data as it exists in the companion stream, before reading or writing.  

Example

See Also

Method OpenCompanion

Description

Open the companion item identified by the index given.

Usage

Call this method to open the stream associated with the companion item. Data in the companion stream can be recoded based on the value specified in callerEncoding.

Parameters

Name Direction Type Description
index  in  Long  The index of the companion item in which to obtain a stream.  
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 OpenCompanion::mode must be StreamOpenModeForReading.  
callerEncoding  in  String  Encoding of the data desired by the caller in a read, or supplied by the caller in a write.  

Returns BinaryStream

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

Example

See Also

Contents Developing Windows Clients