MXIO Software Development Kit
C++ Sample Code Programming Guide
 All Classes Files Functions Variables Typedefs Macros Groups Pages
Functions
General_API

Functions

virtual int CMXIO_V3_2500::MXIO_Connect (char *szIP, WORD wPort, DWORD dwTimeOut, CMXIO_V3_2500::MX_MAC_ADDRESS *pMxMACAddr, MX_ACCOUNT_DATA *AccountData, int *hConnection)=0
 
virtual int CMXIO_V3_2500::MXIO_Disconnect (int hConnection)=0
 
virtual int CMXIO_V3_2500::MXIO_Restart (int hConnection)=0
 
virtual int CMXIO_V3_2500::MXIO_Read (int hConnection, WORD wBlockQuantity, CMXIO_V3_2500::MX_READ_BLOCK_DATA *pReadBlockData, pfnREADCALLBACK pfnProc, void *pParam)=0
 
virtual int CMXIO_V3_2500::MXIO_Write (int hConnection, WORD wBlockQuantity, CMXIO_V3_2500::MX_WRITE_BLOCK_DATA *pWriteBlockData, pfnWRITECALLBACK pfnProc, void *pParam)=0
 
virtual int CMXIO_V3_2500::MXIO_Clear (int hConnection, WORD wBlockQuantity, CMXIO_V3_2500::MX_CLEAR_BLOCK_DATA *pClearBlockData, pfnCLEARCALLBACK pfnProc, void *pParam)=0
 

Detailed Description

Function Documentation

virtual int CMXIO_V3_2500::MXIO_Connect ( char *  szIP,
WORD  wPort,
DWORD  dwTimeOut,
CMXIO_V3_2500::MX_MAC_ADDRESS pMxMACAddr,
MX_ACCOUNT_DATA AccountData,
int *  hConnection 
)
pure virtual
Parameters
[in]szIPIP address of a device or Cellular Data Access, e.g. "192.168.127.253"
[in]wPortTCP listen port of device (port: 10124) or Cellular Data Access
[in]dwTimeOuttimeout value (ms) for connecting to device or Cellular Data Access
[in]pMxMACAddreither MAC address of a device connecting to Cellular Data Access, or null for connecting to a device directly.
[in]AccountDatalogin username and password
[out]hConnectiondevice connection ID
Returns
MXIO_V3_ERR_CODE
virtual int CMXIO_V3_2500::MXIO_Disconnect ( int  hConnection)
pure virtual
Parameters
[out]hConnectionreturn device connection ID
Returns
MXIO_V3_ERR_CODE
virtual int CMXIO_V3_2500::MXIO_Restart ( int  hConnection)
pure virtual
Parameters
[in]hConnectiondevice connection ID returned from MXIO_Connect()
Returns
MXIO_V3_ERR_CODE
virtual int CMXIO_V3_2500::MXIO_Read ( int  hConnection,
WORD  wBlockQuantity,
CMXIO_V3_2500::MX_READ_BLOCK_DATA pReadBlockData,
pfnREADCALLBACK  pfnProc,
void *  pParam 
)
pure virtual
Parameters
[in]hConnectiondevice connection ID returned from MXIO_Connect()
[in]wBlockQuantitycommand block quantity (only one block allowed)
[in]pReadBlockDataarguments for reading the block data
[out]pfnProcreturn data of pReadBlockData arguments from callback function
[in]pParamreference data point (will return from callback function)

Note: wStartObj and wTotalObj of MX_CMD_BLOCK_HEADER must set to 0 and 1 in IOTYPE_SYS_SYSTEM Command.

Note: wStartObj and wTotalObj of MX_CMD_BLOCK_HEADER must set to 0 in IOTYPE_SYS_IO_MODE Command.

Returns
MXIO_V3_ERR_CODE
virtual int CMXIO_V3_2500::MXIO_Write ( int  hConnection,
WORD  wBlockQuantity,
CMXIO_V3_2500::MX_WRITE_BLOCK_DATA pWriteBlockData,
pfnWRITECALLBACK  pfnProc,
void *  pParam 
)
pure virtual
Parameters
[in]hConnectiondevice connection ID returned from MXIO_Connect()
[in]wBlockQuantitycommand block quantity (only one block allowed)
[in]pWriteBlockDataarguments for writing the block data
[out]pfnProcreturn data of pWriteBlockData arguments from callback function
[in]pParamreference data point (will return from callback function)
Returns
MXIO_V3_ERR_CODE
virtual int CMXIO_V3_2500::MXIO_Clear ( int  hConnection,
WORD  wBlockQuantity,
CMXIO_V3_2500::MX_CLEAR_BLOCK_DATA pClearBlockData,
pfnCLEARCALLBACK  pfnProc,
void *  pParam 
)
pure virtual
Parameters
[in]hConnectiondevice connection ID returned from MXIO_Connect()
[in]wBlockQuantitycommand block quantity (only one block allowed)
[in]pClearBlockDataarguments for clearing the block data
[out]pfnProcreturn data of pClearBlockData arguments from callback function
[in]pParamreference data point (will return from callback function)
Returns
MXIO_V3_ERR_CODE