WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsICancelable

IID:d94ac0a0-bb18-46b8-844e-84159064b0bd
Inherits From:nsISupports
Status:UNDER_REVIEW

This interface provides a means to cancel an operation that is in progress.


Methods

void cancel ( nsresult reason )

void cancel ( nsresult reason )

Call this method to request that this object abort whatever operation it may be performing.

Arguments:
reason: Pass a failure code to indicate the reason why this operation is being canceled. It is an error to pass a success code.

References

This interface is the type of the following properties:

nsIDownload.cancelable

This interface is passed as an argument to the following methods:

nsIDNSListener.onLookupComplete, nsIDownloadManager.addDownload, nsIProtocolProxyCallback.onProxyAvailable, nsITransfer.init

This interface is returned from the following methods:

nsIAuthPrompt2.asyncPromptAuth, nsIDNSService.asyncResolve, nsIPromptService2.asyncPromptAuth, nsIProtocolProxyService.asyncResolve

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com