DioInpMultiByte


Function

Inputs multiple bytes from the input ports.

Format

Ret = DioInpMultiByte ( Id , &PortNo[0] , PortNum , &Data[0] )

Parameters

Id [C:short] [Python: ctypes.c_short]
Specified device ID retrieved from DioInit.

PortNo [C:short *] [Python: ctypes.POINTER(ctypes.c_short)]
Stores the logical input port numbers into an array. Specifies the base address of this array.

PortNum [C:short] [Python: ctypes.c_short]
Specifies the number of ports which are specified by PortNo. The maximum number of ports is 256.

Data [C:unsigned char *] [Python: ctypes.POINTER(ctypes.c_ubyte)]
Specifies the base address of array to store the input data.

Return Value

Ret[C:long] [Python: ctypes.c_long]

Definition

Value

[Dec]

Description

DIO_ERR_SUCCESS

0

Normal complete

DIO_ERR_DLL_INVALID_ID

10001

Invalid ID is specified.

DIO_ERR_DLL_CALL_DRIVER

10002

Driver cannot be called (failed in ioctl).

DIO_ERR_DLL_BUFF_ADDRESS

10100

Invalid data buffer address.

DIO_ERR_SYS_NOT_SUPPORTED

20001

This function cannot be used for this device.

DIO_ERR_SYS_PORT_NO

20100

Port number is outside of the available range.

DIO_ERR_SYS_PORT_NUM

20101

Number of ports is outside of the available range.

The other errors: (See also: Error code details)

Initial Value

The initial values of the input data are 0, if no external device is connected.

Remarks

Inputs multiple bytes from the input ports.
Before this function is called, it is necessary that the logical port numbers to be input are set into the array specified by PortNo.
The input data are stored into the array Data in the order that the logical ports are specified by PortNo.

In the case of a wireless I/O device, it acquires the data of the slave unit stored in the master unit.
Please note that it is not real time information of the slave unit.
Please use the DioInpMultiByteSR function when acquiring the real time information of the slave unit.

Example

C

Ret = DioInpMultiByte( Id , &PortNo[0] , PortNum , &Data[0] );
 

Python

Ret = cdio.DioInpMultiByte( Id , PortNo , PortNum , Data )
 

See Also

DioInpByte
DioInpBit
DioInpMultiBit
Logic_Bit