nw::snd::RomSoundArchive::LoadLabelStringData Member Function

#include <nw/snd/snd_RomSoundArchive.h>

bool LoadLabelStringData(
     void         *buffer,
     unsigned long size
);

	Name	Description
out	buffer	Pointer to the buffer used to load label strings.
in	size	The buffer size.

Returns true if the label string loaded successfully and false otherwise.

Loads the label string data in the sound archive.

Label string data must be loaded beforehand to access resources included in the sound archive by their label strings.

You can use GetLabelStringDataSize to get the amount of memory required to load the label string data.

Fails if the sound archive file (.bcsar) does not include a string table. If this happens, confirm under SoundMaker that the [Project Settings][Sound Archive] tab - [Output the string table] checkbox has been selected.

Open

2010/06/25

Added information about the sound archive string table.

2010/01/15

Initial version.