Intravision/reactos
1
0
Fork 0
mirror of https://github.com/reactos/reactos.git synced 2025-02-22 16:36:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

[CONUTILS] Update some documentation.

Browse source
This commit is contained in:
Hermès Bélusca-Maïto 2021-05-25 23:34:01 +02:00
parent 831cad3410
commit f268430c05
No known key found for this signature in database
GPG key ID: 3B2539C65E7B93D0
2 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
sdk/lib/conutils/outstream.c
View file

@ -831,7 +831,7 @@ ConResPrintf(
* Similarly to ConPuts(), no terminating new-line character is appended. * Similarly to ConPuts(), no terminating new-line character is appended.
* *
* @see ConPuts(), ConResPuts() and associated functions, * @see ConPuts(), ConResPuts() and associated functions,
* <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms679351(v=vs.85).aspx">FormatMessage() (on MSDN)</a> * <a href="https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-formatmessage">FormatMessage() (on MSDN)</a>
**/ **/
INT INT
ConMsgPuts( ConMsgPuts(
@ -846,7 +846,7 @@ ConMsgPuts(
LPWSTR lpMsgBuf = NULL; LPWSTR lpMsgBuf = NULL;
/* /*
* Sanitize dwFlags. This version always ignore explicitely the inserts * Sanitize dwFlags. This version always ignores explicitly the inserts
* as we emulate the behaviour of the (f)puts function. * as we emulate the behaviour of the (f)puts function.
*/ */
dwFlags |= FORMAT_MESSAGE_ALLOCATE_BUFFER; // Always allocate an internal buffer. dwFlags |= FORMAT_MESSAGE_ALLOCATE_BUFFER; // Always allocate an internal buffer.
@ -919,7 +919,7 @@ ConMsgPrintf2V(
LPWSTR lpMsgBuf = NULL; LPWSTR lpMsgBuf = NULL;
/* /*
* Sanitize dwFlags. This version always ignore explicitely the inserts. * Sanitize dwFlags. This version always ignores explicitly the inserts.
* The string that we will return to the user will not be pre-formatted. * The string that we will return to the user will not be pre-formatted.
*/ */
dwFlags |= FORMAT_MESSAGE_ALLOCATE_BUFFER; // Always allocate an internal buffer. dwFlags |= FORMAT_MESSAGE_ALLOCATE_BUFFER; // Always allocate an internal buffer.
@ -1024,7 +1024,7 @@ ConMsgPrintf2V(
* Numbers of characters successfully written to @p Stream. * Numbers of characters successfully written to @p Stream.
* *
* @see ConPrintf(), ConResPrintf() and associated functions, ConMsgPrintf(), * @see ConPrintf(), ConResPrintf() and associated functions, ConMsgPrintf(),
* <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms679351(v=vs.85).aspx">FormatMessage() (on MSDN)</a> * <a href="https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-formatmessage">FormatMessage() (on MSDN)</a>
**/ **/
INT INT
ConMsgPrintfV( ConMsgPrintfV(
@ -1123,7 +1123,7 @@ ConMsgPrintfV(
* Numbers of characters successfully written to @p Stream. * Numbers of characters successfully written to @p Stream.
* *
* @see ConPrintf(), ConResPrintf() and associated functions, ConMsgPrintfV(), * @see ConPrintf(), ConResPrintf() and associated functions, ConMsgPrintfV(),
* <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms679351(v=vs.85).aspx">FormatMessage() (on MSDN)</a> * <a href="https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-formatmessage">FormatMessage() (on MSDN)</a>
**/ **/
INT INT
__cdecl __cdecl
@ -1212,7 +1212,7 @@ ConMsgPrintf(
* Numbers of characters successfully written to @p Stream. * Numbers of characters successfully written to @p Stream.
* *
* @see ConPrintf(), ConResPrintf() and associated functions, ConMsgPrintf(), * @see ConPrintf(), ConResPrintf() and associated functions, ConMsgPrintf(),
* <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms679351(v=vs.85).aspx">FormatMessage() (on MSDN)</a> * <a href="https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-formatmessage">FormatMessage() (on MSDN)</a>
**/ **/
INT INT
ConResMsgPrintfExV( ConResMsgPrintfExV(
@ -1323,7 +1323,7 @@ ConResMsgPrintfExV(
* Numbers of characters successfully written to @p Stream. * Numbers of characters successfully written to @p Stream.
* *
* @see ConPrintf(), ConResPrintf() and associated functions, ConMsgPrintf(), * @see ConPrintf(), ConResPrintf() and associated functions, ConMsgPrintf(),
* <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms679351(v=vs.85).aspx">FormatMessage() (on MSDN)</a> * <a href="https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-formatmessage">FormatMessage() (on MSDN)</a>
**/ **/
INT INT
ConResMsgPrintfV( ConResMsgPrintfV(
@ -1387,7 +1387,7 @@ ConResMsgPrintfV(
* Numbers of characters successfully written to @p Stream. * Numbers of characters successfully written to @p Stream.
* *
* @see ConPrintf(), ConResPrintf() and associated functions, ConMsgPrintf(), * @see ConPrintf(), ConResPrintf() and associated functions, ConMsgPrintf(),
* <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms679351(v=vs.85).aspx">FormatMessage() (on MSDN)</a> * <a href="https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-formatmessage">FormatMessage() (on MSDN)</a>
**/ **/
INT INT
__cdecl __cdecl
@ -1454,7 +1454,7 @@ ConResMsgPrintfEx(
* Numbers of characters successfully written to @p Stream. * Numbers of characters successfully written to @p Stream.
* *
* @see ConPrintf(), ConResPrintf() and associated functions, ConMsgPrintf(), * @see ConPrintf(), ConResPrintf() and associated functions, ConMsgPrintf(),
* <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms679351(v=vs.85).aspx">FormatMessage() (on MSDN)</a> * <a href="https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-formatmessage">FormatMessage() (on MSDN)</a>
**/ **/
INT INT
__cdecl __cdecl

4
sdk/lib/conutils/utils.c
View file

@ -247,7 +247,7 @@ K32LoadStringW(
* crash if a malformed source string is retrieved and then being used * crash if a malformed source string is retrieved and then being used
* for formatting. It basically wraps calls to FormatMessage() within SEH. * for formatting. It basically wraps calls to FormatMessage() within SEH.
* *
* @see <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms679351(v=vs.85).aspx">FormatMessage() (on MSDN)</a> * @see <a href="https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-formatmessage">FormatMessage() (on MSDN)</a>
**/ **/
DWORD DWORD
WINAPI WINAPI
@ -290,7 +290,7 @@ FormatMessageSafeW(
* and we did not pass the flag FORMAT_MESSAGE_IGNORE_INSERTS, and the * and we did not pass the flag FORMAT_MESSAGE_IGNORE_INSERTS, and the
* message string expected too many inserts. * message string expected too many inserts.
* In this last case only, we can call again FormatMessage but ignore * In this last case only, we can call again FormatMessage but ignore
* explicitely the inserts. The string that we will return to the user * explicitly the inserts. The string that we will return to the user
* will not be pre-formatted. * will not be pre-formatted.
*/ */
if (((dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) || lpBuffer) && if (((dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) || lpBuffer) &&