SetCodeMessage Method

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

Parameters

code
A TwainExceptionCode value to set the string message for.

message
A String that contains the new message for code.

Remarks

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

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

Target Platforms

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

Leadtools.Twain Assembly

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