neMESYS SDK  20150729
Device Specific Functions

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...
 

Detailed Description

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.

Function Documentation

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.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[in]pDataBufBuffer for data storage of read data
[in]wSizeSize of buffer (size of data to read)
[in]wObjDicIdxIndex into object dictionary
[in]ObjDicSubSub index into object dictionary
[in]bConsiderEndianEndianess does matter
Returns
Error code - ERR_NOERR indicates success
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.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[in]pDataBufBuffer for data storage of read data
[in]ByteSizeData size in byte (Byte = 1; Word = 2; DWORD = 4)
[in]wObjDicIdxIndex into object dictionary
[in]ObjDicSubSub index into object dictionary
[in]bConsiderEndianEndianess does matter
Returns
Error code - ERR_NOERR indicates success
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.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[in]pBufBuffer for data storage of read data
[in]wSizeSize of buffer (size of data to read)
[in]wObjDicIdxIndex into object dictionary
[in]ObjDicSubSub index into object dictionary
Returns
Error code - ERR_NOERR indicates success
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.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[in]pBufBuffer for data storage of read data
[in]ByteSizeData size in byte (Byte = 1; Word = 2; DWORD = 4)
[in]wObjDicIdxIndex into object dictionary
[in]ObjDicSubSub index into object dictionary
[in]bConsiderEndianEndianess does matter
Returns
Error code - ERR_NOERR indicates success
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.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[in]pDataBufBuffer for data storage of read data
[in]wSizeSize of buffer (size of data to read)
[in]wObjDicIdxIndex into object dictionary
[in]ObjDicSubSub index into object dictionary
[in]bConsiderEndianEndianess does matter
Returns
Error code - ERR_NOERR indicates success
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.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[in]DataData to write
[in]ByteSizeData size in byte (Byte = 1; Word = 2; DWORD = 4)
[in]wObjDicIdxIndex into object dictionary
[in]ObjDicSubSub index into object dictionary
[in]bConsiderEndianEndianess does matter
Returns
Error code - ERR_NOERR indicates success
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.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[in]pBufBuffer for data to write
[in]wSizeSize of buffer (size of data to write)
[in]wObjDicIdxIndex into object dictionary
[in]ObjDicSubSub index into object dictionary
[in]bImmediatelySend process data immediately
[in]bConsiderEndianEndianess does matter
Returns
Error code
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.

Parameters
[in]hDeviceValid device handle
[in]DosingUnitIndex of neMESYS pump from 0 to number of pumps - 1
[in]DataData to write
[in]ByteSizeData size in byte (Byte = 1; Word = 2; DWORD = 4)
[in]wObjDicIdxIndex into object dictionary
[in]ObjDicSubSub index into object dictionary
[in]bImmediatelySend process data immediately
Returns
Error code