gsk_get_record_by

Gets a database record using the record identifier.

Format

   #include <gskcms.h>

   gsk_status gsk_get_record_by_id ( 
                                     gsk_handle              db_handle,  
                                     gsk_int32               record_id, 
                                     gskdb_record **         record)

Parameters

db_handle: Specifies the database handle returned by the gsk_create_database() routine, the gsk_open_database() routine, or the gsk_open_keyring() routine.
record_id: Specifies the record identifier.
record: Returns the database record. The application should call the gsk_free_record() routine to release the record when it is no longer needed.

Results

The function return value will be 0 if no error is detected. Otherwise, it will be one of the return codes listed in the gskcms.h include file. These are some possible errors:

[CMSERR_BAD_HANDLE]: The database handle is not valid.
[CMSERR_NO_MEMORY]: Insufficient storage is available.
[CMSERR_RECORD_NOT_FOUND]: The requested record is not found.

Usage

The gsk_get_record_by_id() routine retrieves a record from a key or request database based upon the unique record identifier. The record identifier is assigned when the record is added to the database and does not change as records are added and deleted.