SetCodeMessage Method

C#
Visual Basic
Java
Objective-C
C++

public static void SetCodeMessage( 
   TwainExceptionCode code,
   string message
)

'Declaration

Public Shared Sub SetCodeMessage( _
   ByVal code As TwainExceptionCode, _
   ByVal message As String _
)

'Usage

Dim code As TwainExceptionCode
Dim message As String
 
TwainException.SetCodeMessage(code, message)

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.

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.

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

Copy Code

Imports Leadtools
Imports Leadtools.Twain

      
Public Sub SetCodeMessageExample()
   ' Get the initial FileFormat message
   Dim code As TwainExceptionCode = TwainExceptionCode.StopScan
   Dim message As String = 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 ex As Exception
      MessageBox.Show(ex.Message)
   End Try

   ' 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 ex As Exception
      MessageBox.Show(ex.Message)
   End Try
End Sub

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);
   }
}

Target Platforms

Reference

TwainException Class
TwainException Members