GetCodeMessage Method

Gets the error string that corresponds to a specific WiaExceptionCode.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public static string GetCodeMessage( 
   WiaExceptionCode code
)

'Declaration
 
Public Shared Function GetCodeMessage( _
   ByVal code As WiaExceptionCode _
) As String

'Usage
 
Dim code As WiaExceptionCode
Dim value As String
 
value = WiaException.GetCodeMessage(code)

public static string GetCodeMessage( 
   WiaExceptionCode code
)

 function Leadtools.Wia.WiaException.GetCodeMessage( 
   code 
)

public:
static String^ GetCodeMessage( 
   WiaExceptionCode code
)

Parameters

code: A WiaExceptionCode value for which the corresponding error string is being sought.

Return Value

A System.String that contains the current message for code.

Remarks

By default, WiaException has a string message for each WiaExceptionCode. You can get this message by calling this method. Moreover, you can change any string message for any WiaExceptionCode by using the SetCodeMessage method.

Example

For an example, refer to SetCodeMessage.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

WiaException Class
WiaException Members