4.1     API

4.1.1       StartDataProcessorMsg

mandatory function
 

Declaration

 

function StartDataProcessorMsg(

                                        pInMsg, pParam : PChar;

                                        inpLen, parLen : integer;

                                        var pOutMsg    : Pointer;

                                        var outLen     : integer

                                        ): integer; stdcall;

 

Arguments

 

pInMsg        : pointer to input message data

pParam        : pointer to parameter data, see Pre-defined Parameters

inpLen        : length of message data

parLen        : length of parameter data

pOutMsg      : pointer to output data

outLen        : length of output data

 

Function Result

 

= 0    : OK

0    : failure

 

Description

 

This function calls the data-processor. If the function succeeds then it allocates global memory where the result data will be passed. The variable 'pOutMsg' provides the pointer to this memory and the variable 'outLen' provides the number of bytes of the allocated memory.

 

Note: The caller of this function has to free the allocated memory.

 

file-processing

In case a file shall be processed then the parameter '-file' has to be set. Use this function as following:

pInMsg       : pointer to input file-name

pParam       : pointer to parameter data

inpLen       : length of file-name

parLen       : length of parameter data

pOutMsg      : pointer to output file-name

outLen       : length of output file-name

 

decoder

In case this function shall be used as decoder and the decoder provides several decoder messages then the desired decoder message ID can be passed as parameter as following:

 

sid=<decoder_message_id> , e.g. sid=8

 

Get decoder_message_id's by calling the procedure GetDecoderMessages