Carbon


URLAbort

Header: URLAccess.h Carbon status: Supported

Terminates a data transfer operation.

OSStatus URLAbort (
    URLReference urlRef
);
Parameter descriptions
urlRef

A reference to the URL whose data transfer operation you wish to terminate.

function result

A result code.

DISCUSSION

The URLAbort function terminates any data transfer operation started by the functions URLSimpleDownload, URLDownload, URLSimpleUpload, URLUpload, or URLOpen. When your application calls URLAbort, the URL Access Manager changes the state returned by the function URLGetCurrentState to kURLAbortingState and passes the constant kURLAbortInitiatedEvent to your notification callback function. When data transfer is terminated, the URL Access Manager changes the state returned by URLGetCurrentState to kURLCompletedState and passes the constant kURLCompletedEvent in the event parameter of your notification callback function.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 7/17/2000)