Unit 'Exec' Package
[Overview][Constants][Types][Procedures and functions][Variables][Index] [#aros]

AbortIO

Attempt to abort an in-progress I/O request

Declaration

Source position: exec.pas line 1291

function AbortIO(

  IORequest: PIORequest

):LongInt;

Arguments

IORequest

  

Pointer to an I/O request block (must have been used at least once. May be active or finished).

Function result

0 if the I/O Request is aborted

Description

Ask a device to abort a previously started IORequest. This is done by calling the device's ABORTIO vector, with your given IORequest.

AbortIO() is a command the device that may or may not grant. If successful, the device will stop processing the IORequest, and reply to it earlier than it would otherwise have done.

NOTE:

AbortIO() does NOT Remove() the IORequest from your ReplyPort, OR wait for it to complete. After an AbortIO() you must wait normally for the reply message before actually reusing the request.

If a request has already completed when AbortIO() is called, no action is taken.

Snippet

AbortIO(timer_request);
WaitIO(timer_request);
// Message is free to be reused

See also

SendIO

  

Initiate an I/O command

WaitIO

  

Wait for completion of an I/O request

DoIO

  

Perform an I/O request and wait for its finish


Documentation generated on: 2021-07-30