Version

menu_open
Wwise SDK 2021.1.14

◆ GetString()

const char* AK.Wwise::Plugin::V1::PropertySet::GetString ( const GUID in_guidPlatform,
const char *  in_pszPropertyName 
) const
inline

Retrieves the string value of a specific property and returns the value as a temporary pointer.

This is a convenience for GetValueString where the value is returned instead of being set in a provided variable.

The plug-in XML definition file should define this property as a string in order to use this method.

Note: The returned pointer is provided by Authoring, and contains a TLS copy of the property value string. It is guaranteed to be valid until the next Host function call. If you wish to retain this string, you should make a copy at the earliest convenience.
See also
Parameters
in_guidPlatform The unique ID of the queried platform.
in_pszPropertyName The name of the queried property, based on the XML definition file.
Returns
The value of the property.
Parameters
in_guidPlatform The unique ID of the queried platform
in_pszPropertyName The name of the property

Definition at line 2027 of file HostPropertySet.h.

References AKVERIFY, and AK.Wwise::Plugin::V1::PropertySet::GetValueString().


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