SetCodeMessage Method

Summary
Sets the error string that corresponds to the specified WiaExceptionCode.
Syntax
C#
C++
public static void SetCodeMessage( 
   WiaExceptionCode code, 
   string message 
) 
vb[VB Syntax] 
  
Public Shared Sub SetCodeMessage( _ 
   ByVal _code_ As WiaExceptionCode, _ 
   ByVal _message_ As String _ 
) 
public: 
static void SetCodeMessage(  
   WiaExceptionCode code, 
   String^ message 
)  

Parameters

code
A WiaExceptionCode value for which the error string is being set.

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

Remarks

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

Example
C#
using Leadtools; 
using Leadtools.Wia; 
 
public void SetCodeMessageExample() 
{ 
   // Get the initial FileFormat message 
   WiaExceptionCode code = WiaExceptionCode.PaperEmpty; 
   string message = WiaException.GetCodeMessage(code); 
   Console.WriteLine(string.Format("Code: {0}, message: {1}", code, message)); 
 
   // make sure that this message is used now 
   try 
   { 
      throw new WiaException(code); 
   } 
   catch (Exception ex) 
   { 
      Console.WriteLine(ex.Message); 
   } 
 
   // change this message to a custom one 
   WiaException.SetCodeMessage(code, "My new message"); 
 
   // make sure that this new message is used now 
   try 
   { 
      throw new WiaException(code); 
   } 
   catch (Exception ex) 
   { 
      Console.WriteLine(ex.Message); 
   } 
} 
Requirements

Target Platforms

Help Version 22.0.2022.4.4
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Wia Assembly

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.