[pulseaudio-commits] [Git][pulseaudio/pulseaudio][master] proplist: tweak documentation for `pa_proplist_get()`

[PulseAudio Marge Bot]

PulseAudio Marge Bot pushed to branch master at PulseAudio / pulseaudio


Commits:
651e0db0 by Lyndon Brown at 2021-04-09T01:47:58+01:00
proplist: tweak documentation for `pa_proplist_get()`

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>

- - - - -


1 changed file:

- src/pulse/proplist.h


Changes:

=====================================
src/pulse/proplist.h
=====================================
@@ -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);
 



View it on GitLab: https://gitlab.freedesktop.org/pulseaudio/pulseaudio/-/commit/651e0db07bf89ae9cf0e73b0e8b4fe9674c54962

-- 
View it on GitLab: https://gitlab.freedesktop.org/pulseaudio/pulseaudio/-/commit/651e0db07bf89ae9cf0e73b0e8b4fe9674c54962
You're receiving this email because of your account on gitlab.freedesktop.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/pulseaudio-commits/attachments/20210412/f8d0da0a/attachment.htm>