DataDirect XML Converters 5.0 Send comments on this topic.
Cancel(Exception) Method
See Also 
DDTek.XmlConverter Namespace > Conversion Class > Cancel Method : Cancel(Exception) Method




e
The exception which will be thrown to the data source and data consumer.
Attempt to cancel a Conversion.

Syntax

Visual Basic (Declaration) 
Public Overloads MustOverride Sub Cancel( _
   ByVal e As Exception _
) 
Visual Basic (Usage)Copy Code
Dim instance As Conversion
Dim e As Exception
 
instance.Cancel(e)
C# 
public abstract void Cancel( 
   Exception e
)
Managed Extensions for C++ 
public: abstract void Cancel( 
   Exception* e
) 
C++/CLI 
public:
abstract void Cancel( 
   Exception^ e
) 

Parameters

e
The exception which will be thrown to the data source and data consumer.

Remarks

If the conversion has already finished, failed or been cancelled, this call has no effect. Otherwise, this cancels the conversion and releases system resources such as open file handles.

This method is useful if the conversion source is an OutputStreamSource, TextWriterSource or an XmlWriterSource and the application cannot or does not want to close the source normally. In this case, the application should call Cancel to make sure system resources are released.

This method is also useful if the conversion result is an InputStreamResult, TextReaderResult or XmlReaderResult and the application does not want to consume then entire result. In this case, the application should call Cancel() to release system resources.

In addition to cancelling the Conversion, this method attempts to throw its parameter Exception to the conversion data source and conversion data consumer.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2009 All Rights Reserved.