gsk_query_database_record

Queries the database record length.

Format

#include <gskcms.h>

gsk_status gsk_query_database_record_length (
                                             gsk_handle                    db_handle,
                                             gsk_size *                    record_length)

Parameters

db_handle: Specifies the database handle returned by the gsk_create_database() routine or the gsk_open_database() routine.
record_length: Returns the current database record length. All records in the database have this length.

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.

Usage

The gsk_query_database_record_length() routine will return the record length for the database. All records in the database have the same length and a database entry cannot span records. The gsk_change_database_record_length() routine can be called to change the database record length.