NNS_SndPlayerReadVariable

Syntax

#include <nnsys/snd.h>
BOOL NNS_SndPlayerReadVariable(
        NNSSndHandle* handle,
        int varNo,
        s16* var );

Arguments

handle The sound handle pointer.
varNo The variable number. Takes a value between 0 and 15.
var The pointer to where the value of the variable is stored.

Return Values

Returns whether or not the read was successful.

Description

Reads the sequence local variables. If the read is successful, the variable values are written to the address that is assigned with var.

This function gets the sequence local variable value of the sequence that is bound to the sound handle handle. If the sound handle is invalid, the read fails and a FALSE will be returned.

See Also

None.

Revision History

2004/06/01 Initial version.


CONFIDENTIAL