AXUserIsProtected

Syntax

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

BOOL AXUserIsProtected(void);

Parameters

None.

Return Values

Returns TRUE if a user-level protection state has been asserted from within one or more threads. Returns FALSE if no protections are asserted.

Description

Determines if the general purpose user-level protection state has been asserted for audio-related global data.

If TRUE, then callback functions should consider the relevant global data as protected and ignore it until the next frame.

This function is useful for protecting global data that is accessed by threads and the AX user callback. It is the responsibility of the audio programmer to determine what data to protect using this mechanism.

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
AXVoiceIsProtected

Revision History

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


CONFIDENTIAL