Version
menu_open

◆ GetListName

unsigned int(* ak_wwise_plugin_host_object_store_v1::GetListName) (const struct ak_wwise_plugin_host_object_store_instance_v1 *in_this, unsigned int in_uiListIndex, char *out_pszListName, unsigned int in_uiBufferSize)

Gets the name of the list at the specified position.

List ordering is arbitrary and can vary between Wwise Authoring versions or project loads.

Warning: If you do not provide a buffer big enough to write the full string, the function will fail and return 0. Make sure to use a buffer big enough to write the entire string, depending on your own naming convention.
Parameters
[in] in_this Current instance of this interface.
[in] in_uiListIndex Index of the list name to retrieve.
[out] out_pszListName Pointer to a buffer that will contain the list name.
[in] in_uiBufferSize Size of the provided buffer. If the buffer is not big enough for the entire name alongside a string ending suffix, the function will return 0 and no string will be copied.
Returns
Number of characters written to the buffer, zero if failed.

Definition at line 275 of file HostObjectStore.h.

Referenced by AK.Wwise::Plugin::V1::ObjectStore::GetListName().

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