AltairIpcGetIncomingHeader
Reads header information from the Altair program.
Syntax
int AltairIpcGetIncomingHeader(AltairIpcIncomingHeader *header)
typedef struct
{
int num_items;
int *item_type;
} AltairIpcIncomingHeader;
Inputs
- num_items
- Sn integer specifying the number of data items being sent from the Altair program.
- item_type
- An array of data type descriptions. Each element in this array indicates the "type"
of each item. An item type is one of the following constants:
- ALTAIR_IPC_MESSAGE
- ALTAIR_IPC_ERROR
- ALTAIR_IPC_VECTOR
- ALTAIR_IPC_HEADER
Comments
The header specifies the number of data items and the type of data being sent from the Altair program to the external program.
The AltairIpcGetIncomingHeader function returns an integer. If the value returned is 0, the function failed. If the value returned is non-zero, the function succeeded.
You are responsible for freeing the memory returned in the item_type variable if the function succeeds.