DioInpBit

Function

Inputs a bit from an input port.

Format

Ret = DioInpBit ( Id , BitNo , Data )

Parameters

Id [ VB.NET: Short ] [ C, C++: short ] [ C#: short ] [ Python: ctypes.c_short ]
Specify the device ID retrieved from DioInit.

BitNo [ VB.NET: Short ] [ C, C++: short ] [ C#: short ] [ Python: ctypes.c_short ]
Specify the logical input bit number. The logical input bit number is a number, which is allocated from the first input bit of a device as 0 to the last one serially.

Data [ VB.NET: Byte ] [ C, C++: BYTE * ] [ C#: out byte ] [ Python: ctypes.POINTER(ctypes.c_ubyte) ]
Specify the address of the variable to store the input datum.

Return Value

Ret [ VB.NET: Integer ] [ C, C++: long ] [ C#: int ] [ Python: ctypes.c_long ]

Definition	Value [Dec]	Description
DIO_ERR_SUCCESS	0	Normal completed.
DIO_ERR_SYS_RECOVERED_FROM_STANDBY	7	Execute DioResetDevice function because the device has recovered from standby mode.
DIO_ERR_DLL_INVALID_ID	10001	Invalid ID specified.
DIO_ERR_DLL_CALL_DRIVER	10002	Not call the driver (Failure on DEVICE I/O CONTROL).
DIO_ERR_DLL_BUFF_ADDRESS	10100	Invalid data buffer address.
DIO_ERR_SYS_NOT_SUPPORTED	20001	This board couldn't use this function.
DIO_ERR_SYS_BIT_NO	20102	Bit No. beyond the limit.

The others (See also: Details of Error Code)

Initial Value

The initial value of the input datum is 0 in the state that other external equipment is not connected.

Remarks

Inputs a bit from an input port. The returned bit datum is 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 DioInpBitSR function when acquiring the real time information of the slave unit.

Example

Inputs datum from bit 0.

VB.NET	Dim Ret As Integer Dim Data As Byte Ret = DioInpBit ( Id , 0 , Data )
C, C++	long Ret; BYTE Data; Ret = DioInpBit ( Id , 0 , &Data );
C#	int Ret; byte Data; Ret = dio.InpBit ( Id , 0 , out Data );
Python	Ret = ctypes.c_long() Data = ctypes.c_ubyte() Ret.value = cdio.DioInpBit ( Id , 0 , ctypes.byref(Data) )