]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] gh-113437: Update documentation about PyUnicode_AsWideChar() function (GH...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 14 Feb 2024 10:24:54 +0000 (11:24 +0100)
committerGitHub <noreply@github.com>
Wed, 14 Feb 2024 10:24:54 +0000 (11:24 +0100)
(cherry picked from commit 5719aa23ab7f1c7a5f03309ca4044078a98e7b59)

Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
Doc/c-api/unicode.rst

index ffa2d131235f250c158bbecab11346a0123ccea9..2f0b0514144ede2c9abd3492f8adb4dcc163b5b9 100644 (file)
@@ -950,7 +950,12 @@ wchar_t Support
    Copy the Unicode object contents into the :c:type:`wchar_t` buffer *wstr*.  At most
    *size* :c:type:`wchar_t` characters are copied (excluding a possibly trailing
    null termination character).  Return the number of :c:type:`wchar_t` characters
-   copied or ``-1`` in case of an error.  Note that the resulting :c:expr:`wchar_t*`
+   copied or ``-1`` in case of an error.
+
+   When *wstr* is ``NULL``, instead return the *size* that would be required
+   to store all of *unicode* including a terminating null.
+
+   Note that the resulting :c:expr:`wchar_t*`
    string may or may not be null-terminated.  It is the responsibility of the caller
    to make sure that the :c:expr:`wchar_t*` string is null-terminated in case this is
    required by the application. Also, note that the :c:expr:`wchar_t*` string