mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-10-29 05:40:23 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

proplist: tweak documentation for pa_proplist_get()

Browse source 
to clarify that only mutating proplist calls potentially invalidate results
of earlier get requests, thus addressing the confusion found at [1].

[1]: https://github.com/jnqnfe/pulse-binding-rust/issues/38

Part-of: <https://gitlab.freedesktop.org/pulseaudio/pulseaudio/-/merge_requests/536>
This commit is contained in:
Lyndon Brown 2021-04-09 01:47:58 +01:00
parent 1a194c9918
commit 651e0db07b
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
src/pulse/proplist.h
View file

@ -322,7 +322,8 @@ const char *pa_proplist_gets(const pa_proplist *p, const char *key);
/** Store the value for the specified key in \a data. Will store a
* NUL-terminated string for string entries. The \a data pointer returned will
* point to an internally allocated buffer. The caller should make a
* copy of the data before the property list is accessed again.
* copy of the data before any subsequent modification or destruction
* of the property list.
* Returns zero on success, negative on error. \since 0.9.11 */
int pa_proplist_get(const pa_proplist *p, const char *key, const void **data, size_t *nbytes);