gsk_get_record_by

Gets a database record using the record label.

Format

   #include <gskcms.h>

   gsk_status gsk_get_record_by_label (  
                                        gsk_handle              db_handle, 
                                        const char *            label,  
                                        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.
label: Specifies the label of the database record. The label is specified in the local code page.
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_BAD_LABEL]: No label specified.
[CMSERR_MULTIPLE_LABEL]: Multiple certificates exist for label.
[CMSERR_NO_MEMORY]: Insufficient storage is available.
[CMSERR_RECORD_NOT_FOUND]: The requested record is not found.

Usage

The gsk_get_record_by_label() routine retrieves a record from a key or request database based upon the record label. The record label is a character string assigned when the record is added to the database. The label comparison is case-sensitive.