Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2024.1.1.8691 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2024.1.1

◆ ReadElementString

const char*(* ak_wwise_plugin_host_xml_v1::ReadElementString) (struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_this)

Reads simple text-only elements, and increments the pointer.

Since strings can span multiple content elements, this method will read all the sequential string-like elements and append them, returning one simple string. This function also works with empty nodes and multiple lines.

If no processing or incrementing is warranted, Read, MoveToContent and GetValue should be used instead.

This method goes past the ending element node, or the equivalent of calling Read once more.

Note: The string is available until the next Host operation. If storing is required, a copy should be made at the earliest convenience.
Parameters
[in]in_thisCurrent reader instance of this interface.
Returns
The string of the current nodes, an empty string if the value is empty. The buffer is owned by Authoring and is valid until the next API call.

Definition at line 311 of file HostXml.h.

Referenced by AK.Wwise::Plugin::V1::XmlReader::ReadElementString().

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