a1200   NEWS   APPS   DOCS   ABOUT
a1200
----
a1200
----
Autodocs
 Devices:
 audio.device
  ADCMD_ALLOCATE
  ADCMD_FINISH
  ADCMD_FREE
  ADCMD_LOCK
  ADCMD_PERVOL
  ADCMD_SETPREC
  ADCMD_WAITCYCLE
  AbortIO
  BeginIO
  CMD_CLEAR
  CMD_FLUSH
  CMD_READ
  CMD_RESET
  CMD_START
  CMD_STOP
  CMD_UPDATE
  CMD_WRITE
  CloseDevice
  Expunge
  OpenDevice
Include
GuruMeditation
Docs » Autodocs » audio.device » CMD_FLUSH

NAME

       CMD_FLUSH -- cancel all pending I/O

FUNCTION

       CMD_FLUSH is a standard command for multiple audio channels.  For each
selected channel (io_Unit), if the allocation key (ioa_AllocKey) is
correct, CMD_FLUSH aborts all writes (CMD_WRITE) in progress or queued
and any I/O requests waiting to synchronize with the end of the cycle
(ADCMD_WAITCYCLE); otherwise, CMD_FLUSH returns an error
(ADIOERR_NOALLOCATION). CMD_FLUSH is synchronous and only replies
(mn_ReplyPort) if the quick flag (IOF_QUICK) is clear. Do not use
CMD_FLUSH in interrupt code at interrupt level 5 or higher.

INPUTS

       mn_ReplyPort- pointer to message port that receives I/O request
if the quick flag (IOF_QUICK) is clear
io_Device - pointer to device node, must be set by (or copied from
I/O block set by) OpenDevice function
io_Unit - bit map of channels to flush (bits 0 thru 3 correspond
to channels 0 thru 3)
io_Command - command number for CMD_FLUSH
io_Flags - flags, must be cleared if not used:
IOF_QUICK - (CLEAR) reply I/O request
ioa_AllocKey- allocation key, must be set by (or copied from I/O block
set by) OpenDevice function or ADCMD_ALLOCATE command

RESULT

       io_Unit     - bit map of channels successfully flushed (bits 0 thru 3
correspond to channels 0 thru 3)
io_Error - error number:
0 - no error
ADIOERR_NOALLOCATION - allocation key (ioa_AllocKey)
does not match key for channel

Comments

Name:
E-mail: Use this if you want a message if you get a response, will not be shown.
Comment:
Select correct short for:

Scoopex

SCX
AFL
RBS
KEF

Comments:

$VER: d0.se 1.14 Copyright © 2011-2020 Tobias Geijersson support at d0 dot se