Leadtools.Twain Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.8.31
SetCodeMessage Method
See Also  Example
Leadtools.Twain Namespace > TwainException Class : SetCodeMessage Method




code
A TwainExceptionCode value to set the string message for.
message
A String that contains the new message for code.
Sets the error string that corresponds to a specific TwainExceptionCode

Syntax

Visual Basic (Declaration) 
Public Shared Sub SetCodeMessage( _
   ByVal code As TwainExceptionCode, _
   ByVal message As String _
)
Visual Basic (Usage)Copy Code
Dim code As TwainExceptionCode
Dim message As String
 
TwainException.SetCodeMessage(code, message)
C# 
public static void SetCodeMessage( 
   TwainExceptionCode code,
   string message
)
Managed Extensions for C++ 
public: static void SetCodeMessage( 
   TwainExceptionCode code,
   string* message
)
C++/CLI 
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.

Example

Visual BasicCopy Code
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
C#Copy Code
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); 
   } 
}

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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also