db_get
Previous Topic  Next Topic 

Synopsis:

       rec_handle=db_get(db_handle,recno[,lock])


Arguments:

       db_handle - A DBF file handle (as returned from db_open())

       recno - The record number to read from the DBF file

       [lock] - Optional locking (0=No lock, 1=Lock record)

       

Description:  This function reads the record number defined by the recno argument from the DBF file specified by the database handle db_handle.     If the optional lock argument is specified as a non-zero value then the record will be read with a record lock in place (so that another attempt to read the same record with a lock will fail).


Upon sucessfully reading the given record a record handle (rec_handle) is returned to an internal copy of the record.       This rec_handle can then be used in calls to db_fget() to retrieve the values of individual fields in the record.


The record lock will be held until a call to db_rls() or db_close() or db_rlsall() or db_closeall() is made.        Note that all record handles and database handles owned by a particular task will be released if the task is killed by a specific task_kill() or task_chain() command or a stop or restart statement.


Returns:   Returns the record handle or a negative error code.