ApiLib

Collaboration diagram for ApiLib:

Modules
	Connection control
	Utility functions
	Version and Permission
	Structs, Types, ...

Detailed Description

The ApiLib contains elementary functions used to establish a connection between your client application and a target system. This has to be done before any other MLPI function can be called.

The MLPI is session oriented. This means, that you need to connect to a target before you can use any other MLPI function call (with exception of the function mlpiApiGetClientCoreVersion). After successfully connecting to the target (using mlpiApiConnect) you will get a handle which identifies your connection and which can be used for any further MLPI function call. Please have a look at the documentation and examples of the function mlpiApiConnect for more information.

You will find some additional functions to test if the session is still established (mlpiApiIsConnected), to test the connection speed (mlpiApiTestConnection) or to get version information (mlpiApiGetClientCoreVersion, mlpiApiGetServerCoreVersion).

Note

The ApiLib functions trace their debug information mainly into the module MLPI_API_LIB and in additional into the module MLPI_BASE_MODULES. For further information, see also the detailed description of the library TraceLib and the notes about Using the Trace for debugging.