ConnectionErrorMessage Property (IIbmTerminal)

In This Topic

Gets the text string that describes the cause of the most recent connection failure (when the last returned error has the value ErrConnectionError).

Syntax

Visual Basic
C#

'Declaration
 
ReadOnly Property ConnectionErrorMessage As String

'Usage
 
Dim instance As IIbmTerminal
Dim value As String
 
value = instance.ConnectionErrorMessage

string ConnectionErrorMessage {get;}

Remarks

If no connection failure occurred, this property returns an empty string. The connection error message strings are stored internally in the connection library module of Reflection and cannot be changed. Use this property to retrieve information only when the last returned error equals ErrConnectionError. If you use ConnectionErrorMessage for errors other than ErrConnectionError, you will be retrieving information that is not valid for the current error condition.

Reference

IIbmTerminal Interface
IIbmTerminal Members

Send Feedback