struct FetchResult in module com::sun::star::ucb::

(Global Index)

Syntax

struct FetchResult;

Description

contains data of several rows of a ContentResultSet .

This struct is returned from XFetchProvider::fetch , for example.

Field Summary

Rows contains the demanded data.

StartIndex indicates the index of the first row contained in FetchResult::Rows in the original resultset. So if FetchResult::StartIndex equals 3 , the first element in the sequence FetchResult::Rows contains the data of the index 3 in the original resultset.

Orientation indicates the orientation in which the rows are fetched and set into the sequence FetchResult::Rows .

FetchError indicates whether and which error has occured, while fetching.

Field Details



Rows

Syntax

sequence< any > Rows;

Description

contains the demanded data.

One any contains the data of one whole row. Those methods which use this struct have to specify, what the any has to contain.


StartIndex

Syntax

long StartIndex;

Description

indicates the index of the first row contained in FetchResult::Rows in the original resultset. So if FetchResult::StartIndex equals 3 , the first element in the sequence FetchResult::Rows contains the data of the index 3 in the original resultset.

The following rows are one after the other, but the direction depends on the value of FetchResult::Direction


Orientation

Syntax

boolean Orientation;

Description

indicates the orientation in which the rows are fetched and set into the sequence FetchResult::Rows .

When FetchResult::Orientation equals true , the rows in FetchResult::Rows are ordered in the same way as in the original resultset.


FetchError

Syntax

short FetchError;

Description

indicates whether and which error has occured, while fetching.

The value may contain zero or more constants of the FetchError constants group.

Top of Page