GetCueSignal

Returns a signal mask for a cue.

Synopsis

int32 GetCueSignal (Item Cue)

Description

This function returns a signal mask containing the signal bit allocated for an audio Cue item. The mask can be passed to WaitSignal() so a task can enter wait state until a Cue completes.

Arguments

Cue: Item number of Cue.

Return Value

The function returns a signal mask (a positive value) if successful or a non-positive value (0 or an error code) if an error occurs.

Implementation

Folio call implemented in Audio folio V20.

Caveats

This function has always returned 0 when a bad item is passed in. It should probably have returned AF_ERR_BADITEM, but will continue to return 0 for this case.

Associated Files

audio.h