neMESYS SDK
20150729
|
This group defines all required error functions for controlling the device directly by reading and writing the object dictionary and process data. More...
Functions | |
NCS_Func long __stdcall | NCS_ReadObjDicEntry (ncs_hdl hDevice, unsigned char DosingUnit, void *pDataBuf, unsigned short wSize, unsigned short wObjDicIdx, unsigned char ObjDicSub, bool bConsiderEndian) |
Read object dictionary entry. More... | |
NCS_Func long __stdcall | NCS_ReadObjDicEntryInt (ncs_hdl hDevice, unsigned char DosingUnit, long *pDataBuf, unsigned char ByteSize, unsigned short wObjDicIdx, unsigned char ObjDicSub) |
Read object dictionary entry and interpret as signed integer value. More... | |
NCS_Func long __stdcall | NCS_ReadProcData (ncs_hdl hDevice, unsigned char DosingUnit, void *pBuf, unsigned short wSize, unsigned short wObjDicIdx, unsigned char ObjDicSub) |
Read process data. More... | |
NCS_Func long __stdcall | NCS_ReadProcDataInt (ncs_hdl hDevice, unsigned char DosingUnit, long *pBuf, unsigned char ByteSize, unsigned short wObjDicIdx, unsigned char ObjDicSub) |
Read process data and interpret it as an signed integer value. More... | |
NCS_Func long __stdcall | NCS_WriteObjDicEntry (ncs_hdl hDevice, unsigned char DosingUnit, const void *pDataBuf, unsigned short wSize, unsigned short wObjDicIdx, unsigned char ObjDicSub, bool bConsiderEndian) |
Write an object dictionary entry. More... | |
NCS_Func long __stdcall | NCS_WriteObjDicEntryInt (ncs_hdl hDevice, unsigned char DosingUnit, long Data, unsigned char ByteSize, unsigned short wObjDicIdx, unsigned char ObjDicSub) |
Write a signed integer object dictionary entry. More... | |
NCS_Func long __stdcall | NCS_WriteProcData (ncs_hdl hDevice, unsigned char DosingUnit, void *pBuf, unsigned short wSize, unsigned short wObjDicIdx, unsigned char ObjDicSub, bool bImmediately) |
Write data into process image of this device. More... | |
NCS_Func long __stdcall | NCS_WriteProcDataInt (ncs_hdl hDevice, unsigned char DosingUnit, long Data, unsigned char ByteSize, unsigned short wObjDicIdx, unsigned char ObjDicSub, bool bImmediately) |
Write a signed integer value into process image of this device. More... | |
This group defines all required error functions for controlling the device directly by reading and writing the object dictionary and process data.
Please refer to the technical documentation of the device for more information on controlling the device directly with those functions.
NCS_Func long __stdcall NCS_ReadObjDicEntry | ( | ncs_hdl | hDevice, |
unsigned char | DosingUnit, | ||
void * | pDataBuf, | ||
unsigned short | wSize, | ||
unsigned short | wObjDicIdx, | ||
unsigned char | ObjDicSub, | ||
bool | bConsiderEndian | ||
) |
Read object dictionary entry.
[in] | hDevice | Valid device handle |
[in] | DosingUnit | Index of neMESYS pump from 0 to number of pumps - 1 |
[in] | pDataBuf | Buffer for data storage of read data |
[in] | wSize | Size of buffer (size of data to read) |
[in] | wObjDicIdx | Index into object dictionary |
[in] | ObjDicSub | Sub index into object dictionary |
[in] | bConsiderEndian | Endianess does matter |
NCS_Func long __stdcall NCS_ReadObjDicEntryInt | ( | ncs_hdl | hDevice, |
unsigned char | DosingUnit, | ||
long * | pDataBuf, | ||
unsigned char | ByteSize, | ||
unsigned short | wObjDicIdx, | ||
unsigned char | ObjDicSub | ||
) |
Read object dictionary entry and interpret as signed integer value.
[in] | hDevice | Valid device handle |
[in] | DosingUnit | Index of neMESYS pump from 0 to number of pumps - 1 |
[in] | pDataBuf | Buffer for data storage of read data |
[in] | ByteSize | Data size in byte (Byte = 1; Word = 2; DWORD = 4) |
[in] | wObjDicIdx | Index into object dictionary |
[in] | ObjDicSub | Sub index into object dictionary |
[in] | bConsiderEndian | Endianess does matter |
NCS_Func long __stdcall NCS_ReadProcData | ( | ncs_hdl | hDevice, |
unsigned char | DosingUnit, | ||
void * | pBuf, | ||
unsigned short | wSize, | ||
unsigned short | wObjDicIdx, | ||
unsigned char | ObjDicSub | ||
) |
Read process data.
[in] | hDevice | Valid device handle |
[in] | DosingUnit | Index of neMESYS pump from 0 to number of pumps - 1 |
[in] | pBuf | Buffer for data storage of read data |
[in] | wSize | Size of buffer (size of data to read) |
[in] | wObjDicIdx | Index into object dictionary |
[in] | ObjDicSub | Sub index into object dictionary |
NCS_Func long __stdcall NCS_ReadProcDataInt | ( | ncs_hdl | hDevice, |
unsigned char | DosingUnit, | ||
long * | pBuf, | ||
unsigned char | ByteSize, | ||
unsigned short | wObjDicIdx, | ||
unsigned char | ObjDicSub | ||
) |
Read process data and interpret it as an signed integer value.
[in] | hDevice | Valid device handle |
[in] | DosingUnit | Index of neMESYS pump from 0 to number of pumps - 1 |
[in] | pBuf | Buffer for data storage of read data |
[in] | ByteSize | Data size in byte (Byte = 1; Word = 2; DWORD = 4) |
[in] | wObjDicIdx | Index into object dictionary |
[in] | ObjDicSub | Sub index into object dictionary |
[in] | bConsiderEndian | Endianess does matter |
NCS_Func long __stdcall NCS_WriteObjDicEntry | ( | ncs_hdl | hDevice, |
unsigned char | DosingUnit, | ||
const void * | pDataBuf, | ||
unsigned short | wSize, | ||
unsigned short | wObjDicIdx, | ||
unsigned char | ObjDicSub, | ||
bool | bConsiderEndian | ||
) |
Write an object dictionary entry.
[in] | hDevice | Valid device handle |
[in] | DosingUnit | Index of neMESYS pump from 0 to number of pumps - 1 |
[in] | pDataBuf | Buffer for data storage of read data |
[in] | wSize | Size of buffer (size of data to read) |
[in] | wObjDicIdx | Index into object dictionary |
[in] | ObjDicSub | Sub index into object dictionary |
[in] | bConsiderEndian | Endianess does matter |
NCS_Func long __stdcall NCS_WriteObjDicEntryInt | ( | ncs_hdl | hDevice, |
unsigned char | DosingUnit, | ||
long | Data, | ||
unsigned char | ByteSize, | ||
unsigned short | wObjDicIdx, | ||
unsigned char | ObjDicSub | ||
) |
Write a signed integer object dictionary entry.
[in] | hDevice | Valid device handle |
[in] | DosingUnit | Index of neMESYS pump from 0 to number of pumps - 1 |
[in] | Data | Data to write |
[in] | ByteSize | Data size in byte (Byte = 1; Word = 2; DWORD = 4) |
[in] | wObjDicIdx | Index into object dictionary |
[in] | ObjDicSub | Sub index into object dictionary |
[in] | bConsiderEndian | Endianess does matter |
NCS_Func long __stdcall NCS_WriteProcData | ( | ncs_hdl | hDevice, |
unsigned char | DosingUnit, | ||
void * | pBuf, | ||
unsigned short | wSize, | ||
unsigned short | wObjDicIdx, | ||
unsigned char | ObjDicSub, | ||
bool | bImmediately | ||
) |
Write data into process image of this device.
[in] | hDevice | Valid device handle |
[in] | DosingUnit | Index of neMESYS pump from 0 to number of pumps - 1 |
[in] | pBuf | Buffer for data to write |
[in] | wSize | Size of buffer (size of data to write) |
[in] | wObjDicIdx | Index into object dictionary |
[in] | ObjDicSub | Sub index into object dictionary |
[in] | bImmediately | Send process data immediately |
[in] | bConsiderEndian | Endianess does matter |
NCS_Func long __stdcall NCS_WriteProcDataInt | ( | ncs_hdl | hDevice, |
unsigned char | DosingUnit, | ||
long | Data, | ||
unsigned char | ByteSize, | ||
unsigned short | wObjDicIdx, | ||
unsigned char | ObjDicSub, | ||
bool | bImmediately | ||
) |
Write a signed integer value into process image of this device.
[in] | hDevice | Valid device handle |
[in] | DosingUnit | Index of neMESYS pump from 0 to number of pumps - 1 |
[in] | Data | Data to write |
[in] | ByteSize | Data size in byte (Byte = 1; Word = 2; DWORD = 4) |
[in] | wObjDicIdx | Index into object dictionary |
[in] | ObjDicSub | Sub index into object dictionary |
[in] | bImmediately | Send process data immediately |