<< Click to Display Table of Contents >> Navigation:  NmxDLL Reference Guide > API (programming interface) > Diagnostics > NMX_DiagGetEventText_1

This function provides a textual description of an event. It could for example be used to display the event description instead or together with an event number.

 

Definition

---

NMX_STATUS NMX_DiagGetEventText_1(

 NMX_PHANDLE pHandle,

 unsigned char ucEventNo,

 char* pcText, unsigned long ulSizeofText);

 

Parameter

---

pHandle

Connection Handle.

ucEventNo

Number of the event.

pcText

ASCII based string with event description. The maximum string length is 129 characters (128 + Termination).

ulSizeofText

Maximum size of pcText in Bytes/Characters.

 

Typical function call (C example)

---

NMX_DiagGetEventText_1(pHandle, 15, acText, sizeof(acText));

 

.Net DLL specific implementation

---

NMX_MSTATUS DiagGetEventText_1(

                 System::IntPtr pHandle,

                 System::Byte ucEventNo,

                 System::String ^%strText);

 

No Length/Sizeof-Parameter is required for the string strText, since this information is not required in a .Net environment. It is directly returned as Unicode-strings. Hence no additional conversion is required.

 

Comments

---