GET-FIRST( ) method

Moves a query object’s result list pointer to the first row.

Return type: LOGICAL

Applies to: Query object handle

Syntax

GET-FIRST ( NO-LOCK | SHARE-LOCK [ , NO-WAIT ] | EXCLUSIVE-LOCK [ , NO-WAIT ] )

NO-LOCK

Specifies that no lock is applied to the record. This applies to all buffers in a join. Unless explicitly specified otherwise, this is the default lock type for this method.

SHARE-LOCK

Specifies that the record is share locked. This applies to all buffers in a join.

EXCLUSIVE-LOCK

Specifies that the record is exclusively locked. This applies to all buffers in a join.

NO-WAIT

Specifies that the method returns immediately if the record cannot be accessed because it is locked by another user. If you do not use the NO-WAIT option, the method waits until the record can be accessed. This applies to all buffers in a join. If you specify NO-WAIT and the record is locked by another user, the record is returned to you with NO-LOCK and the LOCKED function returns TRUE for the record.

GET-FIRST() returns TRUE if the first record in the query is found. If the query is not open or the first record cannot be found (query is empty), the method returns FALSE. If the query object handle is invalid, the method returns the Unknown value (?).

A query that includes a BREAK BY phrase becomes a FORWARD-ONLY query. In this case you cannot use the GET-FIRST() method. If you do, the AVM raises ERROR.

OpenEdge Release 10.2B

Copyright © 2009 Progress Software Corporation