DioInpByte

Function

Inputs a byte (8 bits) from an input port.

Format

Ret = DioInpByte ( Id , PortNo , Data )

Parameters

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

PortNo [ VB.NET: Short ] [ C, C++: short ] [ C#: short ] [ Python: ctypes.c_short ]
Specify the logic input port number. The logical input port number is a number, which is allocated from the first input port 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_PORT_NO	20100	Port 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 byte (8 bits) from an input port. When you want to get necessary information for a bit, please use the bit operators corresponding to each language.

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

Example

Inputs datum from port 0.

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