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

Functions

virtual int CMXIO_V3_2500::MXIO_Connect (char *szIP, WORD wPort, DWORD dwTimeOut, char *szMACAddr, 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 *pRwBlockData, 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,
char *  szMACAddr,
MX_ACCOUNT_DATA AccountData,
int *  hConnection 
)
pure virtual
Parameters
[in]szIPIP address of device or Cellular Data Access. e.g. "192.16.127.253"
[in]wPortTCP port of device agent service or Cellular Data Access service.
[in]dwTimeOutTimeout value (ms) that try to link to device service or Cellular Data Access service.
[in]szMACAddrInput device MAC address that link to Cellular Data Access or empty that link to device directly.
[in]AccountDataLogin account information.
[out]hConnectionHandle of device.
Returns
MXIO_V3_ERR_CODE
virtual int CMXIO_V3_2500::MXIO_Disconnect ( int  hConnection)
pure virtual
Parameters
[out]hConnectionreturn device handle number.
Returns
MXIO_V3_ERR_CODE
virtual int CMXIO_V3_2500::MXIO_Restart ( int  hConnection)
pure virtual
Parameters
[in]hConnectionInput device handle number that MXIO_Connect() return.
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]hConnectionInput device handle number that MXIO_Connect() return.
[in]wBlockQuantityInput command block Quantity. Only support one block right now.
[in]pRwBlockDataInput read parameters.
[out]pfnProcOutput read result to callback function.
[in]pParamInput reference data point return by 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 pRwBlockData,
pfnWRITECALLBACK  pfnProc,
void *  pParam 
)
pure virtual
Parameters
[in]hConnectionInput device handle number that MXIO_Connect() return.
[in]wBlockQuantityInput command block Quantity. Only support one block right now.
[in]pRwBlockDataInput write parameters.
[out]pfnProcOutput write result to callback function.
[in]pParamInput reference data point return by 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]hConnectionInput device handle number that MXIO_Connect() return.
[in]wBlockQuantityInput command block Quantity. Only support one block right now.
[in]pClearBlockDataInput clear parameters.
[out]pfnProcOutput clear result to callback function.
[in]pParamInput reference data point return by callback function.
Returns
MXIO_V3_ERR_CODE