AAL2CINIT_APrepare

Prev Next

Function prototype

aat_int32 AAL2CINIT_APrepare(TCinitHandle*   CHandle,
                             aat_ascii*      HeaderRecord,
                             aat_ascii*      InitKey);

Description

This function is used to initialize the import process of a CINIT_A.DGP file.

This function is mentioned for compatibility reasons with previous releases. It is obsolete and should not be used anymore.

Unlike with the DPX file, the application is responsible for all the I/O operations to the file. This function is called by passing it the CINIT_A.DGP HeaderRecord, which should be the first in the file, and the 14-digit InitKey that has been used to encrypt the file.

If this key is successfully verified, the CHandle is populated for use by the AAL2CINIT_AProcess function.

Parameters

  Table: Parameters (AAL2CINIT_APrepare)
TypeNameUseDescription
TCinitHandle *CHandleI/OPointer to the handle used during the CINIT_A.DGP file import operation. This block must be passed to AAL2CINIT_AProcess.
aat_ascii *HeaderRecordI64-byte CINIT_A.DGP file header record. This is normally the first record of the file, with 0 as the first character.
aat_ascii *InitKeyIString of 14 hexadecimal digits. This is the CINIT_A.DGP file encryption key.

Return codes

  Table: Return codes (AAL2DPXCINIT_APrepare)
CodeMeaningCodeMeaning
0Success506Invalid CINIT handle pointer
500Init key not verified507Invalid CINI HDR pointer
501Bad init key length508Invalid header record