Setmetarow – Kofax DM API User Manual

Page 290

Advertising
background image

270 C

HAPTER

4

SetMetaRow

SetMetaRow

Use this method to set the pointer to the current metadata row in the
results set to a specific row number.

Syntax

PCDLookup.SetMetaRow( lngRowNbr )

PCDRecentDOc.SetMetaRow( lngRowNbr )

PCDSearch.SetMetaRow( lngRowNbr )

Parameter

Returns

Returns a Boolean value. TRUE indicates the current row number has
been set to the specified row number. FALSE indicates there was an
error.

Usage

The row count in the result set is 1-based. Thus, if you call
SetMetaRow( 0 )

, and then call

GetMetaPropertyValue

, you will

generate an error. Also, if you set it to a row number that is higher than
the number of rows in the result set, you will get an error.

Example

The

Example

in the discussion of

PCDLookup

illustrates how you can

use this method.

Related Items

See the following objects:

PCDLookup
PCDRecentDoc
PCDSearch

lngRowNbr

A long integer that indicates the row number
where you want to position the result set pointer.

Advertising