ReadInputWord

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

Syntax

KsError ReadInputWord(
     int Index,
     int ByteOffset,
     WORD* Value
);

Parameters

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

ByteOffset: specifies a byte offset to the location to read a WORD value. The max offset is determined by InputLength in the SlaveStatus structure.

Value: pointer to the value that will receive the WORD 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

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

Usable EtherCAT states

ecatOP

Example

Copy

WORD wRead = 0;
nRet = ReadInputWord(0, 0, &wRead);

Requirements

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