ACI Structures

Top  Previous  Next

This chapter describes the structures used by the ACI functions.

 

Structure

The ACI function that uses the structure

ACI_Launch_Params

ACI_Launch

ACI_Config_Params

ACI_LoadConfigFile, ACI_SaveConfigFile

ACI_Device_Params

ACI_GetDevice, ACI_SetDevice,

ACI_Layer_Params

ACI_GetLayer

ACI_Buffer_Params

ACI_CreateBuffer, ACI_ReallocBuffer

ACI_Memory_Params

ACI_ReadLayer, ACI_WriteLayer, ACI_FillLayer

ACI_Programming_Params

ACI_SetProgrammingParams, ACI_GetProgrammingParams

ACI_ProgOption_Params

ACI_GetProgOption, ACI_SetProgOption

ACI_Function_Params

ACI_ExecFunction, ACI_StartFunction

ACI_PStatus_Params

ACI_GetStatus

ACI_File_Params

ACI_FileLoad, ACI_FileSave

ACI_GangStart_Params

ACI_GangStart, ACI_GetStatus

ACI_GangTerminate_Params

ACI_GangTerminateFunction

 

Here is an example of the structure syntax:

 

typedef struct tagACI_Buffer_Params

{

 UINT   Size;             // (in)  Size of structure, in bytes

 DWORD  Layer0SizeLow;    // (in || out) Low 32 bits of layer 0 size, in bytes

 DWORD  Layer0SizeHigh;   // (in || out) High 32 bits of layer 0 size, in bytes

                          //       Layer size is rounded up to a nearest value supported by programmer.

 LPCSTR BufferName;       // (in)  Buffer name

 UINT   BufferNumber;     // For ACI_CreateBuffer(): out: Created buffer number

                          // For ACI_ReallocBuffer(): in: Buffer number to realloc

 UINT   NumBuffers;       // (out) Total number of currently allocated buffers

 UINT   NumLayers;        // (out) Total number of layers in a buffer

} ACI_Buffer_Params;

 

Each structure includes a number of parameters (here Size, Layer0SizeLow, NumBuffers, etc.). The parameter's name follows its format (UINT, DWORD, LPCSTR, CHAR, BOOL, etc.). The comment on the parameter begins from a bracketed symbol showing the sending direction of this parameter:
 

(in) - the parameter is sent from the instrumental computer to the programmer;
(out) - the parameter is sent from the programmer to the instrumental computer;
(in || out) - the parameter can be sent in either direction, depending on the ACI function context.