From c4972cb154cd60ce03f33808cc2218fc755a9a7c Mon Sep 17 00:00:00 2001 From: Henrik Enquist Date: Wed, 7 Jul 2021 21:10:16 +0200 Subject: [PATCH] pcm: add a note about return values of snd_pcm_state() Fixes: https://github.com/alsa-project/alsa-lib/pull/162 Signed-off-by: Henrik Enquist Signed-off-by: Jaroslav Kysela --- src/pcm/pcm.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c index 892abf98..9aec52d1 100644 --- a/src/pcm/pcm.c +++ b/src/pcm/pcm.c @@ -1059,6 +1059,10 @@ int snd_pcm_status(snd_pcm_t *pcm, snd_pcm_status_t *status) * This is a faster way to obtain only the PCM state without calling * \link ::snd_pcm_status() \endlink. * + * Note that this function always returns one of the + * #snd_pcm_state_t enum variants. + * It will never return a negative error code. + * * The function is thread-safe when built with the proper option. */ snd_pcm_state_t snd_pcm_state(snd_pcm_t *pcm) -- 2.47.3