Version
menu_open

◆ DisplayNameForProp

bool(* ak_wwise_plugin_property_display_name_v1::DisplayNameForProp) (const struct ak_wwise_plugin_property_display_name_instance_v1 *in_this, const char *in_pszPropertyName, char *out_pszDisplayName, uint32_t in_unCharCount)

Gets the user-friendly name of the specified property.

This function should write the user-friendly name of the specified property to the char buffer out_pszDisplayName, which is of maximum length in_unCharCount.

Note: This function used to be deprecated, but is actually useful in case of dynamic naming. As such, it has been reinstated. However, its usage is still not preferred. By default, you should provide your naming inside the XML, and use this function only in cases where you cannot reliably name the property in your XML. For example, you might have a switch between two modes, and the same property might have two different names. This function can then be used for this particular case.
Parameters
[in]in_thisCurrent instance of this interface.
[in]in_pszPropertyNameThe internal name of the property.
[out]out_pszDisplayNameThe returned user-friendly name, as a null-terminated string.
[in]in_unCharCountThe maximum number of char in the buffer, including the terminating null.
Returns
true if the property has a user-friendly name.

Definition at line 79 of file PropertyDisplayName.h.

Referenced by AK.Wwise::Plugin::V1::PropertyDisplayName::Interface::Interface().

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