Valve API Initialization
Overview
This groups defines all functions to retrieve valid valve device handles from the labbCAN valve library.
Collaboration diagram for Valve API Initialization:
Functions | |
| long | LCV_GetNoOfValves () |
| Query number of detected valve devices. More... | |
| long | LCV_GetValveHandle (unsigned char Index, dev_hdl *ValveHandle) |
| Get valve handle by its index. More... | |
| long | LCV_LookupValveByName (const char *pValveName, dev_hdl *ValveHandle) |
| Lookup for a valve device by its name. More... | |
Function Documentation
| long LCV_GetNoOfValves | ( | ) |
Query number of detected valve devices.
- Return values
-
>= 0 Number of detected valve devices < 0 Error code
| long LCV_GetValveHandle | ( | unsigned char | Index, |
| dev_hdl * | ValveHandle | ||
| ) |
Get valve handle by its index.
- Parameters
-
[in] Index Index into list of available valve devices [out] ValveHandle Handle to valve 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_nemesys_valve_test.cpp.
| long LCV_LookupValveByName | ( | const char * | pValveName, |
| dev_hdl * | ValveHandle | ||
| ) |
Lookup for a valve device by its name.
- Parameters
-
[in] pValveName The name of the device to lookup for [out] ValveHandle Handle to valve device or 0 if no valve with given name exists
- Return values
-
-ERR_NODEV No device with the given name found ERR_NOERR indicates success
- Examples:
- capi_contiflow_test.cpp, and capi_nemesys_valve_test.cpp.