Class TiffErrorHandler

Default error handler implementation.

Inheritance

System.Object

TiffErrorHandler

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: BitMiracle.LibTiff.Classic

Assembly: BitMiracle.LibTiff.NET.dll

Syntax

public class TiffErrorHandler

Remarks

TiffErrorHandler provides error and warning handling methods that write an error or a warning messages to the System.Console.Error.

Applications that desire to capture control in the event of an error or a warning should set their custom error and warning handler using SetErrorHandler(TiffErrorHandler) method.

Methods

ErrorHandler(Tiff, String, String, Object[])

Handles an error by writing it text to the System.Console.Error.

Declaration

public virtual void ErrorHandler(Tiff tif, string method, string format, params object[] args)

Parameters

Type	Name	Description
Tiff	tif	An instance of the Tiff class. Can be null.
System.String	method	The method where an error is detected.
System.String	format	A composite format string (see Remarks).
System.Object[]	args	An object array that contains zero or more objects to format.

Remarks

The format is a composite format string that uses the same format as method. The method parameter, if not null, is printed before the message; it typically is used to identify the method in which an error is detected.

ErrorHandlerExt(Tiff, Object, String, String, Object[])

Handles an error by writing it text to the System.Console.Error.

Declaration

public virtual void ErrorHandlerExt(Tiff tif, object clientData, string method, string format, params object[] args)

Parameters

Type	Name	Description
Tiff	tif	An instance of the Tiff class. Can be null.
System.Object	clientData	A client data.
System.String	method	The method where an error is detected.
System.String	format	A composite format string (see Remarks).
System.Object[]	args	An object array that contains zero or more objects to format.

Remarks

The format is a composite format string that uses the same format as method. The method parameter, if not null, is printed before the message; it typically is used to identify the method in which an error is detected.

The clientData parameter can be anything. Its value and meaning is defined by an application and not the library.

WarningHandler(Tiff, String, String, Object[])

Handles a warning by writing it text to the System.Console.Error.

Declaration

public virtual void WarningHandler(Tiff tif, string method, string format, params object[] args)

Parameters

Type	Name	Description
Tiff	tif	An instance of the Tiff class. Can be null.
System.String	method	The method where a warning is detected.
System.String	format	A composite format string (see Remarks).
System.Object[]	args	An object array that contains zero or more objects to format.

Remarks

The format is a composite format string that uses the same format as method. The method parameter, if not null, is printed before the message; it typically is used to identify the method in which a warning is detected.

WarningHandlerExt(Tiff, Object, String, String, Object[])

Handles a warning by writing it text to the System.Console.Error.

Declaration

public virtual void WarningHandlerExt(Tiff tif, object clientData, string method, string format, params object[] args)

Parameters

Type	Name	Description
Tiff	tif	An instance of the Tiff class. Can be null.
System.Object	clientData	A client data.
System.String	method	The method where a warning is detected.
System.String	format	A composite format string (see Remarks).
System.Object[]	args	An object array that contains zero or more objects to format.

Remarks

The format is a composite format string that uses the same format as method. The method parameter, if not null, is printed before the message; it typically is used to identify the method in which a warning is detected.

The clientData parameter can be anything. Its value and meaning is defined by an application and not the library.