nw::snd::WaveSoundHandle::ReadWaveSoundDataInfo Member Function

Syntax

#include <nw/snd/snd_WaveSoundHandle.h>
bool ReadWaveSoundDataInfo(
     WaveSoundDataInfo * info
) const;

Arguments

Name Description
out info The wave sound data information structure used to store results

Return Values

Returns TRUE if the wave sound data information is retrieved successfully; otherwise, returns FALSE.

Description

Obtains the wave sound data information.

Gets information about the wave sound data being played for the sound associated with handle. Returns false if the handle is invalid.

Returns false if the wave sound data information cannot be retrieved because the preparation for the wave sound system is not complete. IsPrepared can be used to get whether the preparation is complete.

See Also

WaveSoundDataInfo Structure
IsPrepared

Revision History

2010/01/22
Initial version.

CONFIDENTIAL