In This Topic ▼

SetCodeMessage Method

Summary

Sets the error string that corresponds to a specific TwainExceptionCode

Syntax

C++

public static void SetCodeMessage( 
   TwainExceptionCode code, 
   string message 
)

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

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

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

Requirements

Target Platforms

Reference

TwainException Class

TwainException Members

Download our FREE evaluation

Help Version 21.0.2021.6.30

Leadtools.Twain Assembly

Introduction

Getting Started

Namespaces

Leadtools.Twain Namespace

Assemblies