gsk_change_database_record

Changes the database record length.

Format

   #include <gskcms.h>
   
   gsk_status gsk_change_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: Specifies the new database record length. The default record length will be used if zero is specified for this parameter. All records in the database will have this length. The minimum record length is 2500. The default record length is 5000.

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_BACKUP_EXISTS]: The backup file already exists.
[CMSERR_BAD_HANDLE]: The database handle is not valid.
[CMSERR_IO_ERROR]: An input/output request failed.
[CMSERR_LENGTH_TOO_SMALL]: The record length is less than the minimum value.
[CMSERR_NO_MEMORY]: Insufficient storage is available.
[CMSERR_RECORD_TOO_BIG]: A record in the database is larger than the new record length.
[CMSERR_UPDATE_NOT_ALLOWED]: Database is not open for update or update attempted on a FIPS mode database while in non-FIPS mode.

Usage

The gsk_change_database_record_length() routine will change the record length for the database. All records in the database have the same length and a database entry cannot span records. An error will be returned if the requested record length is smaller than the largest entry in the database.