Skip to content

Commit 907b401

Browse files
committed
Bulk Fix: CRT parameter styles
1 parent 9706f33 commit 907b401

File tree

471 files changed

+2065
-2069
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

471 files changed

+2065
-2069
lines changed

docs/c-runtime-library/cgets-cgetws.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ wchar_t *_cgetws(
4141

4242
#### Parameters
4343

44-
*buffer*<br/>
44+
*`buffer`*\
4545
Storage location for data.
4646

4747
## Return value

docs/c-runtime-library/crtlcmapstringw.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,24 +28,24 @@ int __crtLCMapStringW(
2828
2929
#### Parameters
3030
31-
*Locale*<br/>
31+
*Locale*\
3232
Locale identifier. The locale provides a context for the string mapping or sort key generation. An application can use the `MAKELCID` macro to create a locale identifier.
3333
34-
*dwMapFlags*<br/>
34+
*dwMapFlags*\
3535
The type of transformation to be used during string mapping or sort key generation.
3636
37-
*lpSrcStr*<br/>
37+
*lpSrcStr*\
3838
Pointer to a source string that the function maps or uses for sort key generation. This parameter is assumed to be a Unicode string.
3939
40-
*cchSrc*<br/>
40+
*cchSrc*\
4141
Size, in characters, of the string pointed to by the `lpSrcStr` parameter. This count can include the null terminator, or not include it.
4242
4343
A `cchSrc` value of -1 specifies that the string pointed to by `lpSrcStr` is null-terminated. If so, and this function is being used in its string-mapping mode, the function calculates the string's length itself, and null-terminates the mapped string stored into `*lpDestStr`.
4444
45-
*lpDestStr*<br/>
45+
*lpDestStr*\
4646
Long pointer to a buffer into which the function stores the mapped string or sort key.
4747
48-
*cchDest*<br/>
48+
*cchDest*\
4949
Size, in characters, of the buffer pointed to by `lpDestStr`.
5050
5151
## Return value

docs/c-runtime-library/cxxframehandler.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,16 @@ EXCEPTION_DISPOSITION __CxxFrameHandler(
2727
2828
#### Parameters
2929
30-
*pExcept*<br/>
30+
*pExcept*\
3131
Exception record that is passed to the possible **`catch`** statements.
3232
33-
*pRN*<br/>
33+
*pRN*\
3434
Dynamic information about the stack frame that is used to handle the exception. For more information, see ehdata.h.
3535
36-
*pContext*<br/>
36+
*pContext*\
3737
Context. (Not used on Intel processors.)
3838
39-
*pDC*<br/>
39+
*pDC*\
4040
Additional information about the function entry and stack frame.
4141
4242
## Return value

docs/c-runtime-library/dllonexit.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ _onexit_t __dllonexit( _onexit_t func,
2525

2626
#### Parameters
2727

28-
*`func`*<br/>
28+
*`func`*\
2929
Pointer to a function to be executed upon exit.
3030

31-
*`pbegin`*<br/>
31+
*`pbegin`*\
3232
Pointer to a variable that points to the beginning of a list of functions to execute on detach.
3333

34-
*`pend`*<br/>
34+
*`pend`*\
3535
Pointer to variable that points to the end of a list of functions to execute on detach.
3636

3737
## Return value

docs/c-runtime-library/except-handler3.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,16 @@ int _except_handler3(
2727

2828
#### Parameters
2929

30-
*exception_record*<br/>
30+
*`exception_record`*\
3131
[in] Information about the specific exception.
3232

33-
*registration*<br/>
33+
*`registration`*\
3434
[in] The record that indicates which scope table should be used to find the exception handler.
3535

36-
*context*<br/>
36+
*`context`*\
3737
[in] Reserved.
3838

39-
*dispatcher*<br/>
39+
*`dispatcher`*\
4040
[in] Reserved.
4141

4242
## Return value

docs/c-runtime-library/execute-onexit-table-initialize-onexit-table-register-onexit-function.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ int _execute_onexit_table(
3333

3434
#### Parameters
3535

36-
*table*<br/>
36+
*`table`*\
3737
[in, out] Pointer to the `onexit` function table.
3838

39-
*function*<br/>
39+
*`function`*\
4040
[in] Pointer to a function to add to the `onexit` function table.
4141

4242
## Return value

docs/c-runtime-library/getmainargs-wgetmainargs.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,35 +18,35 @@ Invokes command-line parsing and copies the arguments to `main()` back through t
1818

1919
```cpp
2020
int __getmainargs(
21-
int * _Argc,
22-
char *** _Argv,
23-
char *** _Env,
24-
int _DoWildCard,
25-
_startupinfo * _StartInfo);
21+
int * argc,
22+
char *** argv,
23+
char *** env,
24+
int doWildCard,
25+
_startupinfo * startInfo);
2626

2727
int __wgetmainargs (
28-
int *_Argc,
29-
wchar_t ***_Argv,
30-
wchar_t ***_Env,
31-
int _DoWildCard,
32-
_startupinfo * _StartInfo)
28+
int *argc,
29+
wchar_t ***argv,
30+
wchar_t ***env,
31+
int doWildCard,
32+
_startupinfo * startInfo)
3333
```
3434
3535
#### Parameters
3636
37-
`_Argc`<br/>
37+
*`argc`*\
3838
An integer that contains the number of arguments that follow in `argv`. The `argc` parameter is always greater than or equal to 1.
3939
40-
`_Argv`<br/>
40+
*`argv`*\
4141
An array of null-terminated strings representing command-line arguments entered by the user of the program. By convention, `argv[0]` is the command with which the program is invoked, argv[1] is the first command-line argument, and so on, until argv[argc], which is always **NULL**. The first command-line argument is always `argv[1]` and the last one is `argv[argc - 1]`.
4242
43-
`_Env`<br/>
43+
*`env`*\
4444
An array of strings that represent the variables set in the user's environment. This array is terminated by a **NULL** entry.
4545
46-
`_DoWildCard`<br/>
46+
*`doWildCard`*\
4747
An integer that if set to 1 expands the wildcards in the command line arguments, or if set to 0 does nothing.
4848
49-
`_StartInfo`<br/>
49+
*`startInfo`*\
5050
Other information to be passed to the CRT DLL.
5151
5252
## Return value

docs/c-runtime-library/heapadd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ int _heapadd(
2828

2929
#### Parameters
3030

31-
*`memblock`*<br/>
31+
*`memblock`*\
3232
Pointer to the heap memory.
3333

34-
*`size`*<br/>
34+
*`size`*\
3535
Size of memory to add, in bytes.
3636

3737
## Return value

docs/c-runtime-library/heapset.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ int _heapset(
2727

2828
#### Parameters
2929

30-
*fill*<br/>
30+
*`fill`*\
3131
Fill character.
3232

3333
## Return value

docs/c-runtime-library/internal-set-app-type.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ void __set_app_type (
2424
2525
#### Parameters
2626
27-
*at*<br/>
27+
*`at`*\
2828
A value that indicates the application type. The possible values are:
2929
3030
|Value|Description|

docs/c-runtime-library/local-unwind2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ void _local_unwind2(
2525

2626
#### Parameters
2727

28-
*`xr`*<br/>
28+
*`xr`*\
2929
[in] A registration record that is associated with one scope table.
3030

31-
*`stop`*<br/>
31+
*`stop`*\
3232
[in] The lexical level that indicates where `_local_unwind2` should stop.
3333

3434
## Remarks

docs/c-runtime-library/locale-names-languages-and-country-region-strings.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ The *language*\[**\_**_country-region_\[__.__*code-page*]] form is stored in the
2323

2424
The *code-page* is the ANSI/OEM code page that's associated with the locale. The code page is determined for you when you specify a locale by language or by language and country/region alone. The special value `.ACP` specifies the ANSI code page for the country/region. The special value `.OCP` specifies the OEM code page for the country/region. For example, if you specify `"Greek_Greece.ACP"` as the locale, the locale is stored as `Greek_Greece.1253` (the ANSI code page for Greek), and if you specify `"Greek_Greece.OCP"` as the locale, it's stored as `Greek_Greece.737` (the OEM code page for Greek). For more information about code pages, see [Code pages](./code-pages.md). For a list of supported code pages on Windows, see [Code page identifiers](/windows/win32/Intl/code-page-identifiers).
2525

26-
If you use only the code page to specify the locale, the user's default language and country/region as reported by [GetUserDefaultLocaleName](/windows/win32/api/winnls/nf-winnls-getuserdefaultlocalename) are used. For example, if you specify `".1254"` (ANSI Turkish) as the locale for a user that's configured for English (United States), the locale that's stored is `English_United States.1254`. We don't recommend this form, because it could lead to inconsistent behavior.
26+
If you use only the code page to specify the locale, the user's default language and country/region as reported by [`GetUserDefaultLocaleName`](/windows/win32/api/winnls/nf-winnls-getuserdefaultlocalename) are used. For example, if you specify `".1254"` (ANSI Turkish) as the locale for a user that's configured for English (United States), the locale that's stored is `English_United States.1254`. We don't recommend this form, because it could lead to inconsistent behavior.
2727

28-
A *locale* argument value of `C` specifies the minimal ANSI conforming environment for C translation. The `C` locale assumes that every **`char`** data type is 1 byte and its value is always less than 256. If *locale* points to an empty string, the locale is the implementation-defined native environment.
28+
A *`locale`* argument value of `C` specifies the minimal ANSI conforming environment for C translation. The `C` locale assumes that every **`char`** data type is 1 byte and its value is always less than 256. If *`locale`* points to an empty string, the locale is the implementation-defined native environment.
2929

3030
You can specify all of the locale categories at the same time for the `setlocale` and `_wsetlocale` functions by using the `LC_ALL` category. The categories can all be set to the same locale, or you can set each category individually by using a locale argument that has this form:
3131

32-
> *LC-ALL-specifier* :: *locale*<br/>
33-
&nbsp;&nbsp;&nbsp;&nbsp;\| \[**LC_COLLATE=**_locale_]\[**;LC_CTYPE=**_locale_]\[**;LC_MONETARY=**_locale_]\[**;LC_NUMERIC=**_locale_]\[**;LC_TIME=**_locale_]
32+
> *`LC-ALL-specifier`* :: *`locale`*\
33+
&emsp;\| \[**`LC_COLLATE=`***`locale`*]\[**`;LC_CTYPE=`***`locale`*]\[**`;LC_MONETARY=`***`locale`*]\[**`;LC_NUMERIC=`***`locale`*]\[**`;LC_TIME=`***`locale`*]
3434

3535
You can specify multiple category types, separated by semicolons. Category types that aren't specified use the current locale setting. For example, this code snippet sets the current locale for all categories to `de-DE`, and then sets the categories `LC_MONETARY` to `en-GB` and `LC_TIME` to `es-ES`:
3636

docs/c-runtime-library/lock.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ void __cdecl _lock
2727

2828
#### Parameters
2929

30-
*`locknum`*<br/>
30+
*`locknum`*\
3131
[in] The identifier of the lock to acquire.
3232

3333
## Remarks

docs/c-runtime-library/reference/access-s-waccess-s.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ errno_t _waccess_s(
2929

3030
### Parameters
3131

32-
*path*<br/>
32+
*`path`*\
3333
File or directory path.
3434

35-
*mode*<br/>
35+
*`mode`*\
3636
Permission setting.
3737

3838
## Return value
@@ -49,7 +49,7 @@ For more information, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`
4949

5050
## Remarks
5151

52-
When used with files, the **_access_s** function determines whether the specified file exists and can be accessed as specified by the value of *mode*. When used with directories, **_access_s** determines only whether the specified directory exists. In Windows 2000 and later operating systems, all directories have read and write access.
52+
When used with files, the **_access_s** function determines whether the specified file exists and can be accessed as specified by the value of *`mode`*. When used with directories, **_access_s** determines only whether the specified directory exists. In Windows 2000 and later operating systems, all directories have read and write access.
5353

5454
|mode value|Checks file for|
5555
|----------------|---------------------|
@@ -60,9 +60,9 @@ When used with files, the **_access_s** function determines whether the specifie
6060

6161
Permission to read or write the file isn't enough to ensure the ability to open a file. For example, if a file is locked by another process, it might not be accessible even though **_access_s** returns 0.
6262

63-
**_waccess_s** is a wide-character version of **_access_s**, where the *path* argument to **_waccess_s** is a wide-character string. Otherwise, **_waccess_s** and **_access_s** behave identically.
63+
**_waccess_s** is a wide-character version of **_access_s**, where the *`path`* argument to **_waccess_s** is a wide-character string. Otherwise, **_waccess_s** and **_access_s** behave identically.
6464

65-
These functions validate their parameters. If *path* is NULL or *mode* doesn't specify a valid mode, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions set `errno` to `EINVAL` and return `EINVAL`.
65+
These functions validate their parameters. If *`path`* is NULL or *`mode`* doesn't specify a valid mode, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions set `errno` to `EINVAL` and return `EINVAL`.
6666

6767
By default, this function's global state is scoped to the application. To change this behavior, see [Global state in the CRT](../global-state.md).
6868

docs/c-runtime-library/reference/access-waccess.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ int _waccess(
2929

3030
### Parameters
3131

32-
*`path`*<br/>
32+
*`path`*\
3333
File or directory path.
3434

35-
*`mode`*<br/>
35+
*`mode`*\
3636
Read/write attribute.
3737

3838
## Return value

docs/c-runtime-library/reference/aligned-free-dbg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ void _aligned_free_dbg(
2424

2525
### Parameters
2626

27-
*`memblock`*<br/>
27+
*`memblock`*\
2828
A pointer to the memory block that was returned to the [`_aligned_malloc`](aligned-malloc.md) or [`_aligned_offset_malloc`](aligned-offset-malloc.md) function.
2929

3030
## Remarks

docs/c-runtime-library/reference/aligned-free.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ void _aligned_free (
2424

2525
### Parameters
2626

27-
*`memblock`*<br/>
27+
*`memblock`*\
2828
A pointer to the memory block that was returned to the `_aligned_malloc` or `_aligned_offset_malloc` function.
2929

3030
## Remarks

docs/c-runtime-library/reference/aligned-malloc-dbg.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,16 @@ void * _aligned_malloc_dbg(
2727

2828
### Parameters
2929

30-
*`size`*<br/>
30+
*`size`*\
3131
Size of the requested memory allocation.
3232

33-
*`alignment`*<br/>
33+
*`alignment`*\
3434
The alignment value, which must be an integer power of 2.
3535

36-
*`filename`*<br/>
36+
*`filename`*\
3737
Pointer to the name of the source file that requested the allocation operation or NULL.
3838

39-
*`linenumber`*<br/>
39+
*`linenumber`*\
4040
Line number in the source file where the allocation operation was requested or NULL.
4141

4242
## Return value

docs/c-runtime-library/reference/aligned-malloc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ void * _aligned_malloc(
2525

2626
### Parameters
2727

28-
*`size`*<br/>
28+
*`size`*\
2929
Size of the requested memory allocation.
3030

31-
*`alignment`*<br/>
31+
*`alignment`*\
3232
The alignment value, which must be an integer power of 2.
3333

3434
## Return value

docs/c-runtime-library/reference/aligned-msize-dbg.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ size_t _aligned_msize_dbg(
2626

2727
### Parameters
2828

29-
*`memblock`*<br/>
29+
*`memblock`*\
3030
Pointer to the memory block.
3131

32-
*`alignment`*<br/>
32+
*`alignment`*\
3333
The alignment value, which must be an integer power of 2.
3434

35-
*`offset`*<br/>
35+
*`offset`*\
3636
The offset into the memory allocation to force the alignment.
3737

3838
## Return value

docs/c-runtime-library/reference/aligned-msize.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ size_t _aligned_msize(
2626

2727
### Parameters
2828

29-
*`memblock`*<br/>
29+
*`memblock`*\
3030
Pointer to the memory block.
3131

32-
*`alignment`*<br/>
32+
*`alignment`*\
3333
The alignment value, which must be an integer power of 2.
3434

35-
*`offset`*<br/>
35+
*`offset`*\
3636
The offset into the memory allocation to force the alignment.
3737

3838
## Return value

docs/c-runtime-library/reference/aligned-offset-malloc-dbg.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,19 @@ void * _aligned_offset_malloc_dbg(
2828

2929
### Parameters
3030

31-
*`size`*<br/>
31+
*`size`*\
3232
The size of the requested memory allocation.
3333

34-
*`alignment`*<br/>
34+
*`alignment`*\
3535
The alignment value, which must be an integer power of 2.
3636

37-
*`offset`*<br/>
37+
*`offset`*\
3838
The offset into the memory allocation to force the alignment.
3939

40-
*`filename`*<br/>
40+
*`filename`*\
4141
Pointer to the name of the source file that requested the allocation operation or **NULL**.
4242

43-
*`linenumber`*<br/>
43+
*`linenumber`*\
4444
Line number in the source file where the allocation operation was requested or **NULL**.
4545

4646
## Return value

0 commit comments

Comments
 (0)