<< Click to Display Table of Contents >> Navigation:  NmxDLL Reference Guide > API (programming interface) > Get device information > NMX_GetDigitalInputInfo_1

This function is used to read information about a digital input byte. Each input byte represents 8 digital input bits.

 

Definition

---

NMX_STATUS NMX_GetDigitalInputInfo_1(

 NMX_PHANDLE pHandle,

 unsigned long ulInputByteNo,

 unsigned long* pulBoxNo,

 unsigned long* pulBoxByteNo);

 

Parameter

---

pHandle

Connection Handle.

ulInputByteNo

Number of the digital input byte.
The first byte has the number 0.
Example: Having a device with 4 input bytes, these are numbered 0..3.

pulBoxNo

Number of the Box, where the digital inputs are located.

pulBoxByteNo

Number of the digital input byte within its measurement box.
Numbering starts at 1 with each Box.
 
Example: In a system with 2 Boxes à 16 digital inputs, input byte 3 is the 1st input byte of the second box. Thus the value 1 is returned.

 

Typical function call (C example)

---

NMX_GetDigitalInputInfo_1(pHandle, ulInByte, &ulBoxNo, &ulBoxByteNo);

 

.Net DLL specific implementation

---

NMX_MSTATUS GetDigitalInputInfo_1(

                 System::IntPtr pHandle,

                 System::UInt32 ulInputByteNo,

                 System::UInt32 %pulBoxNo,

                 System::UInt32 %pulBoxByteNo);

 

Comments

---

It is good practice reading the digital input count first. Then read the byte information for each digital input byte.

The function only returns values, if the function return code is NST_SUCCESS. Otherwise the values remain unchanged.