Pump API Initialisation
Overview
API specific initialisation functions.
This groups defines all functions to setup and initialize the labbCAN pump API properly.
Collaboration diagram for Pump API Initialisation:
Functions | |
| long | LCP_GetNoOfPumps () |
| Query number of detected pump devices. More... | |
| long | LCP_GetPumpHandle (unsigned char Index, dev_hdl *PumpHandle) |
| Get pump handle by its index. More... | |
| long | LCP_LookupPumpByName (const char *pPumpName, dev_hdl *PumpHandle) |
| Lookup for a pump device by its name. More... | |
Function Documentation
| long LCP_GetNoOfPumps | ( | ) |
Query number of detected pump devices.
- Return values
-
>= 0 Number of detected pump devices < 0 Error code
- Examples:
- capi_nemesys_test.cpp.
| long LCP_GetPumpHandle | ( | unsigned char | Index, |
| dev_hdl * | PumpHandle | ||
| ) |
Get pump handle by its index.
- Parameters
-
[in] Index Index into list of available pump devices [out] PumpHandle Handle to pump device or 0 if the given index is out of range
- Return values
-
-ERR_PARAM_RANGE If the given device index is out of range ERR_NOERR indicates success
- Examples:
- capi_event_queue_test.cpp, capi_nemesys_test.cpp, and capi_pressure_control_test.cpp.
| long LCP_LookupPumpByName | ( | const char * | pPumpName, |
| dev_hdl * | PumpHandle | ||
| ) |
Lookup for a pump device by its name.
- Parameters
-
[in] pPumpName The name of the device to lookup for [out] PumpHandle Handle to pump device or 0 if no pump with given name exists
- Return values
-
-ERR_NODEV No device with the given name found ERR_NOERR indicates success