NNS_SndPlayerWriteVariable

C Specification

#include <nnsys/snd.h>
BOOL NNS_SndPlayerWriteVariable(
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 value to be written to the variable.

Return Values

Returns whether or not writing was successful.

Description

Writes the sequence local variable.

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

Note

Immediately after calling this function, even if the same variable value is read with the NNS_SndPlayerReadVariable function, there is no guarantee that the written value will be readable.

See Also

NNS_SndPlayerReadVariable

Revision History

06/01/2004 Initial version.


CONFIDENTIAL