ReadInputBit

Reads a bit from an input of a real or simulated I/O module.

Syntax

KsError ReadInputBit(
     int Index,
     int BitOffset,
     BOOL* Value
);

Parameters

Index: the index of an I/O module. Indexes are zero based. Aliases affect this parameter.

BitOffset: specifies a bit offset to the location to read a bit value. The max offset is determined by InputLength in the SlaveStatus structure.

Value: pointer to the value that will receive the bit read.

Return value

If the function succeeds, it returns errNoError, otherwise an error code. For more information about the error code, see the KsError list.

Remarks

ReadInputBit can only be called once a link is established and started.

Usable EtherCAT states

ecatOP

Example

N/A

Requirements

  RT Win32
Minimum supported version 4.0 4.0
Header ksapi.h ksapi.h
Library KsApi_Rtss.lib KsApi.lib

See also

ReadInputByte

ReadInputDWord

ReadInputWord

ReadOutputBit

ReadOutputByte

ReadOutputDWord

ReadOutputWord