LibreOffice
LibreOffice 24.2 SDK API Reference
Public Attributes | List of all members
FetchResult Struct Referencepublished

contains data of several rows of a ContentResultSet. More...

import"FetchResult.idl";

Public Attributes

sequence< any > Rows
 contains the demanded data. More...
 
long StartIndex
 indicates the index of the first row contained in FetchResult::Rows in the original result set. More...
 
boolean Orientation
 indicates the orientation in which the rows are fetched and set into the sequence FetchResult::Rows. More...
 
short FetchError
 indicates whether and which error has occurred, while fetching. More...
 

Detailed Description

contains data of several rows of a ContentResultSet.

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

Member Data Documentation

◆ FetchError

short FetchError

indicates whether and which error has occurred, while fetching.

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

◆ Orientation

boolean Orientation

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 result set.

◆ Rows

sequence< any > Rows

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

long StartIndex

indicates the index of the first row contained in FetchResult::Rows in the original result set.

So if FetchResult::StartIndex equals 3, the first element in the sequence FetchResult::Rows contains the data of the index 3 in the original result set.

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


The documentation for this struct was generated from the following file: