AbortTimerCue

Cancels a timer request enqueued with SignalAtTime().

Synopsis

Err AbortTimerCue (Item Cue)

Description

Cancels a timer request enqueued with SignalAtTime(). The signal associated with the cue will not be sent if the request is aborted before completion. Aborting a timer request after completion does nothing harmful. Aborting a cue that has not been posted as a timer request is harmless.

Arguments

Cue: Cue item to abort. The task calling this function must own the Cue. The Cue may have already completed - nothing bad will happen.

Return Value

The function returns a non-negative value if successful or an error code (a negative value) if an error occurs.

Implementation

SWI implemented in Audio folio V21.

Associated Files

audio.h