2.2.1.40 CRowsetProperties

The CRowsetProperties structure contains configuration information for a query.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

_uBooleanOptions

_ulMaxOpenRows

_ulMemoryUsage

_cMaxResults

_cCmdTimeout

_uBooleanOptions (4 bytes): The least significant 3 bits of this field MUST contain one of the following three values.

Value

Meaning

eSequential

0x00000001

The cursor can only be moved forward.

eLocatable

0x00000003

The cursor can be moved to any position.

eScrollable

0x00000007

The cursor can be moved to any position and fetch in any direction.

The remaining bits can be clear or set to any combination of the following values logically ORed together.

Value

Meaning

eAsynchronous

0x00000008

The client will not wait for execution completion.

eFirstRows

0x00000080

Return the first rows encountered, not the best matches.

eHoldRows

0x00000200

The server MUST NOT discard rows until the client is done with a query.

eChaptered

0x00000800

The rowset supports chapters.

eUseCI

0x00001000

Use the inverted index to evaluate content restrictions even if it is out of date. If not set, the GSS can opt to execute the query by going directly against the file system.

eDeferTrimming

0x00002000

Non-indexed trimming operations like scoping or security checking can be expensive. This option gives the GSS the option of deferring these operations until rows are actually requested.

eEnableRowsetEvents

0x00800000

Enables storage of rowset events on the server side. (For information about how to retrieve stored events, see the CPMGetRowsetNotifyIn message.)

eDoNotComputeExpensiveProps

0x00400000

Prevents computation of expensive properties. Windows implementations treat cRowsTotal, _maxRank, and _cResultsFound (as specified in CPMGetQueryStatusExOut (section 2.2.3.9)) as expensive properties. Other implementations could choose different properties and mark them as expensive.

_ulMaxOpenRows (4 bytes): A 32-bit unsigned integer.

Note This field MUST be set to 0x00000000. It is not used and MUST be ignored.

_ulMemoryUsage (4 bytes): A 32-bit unsigned integer.

Note This field MUST be set to 0x00000000. It is not used and MUST be ignored.

_cMaxResults (4 bytes): A 32-bit unsigned integer specifying the maximum number of rows that are to be returned for the query.

_cCmdTimeout (4 bytes): A 32-bit unsigned integer, specifying the number of seconds at which a query is to time out and automatically terminate, counting from the time the query starts executing on the server.

Note A value of 0x00000000 means that the query is not to time out.