<< Click to Display Table of Contents >> Navigation:  NmxDLL Reference Guide > API (programming interface) > Sampling LowLevel (Time-Triggered Realtime Measurement) > NMX_Sampling_GetStatus_1

This function is used to read the current sampling status.

See also the HowTo-Guide.

 

Definition

---

NMX_STATUS NMX_Sampling_GetStatus_1(

 NMX_PHANDLE pHandle,

 unsigned char* pucStatus,

 unsigned long* pulNSamplingElements,

 unsigned long long* pudSamplesReceived,

 unsigned long long* pudMaxSamples);

 

Parameter

---

pHandle

Connection Handle.

pucStatus

Current sampling status. See definition below.

pulNSamplingElements

Number of sampling elements used.

pudSamplesReceived

Provide the number of samples, which have been received by the DLL from the device.

pudMaxSamples

Provide the maximum number of samples, that will be recorded.
If you started endless sampling, this value will be 0xFFFFFFFFFFFFFFFF = 18446744073709551615.

 

Typical function call (C example)

---

Assuming aslSamples is defined as: signed long aslSamples[64];

NMX_Sampling_ReadRow32_1(pHandle, aslSamples, 64, &ulSamplesCopied, &udNoSample);

 

Sampling Status

---

The sampling status is defined as follows:

By definition, all values > 0xF0 are error states.

 

.Net DLL specific implementation

---

NMX_MSTATUS Sampling_GetStatus_1(

                 System::IntPtr pHandle,

                 System::Byte %pucStatus,

                 System::UInt32 %pulNSamplingElements,

                 System::UInt64 %pudSamplesReceived,

                 System::UInt64 %pudMaxSamples);

 

Comments

---

It is possible to get informed about various sampling events via notfications.