Settings

Updated: October 26, 2022

Synopsis:

#include <aoi.h>

AOResource_t *Settings;

Description:

This field must point to a static array of AOResource_t structures that describe all of the configuration parameters that the addon recognizes, and their default values.

The type field in each array entry must be an AOR_TYPE_format constant where format is one of TOGGLE, LONG, LONGLONG, FLOAT, or STRING. No other types are supported.

For an AOR_TYPE_STRING setting, the value pointer should initially point to the first character of the default value. If the info pointer is not NULL, then the default value must be stored in a writable buffer, and info must point to an int32_t holding the size of the buffer. This size determines the maximum length of any new value. If info is NULL, there's no maximum length and the buffer holding the default value doesn't have to be writable, but the Settings array does.

For all other types, value must point to a static variable of the appropriate type (int32_t, int64_t, or float). For numeric types, info must either be NULL or point to a two-element array of the appropriate type, specifying the minimum and maximum allowed values for the setting.