nw::snd::SoundArchive::GetItemId Member Function

Syntax

#include <nw/snd/snd_SoundArchive.h>

ItemId GetItemId(
     const char * pLabel
) const;

Arguments

Name Description
in pLabel Label character string.

Return Values

Returns the item ID that corresponds to the specified label string.

Description

Converts a label string into its corresponding item ID.

This returns INVALID_ID if the specified label string 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.

See Also

GetItemLabel
RomSoundArchive::LoadLabelStringData

Revision History

2010/06/25
Added information about the sound archive string table.
2010/01/15
Initial version.

CONFIDENTIAL