GetErrorDescription Method

C#
Visual Basic
Objective-C
Java
C++

public string GetErrorDescription( 
   int code
)

'Declaration

Public Function GetErrorDescription( _
   ByVal code As Integer _
) As String

'Usage

Dim instance As ErrorInformation
Dim code As Integer
Dim value As String
 
value = instance.GetErrorDescription(code)

public:
String^ GetErrorDescription( 
   int code
)

Parameters

code: HRESULT error code for which to get the error description.

If the method fails, an error is raised. For more information, refer to the Error Codes.

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.MediaStreaming

Public _server As Server = Nothing
Public _result As Boolean = False

Public Sub GetErrorDescriptionExample()
  Try
     ' this demonstration example will intentionally produce an error by changing the server's ip address to some invalid value,
     ' this is to demonstrate the use of ErrorInformation.GetErrorDescription

     ' create an instance of the server object
     _server = New Leadtools.MediaStreaming.Server()

     ' get network properties
     Dim Props As NetworkProperties = _server.GetNetworkProperties()

     ' change the IP address to some invalid value on the network
     ' for example "255.255.255.255", change it to an invalid value at your network.
     Props.IPAddress = "255.255.255.255"

     ' start the server
     _server.Start()

     _result = False
  Catch ex As System.Runtime.InteropServices.COMException
     Dim errinfo As ErrorInformation = New ErrorInformation()
     Dim strError As String = errinfo.GetErrorDescription(ex.ErrorCode)

     MessageBox.Show("Can't start the server." & Constants.vbLf & strError, "Error", MessageBoxButtons.OK, MessageBoxIcon.Error)

     _result = True
  End Try
End Sub

using Leadtools;
using Leadtools.MediaStreaming;

public Server _server = null;
public bool _result = false;

public void GetErrorDescriptionExample()
{
   try
   {
      // this demonstration example will intentionally produce an error by changing the server's ip address to some invalid value,
      // this is to demonstrate the use of ErrorInformation.GetErrorDescription

      // create an instance of the server object
      _server = new Leadtools.MediaStreaming.Server();

      // get network properties
      NetworkProperties Props = _server.GetNetworkProperties();

      // change the IP address to some invalid value on the network
      // for example "255.255.255.255", change it to an invalid value at your network.
      Props.IPAddress = "255.255.255.255";

      // start the server
      _server.Start();

      _result = false;
   }
   catch (System.Runtime.InteropServices.COMException ex)
   {
      ErrorInformation errinfo = new ErrorInformation();
      string strError = errinfo.GetErrorDescription(ex.ErrorCode);

      MessageBox.Show("Can't start the server.\n" + strError, "Error", MessageBoxButtons.OK, MessageBoxIcon.Error);

      _result = true;
   }
}

Target Platforms

Reference

ErrorInformation Class
ErrorInformation Members