Version

menu_open

◆ GetValueString

bool(* ak_wwise_plugin_host_property_set_v1::GetValueString) (const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, const char **out_propertyValue)

Retrieves the string value of a specific property.

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] in_this Current instance of this interface.
[in] in_guidPlatform The unique ID of the queried platform.
[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
[out] out_propertyValue The returned value of the property. The buffer is owned by Authoring and is valid until the next API call.
Returns
true if successful.

Definition at line 732 of file HostPropertySet.h.

Referenced by 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