Version

menu_open
Wwise SDK 2019.2.15

◆ WriteUtf16String()

virtual bool AK.Wwise::IWriteData::WriteUtf16String ( const wchar_t *  in_szString )
pure virtual

Writes a null-terminated utf-16 string (characters are 2 bytes wide). Handles endianness according to destination platform.

Note: "String" properties (as defined in the plugin's XML Description File - refer to Wwise Plug-in XML Description Files for more details) are utf-16 encoded. While you are free to store this string in soundbanks as as an ansi string (using WritePascalString()), AK::IAkPluginParam::SetParam() will be passed an utf-16 string when you connect the authoring tool to the sound engine. Thus, WriteUtf16String() is the preferred method for sending strings to a plug-in.
Returns
True if successful, False otherwise
Parameters
in_szString The string to be written (null-terminated).

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise