Back to product page

StateText method


Returns text representation of the state.

Type

String.

Syntax

  • C#
  • C++
  • VB.NET
void devP2P.StateText(IntPtr Handle, int state, StringBuilder buffer);
The StateText(Handle,state,buffer) syntax has these parts:
HandleReference to the devP2P instance.
stateStates value.
bufferString buffer where state text will be stored.

static const char *StateText(States state);
The StateText(state) syntax has these parts:
stateStates value.
Return valueText representation of the state.

Sub P2P_StateText(ByVal Handle As IntPtr, ByVal state As Integer, ByVal buffer As StringBuilder)
The StateText(Handle,state,buffer) syntax has these parts:
HandleReference to the devP2P instance.
stateStates value.
bufferString buffer where state text will be stored.

Remarks

This method will return text representation of the state, in English. You can use it to show user-friendly information in your application. Usually you will use this method in StateChange event.

Platforms

Windows
Mac OSX
Linux
BSD