In This Topic ▼

SetCodeMessage Method

Summary

Sets the error string that corresponds to the specified WiaExceptionCode.

Syntax

C++

public static void SetCodeMessage( 
   WiaExceptionCode code, 
   string message 
)

  
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

using Leadtools; 
using Leadtools.Wia; 
 
public void SetCodeMessageExample() 
{ 
   // Get the initial FileFormat message 
   WiaExceptionCode code = WiaExceptionCode.PaperEmpty; 
   string message = WiaException.GetCodeMessage(code); 
   MessageBox.Show(string.Format("Code: {0}, message: {1}", code, message)); 
 
   // make sure that this message is used now 
   try 
   { 
      throw new WiaException(code); 
   } 
   catch (Exception ex) 
   { 
      MessageBox.Show(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) 
   { 
      MessageBox.Show(ex.Message); 
   } 
}

Imports Leadtools 
Imports Leadtools.Wia 
 
Public Sub SetCodeMessageExample() 
   ' Get the initial FileFormat message 
   Dim code As WiaExceptionCode = WiaExceptionCode.PaperEmpty 
   Dim message As String = WiaException.GetCodeMessage(code) 
   MessageBox.Show(String.Format("Code: {0}, message: {1}", code, message)) 
 
   ' make sure that this message is used now 
   Try 
      Throw New WiaException(code) 
   Catch ex As Exception 
      MessageBox.Show(ex.Message) 
   End Try 
 
   ' 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 ex As Exception 
      MessageBox.Show(ex.Message) 
   End Try 
End Sub

Requirements

Target Platforms

Reference

WiaException Class

WiaException Members

Download our FREE evaluation

Help Version 20.0.2020.3.31

Leadtools.Wia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Wia Namespace

Assemblies