From: Daniel Stenberg <daniel@haxx.se>
Date: Sun, 20 Oct 2024 20:34:10 +0000 (+0200)
Subject: curl_ws_recv.md: the 'meta' pointer is only returned on success
X-Git-Tag: curl-8_11_0~109
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=51724c43e33c7e759751735c5ab759b90f17deb1;p=thirdparty%2Fcurl.git

curl_ws_recv.md: the 'meta' pointer is only returned on success

Reported-by: Dylam De La Torre
Fixes #15340
Closes #15343
---

diff --git a/docs/libcurl/curl_ws_recv.md b/docs/libcurl/curl_ws_recv.md
index d5df8b3391..c13d74a5c6 100644
--- a/docs/libcurl/curl_ws_recv.md
+++ b/docs/libcurl/curl_ws_recv.md
@@ -37,12 +37,14 @@ Retrieves as much as possible of a received WebSocket data fragment into the
 number of bytes actually stored.
 
 If there is more fragment data to deliver than what fits in the provided
-*buffer*, libcurl returns a full buffer and the application needs to call
-this function again to continue draining the buffer.
-
-The *meta* pointer gets set to point to a *const struct curl_ws_frame*
-that contains information about the received data. See the
-curl_ws_meta(3) for details on that struct.
+*buffer*, libcurl returns a full buffer and the application needs to call this
+function again to continue draining the buffer.
+
+If the function call is successful, the *meta* pointer gets set to point to a
+*const struct curl_ws_frame* that contains information about the received
+data. That struct must not be freed and its contents must not be relied upon
+anymore once another WebSocket function is called. See the curl_ws_meta(3) for
+details on that struct.a
 
 # %PROTOCOLS%