AXVoiceIsProtected

Syntax

#include <cafe.h>
#include <cafe/ax.h>

BOOL AXVoiceIsProtected(AXVPB *p);

Parameters

p Pointer to the voice that is to be tested for protection.

Return Values

Returns TRUE if protection has been asserted for this voice. Returns FALSE if no threads have asserted protection for this voice.

Description

Tests whether a voice has been protected by any thread. This function will return TRUE if AXVoiceBegin, or AXUserBegin and a corresponding AXSetVoice..., have asserted protection.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AX Programming Model Overview
AXUserBegin
AXUserEnd
AXUserIsProtected
AXVoiceBegin
AXVoiceEnd

Revision History

2013-05-08 Automated cleanup pass.
2011-03-02 Initial version.


CONFIDENTIAL