nw::snd::SoundArchive::GetItemLabel Member Function

#include <nw/snd/snd_SoundArchive.h>

const char * GetItemLabel(
     ItemId id
) const;

	Name	Description
in	id	Item ID in the sound archive.

Returns the label string that corresponds to the specified ID.

Gets the label string that corresponds to an item ID.

NULL is returned if the specified item ID does not exist.

Regardless of MemorySoundArchive and RomSoundArchive, a string table must be included in the sound archive file to use string information.

To include string information in a sound archive file, from the SoundMaker Projects menu select Project Settings, and then on the Sound Archive tab, select the "Ouput the string table" checkbox.

When using RomSoundArchive, label string data must be already loaded using RomSoundArchive::LoadLabelStringData. NULL is returned if string data is not loaded.

NULL is returned if MemorySoundArchive does not include a string table.

ItemId
GetItemId
RomSoundArchive::LoadLabelStringData

2010/09/21

Added the fact that null is returned if the ID does not exit or a label string is not included.

2010/06/25

Added information about the sound archive string table.

2010/01/15

Initial version.