API - Routines available on CliSiTef
In this chapter, we will present the functions available in clisitef. To this end, the following will be adopted conventions:
Empty field or not provided – in the standard version it is a field containing only the delimiter (binary zero). In the ASCII version, if it is a fixed field it contains spaces. If it is a variable field it only contains the start and end field delimiter.
Field size – in the case of a fixed size field, when this value is provided, it indicates what the minimum size to be reserved by the application to receive a response from SiTef.
Type of function parameters – we will divide them into two groups:
Regarding the flow of information: the parameter can be input or output.
When passing: the parameter can be passed by value or by reference. Each routine described in this chapter normally has two versions/interfaces:
Standard interface – traditional, allows parameters with binary data
ASCII Interface – for interface with programming languages, whose parameters work only in ASCII.
What differentiates the ASCII version from the standard version is the addition of the suffix A to the name of the functions, and the form / type of parameter passing.