diff --git a/docs/sphinx/reference-properties.rst b/docs/sphinx/reference-properties.rst index e0fc69f8b..ff311c494 100644 --- a/docs/sphinx/reference-properties.rst +++ b/docs/sphinx/reference-properties.rst @@ -664,6 +664,8 @@ Property Modification Functions :param val: The actual string value stored and will be returned by :c:func:`obs_data_get_string` :returns: The index of the list item. + `Note` : If ``p`` is of type OBS_COMBO_TYPE_EDITABLE, :c:func:`obs_data_get_string` will return ``name`` instead of ``val``. + --------------------- .. function:: size_t obs_property_list_add_int(obs_property_t *p, const char *name, long long val) @@ -694,6 +696,8 @@ Property Modification Functions :param name: Localized name shown to user :param val: The actual string value stored and will be returned by :c:func:`obs_data_get_string` + `Note` : If ``p`` is of type OBS_COMBO_TYPE_EDITABLE, :c:func:`obs_data_get_string` will return ``name`` instead of ``val``. + --------------------- .. function:: void obs_property_list_insert_int(obs_property_t *p, size_t idx, const char *name, long long val) diff --git a/docs/sphinx/reference-settings.rst b/docs/sphinx/reference-settings.rst index fc881efde..b3d699797 100644 --- a/docs/sphinx/reference-settings.rst +++ b/docs/sphinx/reference-settings.rst @@ -164,6 +164,8 @@ Get Functions .. function:: const char *obs_data_get_string(obs_data_t *data, const char *name) + `Note` : If the data object was generated from a OBS_COMBO_TYPE_EDITABLE property, the property's ``name`` will be returned instead of its ``val``. + --------------------- .. function:: long long obs_data_get_int(obs_data_t *data, const char *name)