mirror of
https://github.com/obsproject/obs-studio.git
synced 2024-09-19 20:32:15 +02:00
docs: Add precision on editable string lists
This commit is contained in:
parent
c81f531edb
commit
09e0b7139a
@ -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)
|
||||
|
@ -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)
|
||||
|
Loading…
Reference in New Issue
Block a user