DioInpMultiBit


Function

Inputs multiple bits from the input bits.

Format

Ret = DioInpMultiBit ( Id , &BitNo[0] , BitNum , &Data[0] )

Parameters

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

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

BitNum [C:short] [Python: ctypes.c_short]
Specifies the number of bits which are specified by BitNo. The maximum number of bits 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_BIT_NO

20102

Bit number is outside of the available range.

DIO_ERR_SYS_BIT_NUM

20103

Number of bits is outside of the available range.

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

Initial Value

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

Remarks

Inputs multiple bits from the input bits.
Before this function is called, it is necessary that the logical bit numbers to be input are set into the array specified by BitNo.
The input data are stored into the array Data in the order that the logical bits are specified by BitNo. The input data are either 0 or 1.

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 DioInpMultiBitSR function when acquiring the real time information of the slave unit.

Example

C

Ret = DioInpMultiBit( Id , &BitNo[0] , BitNum , &Data[0] );
 

Python

Ret = cdio.DioInpMultiBit( Id , BitNo , BitNum , Data )
 

See Also

DioInpByte
DioInpBit
DioInpMultiByte
Logic_Bit