Skip to content

Commit f41c469

Browse files
authored
Bulk Fix CRT Acrolinx issues 10 of N (#4596)
* Bulk Fix CRT Acrolinx issues 9 of N * Bulk Fix CRT Acrolinx issues 10 of N * Tweak verb agreement issues
1 parent fea2fcb commit f41c469

30 files changed

+95
-97
lines changed

docs/c-runtime-library/reference/clear87-clearfp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The bits in the value returned indicate the floating-point status before the cal
2929
3030
The **_clear87** function clears the exception flags in the floating-point status word, sets the busy bit to 0, and returns the status word. The floating-point status word is a combination of the 8087/80287 status word and other conditions detected by the 8087/80287 exception handler, such as floating-point stack overflow and underflow.
3131
32-
**_clearfp** is a platform-independent, portable version of the **_clear87** routine. It is identical to **_clear87** on Intel (x86) platforms and is also supported by the x64 and ARM platforms. To ensure that your floating-point code is portable to x64 and ARM, use **_clearfp**. If you are only targeting x86 platforms, you can use either **_clear87** or **_clearfp**.
32+
**_clearfp** is a platform-independent, portable version of the **_clear87** routine. It's identical to **_clear87** on Intel (x86) platforms and is also supported by the x64 and ARM platforms. To ensure that your floating-point code is portable to x64 and ARM, use **_clearfp**. If you're only targeting x86 platforms, you can use either **_clear87** or **_clearfp**.
3333
3434
These functions are deprecated when compiling with [/clr (Common Language Runtime Compilation)](../../build/reference/clr-common-language-runtime-compilation.md) because the common language runtime only supports the default floating-point precision.
3535

docs/c-runtime-library/reference/clearerr-s.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.assetid: b74d014d-b7a8-494a-a330-e5ffd5614772
1212
---
1313
# clearerr_s
1414

15-
Resets the error indicator for a stream. This is a version of [clearerr](clearerr.md) with security enhancements as described in [Security Features in the CRT](../../c-runtime-library/security-features-in-the-crt.md).
15+
Resets the error indicator for a stream. This function is a version of [clearerr](clearerr.md) with security enhancements as described in [Security Features in the CRT](../../c-runtime-library/security-features-in-the-crt.md).
1616

1717
## Syntax
1818

@@ -33,7 +33,7 @@ Zero if successful; **EINVAL** if *stream* is **NULL**.
3333

3434
## Remarks
3535

36-
The **clearerr_s** function resets the error indicator and end-of-file indicator for *stream*. Error indicators are not automatically cleared; once the error indicator for a specified stream is set, operations on that stream continue to return an error value until **clearerr_s**, **clearerr**, [fseek](fseek-fseeki64.md), **fsetpos**, or [rewind](rewind.md) is called.
36+
The **clearerr_s** function resets the error indicator and end-of-file indicator for *stream*. Error indicators aren't automatically cleared; once the error indicator for a specified stream is set, operations on that stream continue to return an error value until **clearerr_s**, **clearerr**, [fseek](fseek-fseeki64.md), **fsetpos**, or [rewind](rewind.md) is called.
3737

3838
If *stream* is **NULL**, the invalid parameter handler is invoked, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, this function sets **errno** to **EINVAL** and returns **EINVAL**.
3939

docs/c-runtime-library/reference/clearerr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Pointer to **FILE** structure.
2929

3030
## Remarks
3131

32-
The **clearerr** function resets the error indicator and end-of-file indicator for *stream*. Error indicators are not automatically cleared; once the error indicator for a specified stream is set, operations on that stream continue to return an error value until **clearerr**, [fseek](fseek-fseeki64.md), **fsetpos**, or [rewind](rewind.md) is called.
32+
The **clearerr** function resets the error indicator and end-of-file indicator for *stream*. Error indicators aren't automatically cleared; once the error indicator for a specified stream is set, operations on that stream continue to return an error value until **clearerr**, [fseek](fseek-fseeki64.md), **fsetpos**, or [rewind](rewind.md) is called.
3333

3434
If *stream* is **NULL**, the invalid parameter handler is invoked, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, this function sets **errno** to **EINVAL** and returns. For more information on **errno** and error codes, see [errno Constants](../../c-runtime-library/errno-constants.md).
3535

docs/c-runtime-library/reference/clock.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ The elapsed time since the CRT initialization at the start of the process, measu
2525
2626
## Remarks
2727
28-
The **`clock`** function tells how much wall-clock time has passed since the CRT initialization during process start. Note that this function does not strictly conform to ISO C, which specifies net CPU time as the return value. To obtain CPU times, use the Win32 [`GetProcessTimes`](/windows/win32/api/processthreadsapi/nf-processthreadsapi-getprocesstimes) function. To determine the elapsed time in seconds, divide the value returned by the **`clock`** function by the macro **`CLOCKS_PER_SEC`**.
28+
The **`clock`** function tells how much wall-clock time has passed since the CRT initialization during process start. This function doesn't strictly conform to ISO C, which specifies net CPU time as the return value. To obtain CPU times, use the Win32 [`GetProcessTimes`](/windows/win32/api/processthreadsapi/nf-processthreadsapi-getprocesstimes) function. To determine the elapsed time in seconds, divide the value returned by the **`clock`** function by the macro **`CLOCKS_PER_SEC`**.
2929
30-
Given enough time, the value returned by **`clock`** can exceed the maximum positive value of **`clock_t`**. When the process has run longer, the value returned by **`clock`** is always `(clock_t)(-1)`, as specified by the ISO C99 standard (7.23.2.1) and ISO C11 standard (7.27.2.1). Microsoft implements **`clock_t`** as a **`long`**, a signed 32-bit integer, and the **`CLOCKS_PER_SEC`** macro is defined as 1000. This gives a maximum **`clock`** function return value of 2147483.647 seconds, or about 24.8 days. Do not rely on the value returned by **`clock`** in processes that have run for longer than this amount of time. You can use the 64-bit [`time`](time-time32-time64.md) function or the Windows [`QueryPerformanceCounter`](/windows/win32/api/profileapi/nf-profileapi-queryperformancecounter) function to record process elapsed times of many years.
30+
Given enough time, the value returned by **`clock`** can exceed the maximum positive value of **`clock_t`**. When the process has run longer, the value returned by **`clock`** is always `(clock_t)(-1)`, as specified by the ISO C99 standard (7.23.2.1) and ISO C11 standard (7.27.2.1). Microsoft implements **`clock_t`** as a **`long`**, a signed 32-bit integer, and the **`CLOCKS_PER_SEC`** macro is defined as 1000. This macro gives a maximum **`clock`** function return value of 2147483.647 seconds, or about 24.8 days. Don't rely on the value returned by **`clock`** in processes that have run for longer than this amount of time. You can use the 64-bit [`time`](time-time32-time64.md) function or the Windows [`QueryPerformanceCounter`](/windows/win32/api/profileapi/nf-profileapi-queryperformancecounter) function to record process elapsed times of many years.
3131
3232
## Requirements
3333

docs/c-runtime-library/reference/clog-clogf-clogl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The possible return values are:
4747

4848
|z parameter|Return value|
4949
|-----------------|------------------|
50-
|Positive|The base 10 logarithm of z|
50+
|Positive|The logarithm (base 10) of z|
5151
|Zero|- ∞|
5252
|Negative|NaN|
5353
|NaN|NaN|

docs/c-runtime-library/reference/clog10-clog10f-clog10l.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.assetid: 2ddae00d-ef93-4441-add3-f4d58358401b
1212
---
1313
# clog10, clog10f, clog10l
1414

15-
Retrieves the base 10 logarithm of a complex number.
15+
Retrieves the logarithm (base 10) of a complex number.
1616

1717
## Syntax
1818

@@ -38,7 +38,7 @@ The possible return values are:
3838

3939
|z parameter|Return value|
4040
|-----------------|------------------|
41-
|Positive|The base 10 logarithm of z|
41+
|Positive|The logarithm (base 10) of z|
4242
|Zero|- ∞|
4343
|Negative|NaN|
4444
|NaN|NaN|

docs/c-runtime-library/reference/close.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ int _close(
2424

2525
### Parameters
2626

27-
*fd*<br/>
27+
*`fd`*<br/>
2828
File descriptor referring to the open file.
2929

3030
## Return Value
@@ -33,11 +33,11 @@ File descriptor referring to the open file.
3333

3434
## Remarks
3535

36-
The **_close** function closes the file associated with *fd*.
36+
The **_close** function closes the file associated with *`fd`*.
3737

38-
The file descriptor and the underlying OS file handle are closed. Thus, it is not necessary to call **CloseHandle** if the file was originally opened using the Win32 function **CreateFile** and converted to a file descriptor using **_open_osfhandle**.
38+
The file descriptor and the underlying OS file handle are closed. Thus, it isn't necessary to call **CloseHandle** if the file was originally opened using the Win32 function **CreateFile** and converted to a file descriptor using **_open_osfhandle**.
3939

40-
This function validates its parameters. If *fd* is a bad file descriptor, the invalid parameter handler is invoked, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, the functions returns -1 and **errno** is set to **EBADF**.
40+
This function validates its parameters. If *`fd`* is a bad file descriptor, the invalid parameter handler is invoked, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, the functions returns -1 and **errno** is set to **EBADF**.
4141

4242
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).
4343

docs/c-runtime-library/reference/cmulcc-fcmulcc-lcmulcc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ A **_Dcomplex**, **_Fcomplex**, or **_Lcomplex** structure that represents the c
3535
3636
## Remarks
3737
38-
Because the built-in arithmetic operators do not work on the Microsoft implementation of the complex types, the **_Cmulcc**, **_FCmulcc**, and **_LCmulcc** functions simplify multiplication of complex types.
38+
Because the built-in arithmetic operators don't work on the Microsoft implementation of the complex types, the **_Cmulcc**, **_FCmulcc**, and **_LCmulcc** functions simplify multiplication of complex types.
3939
4040
## Requirements
4141

docs/c-runtime-library/reference/cmulcr-fcmulcr-lcmulcr.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ The floating-point operand to multiply.
3131
3232
## Return Value
3333
34-
A **_Dcomplex**, **_Fcomplex**, or **_Lcomplex** structure that represents the complex product of the complex number *x* and flaoting-point number *y*.
34+
A **_Dcomplex**, **_Fcomplex**, or **_Lcomplex** structure that represents the complex product of the complex number *x* and floating-point number *y*.
3535
3636
## Remarks
3737
38-
Because the built-in arithmetic operators do not work on the Microsoft implementation of the complex types, the **_Cmulcr**, **_FCmulcr**, and **_LCmulcr** functions simplify multiplication of complex types by floating-point types.
38+
Because the built-in arithmetic operators don't work on the Microsoft implementation of the complex types, the **_Cmulcr**, **_FCmulcr**, and **_LCmulcr** functions simplify multiplication of complex types by floating-point types.
3939
4040
## Requirements
4141

docs/c-runtime-library/reference/commit.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ int _commit(
2424

2525
### Parameters
2626

27-
*fd*<br/>
27+
*`fd`*<br/>
2828
File descriptor referring to the open file.
2929

3030
## Return Value
@@ -33,9 +33,9 @@ File descriptor referring to the open file.
3333

3434
## Remarks
3535

36-
The **_commit** function forces the operating system to write the file associated with *fd* to disk. This call ensures that the specified file is flushed immediately, not at the operating system's discretion.
36+
The **_commit** function forces the operating system to write the file associated with *`fd`* to disk. This call ensures that the specified file is flushed immediately, not at the operating system's discretion.
3737

38-
If *fd* is an invalid file descriptor, the invalid parameter handler is invoked, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, the function returns -1 and **errno** is set to **EBADF**.
38+
If *`fd`* is an invalid file descriptor, the invalid parameter handler is invoked, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, the function returns -1 and **errno** is set to **EBADF**.
3939

4040
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).
4141

docs/c-runtime-library/reference/configthreadlocale.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The **`_configthreadlocale`** function is used to control the use of thread-spec
4141
4242
These functions affect the behavior of **`setlocale`**, **`_tsetlocale`**, **`_wsetlocale`**, and **`_setmbcp`**. When per-thread locale is disabled, any subsequent call to **`setlocale`** or **`_wsetlocale`** changes the locale of all threads that use the global locale. When per-thread locale is enabled, **`setlocale`** or **`_wsetlocale`** only affects the current thread's locale.
4343
44-
If you use **`_configthreadlocale`** to enable a per-thread locale, we recommend that you call **`setlocale`** or **`_wsetlocale`** to set the preferred locale in that thread immediately afterward.
44+
If you use **`_configthreadlocale`** to enable a per-thread locale, set the preferred locale in that thread immediately afterward by a call to **`setlocale`** or **`_wsetlocale`**.
4545
4646
If *`per_thread_locale_type`* isn't one of the values listed in the table, this function invokes the invalid parameter handler, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, this function sets **`errno`** to **`EINVAL`** and returns -1.
4747

docs/c-runtime-library/reference/controlfp-s.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ _controlfp_s(&current_word, _DN_FLUSH, _MCW_DN);
7575
// and x64 processors with SSE2 support. Ignored on other x86 platforms.
7676
```
7777

78-
On ARM platforms, the **`_controlfp_s`** function applies to the FPSCR register. On x64 architectures, only the SSE2 control word that's stored in the MXCSR register is affected. On Intel (x86) platforms, **`_controlfp_s`** affects the control words for both the x87 and the SSE2, if present. It's possible for the two control words to be inconsistent with each other (because of a previous call to [`__control87_2`](control87-controlfp-control87-2.md), for example); if there's an inconsistency between the two control words, **`_controlfp_s`** sets the **`EM_AMBIGUOUS`** flag in *`currentControl`*. This is a warning that the returned control word might not represent the state of both floating-point control words accurately.
78+
On ARM platforms, the **`_controlfp_s`** function applies to the FPSCR register. On x64 architectures, only the SSE2 control word that's stored in the MXCSR register is affected. On Intel (x86) platforms, **`_controlfp_s`** affects the control words for both the x87 and the SSE2, if present. It's possible for the two control words to be inconsistent with each other (because of a previous call to [`__control87_2`](control87-controlfp-control87-2.md), for example); if there's an inconsistency between the two control words, **`_controlfp_s`** sets the **`EM_AMBIGUOUS`** flag in *`currentControl`*. It's a warning that the returned control word might not represent the state of both floating-point control words accurately.
7979

8080
On the ARM and x64 architectures, changing the infinity mode or the floating-point precision isn't supported. If the precision control mask is used on the x64 platform, the function raises an assertion and the invalid parameter handler is invoked, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md).
8181

docs/c-runtime-library/reference/copysign-copysignf-copysignl-copysign-copysignf-copysignl.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,17 +50,17 @@ long double _copysignl(
5050
5151
### Parameters
5252
53-
*x*\
53+
*`x`*\
5454
The floating-point value that's returned as the magnitude of the result.
5555
56-
*y*\
56+
*`y`*\
5757
The floating-point value that's returned as the sign of the result.
5858
5959
[Floating-Point Support Routines](../../c-runtime-library/floating-point-support.md)
6060
6161
## Return Value
6262
63-
The **copysign** functions return a floating-point value that combines the magnitude of *x* and the sign of *y*. There's no error return.
63+
The **copysign** functions return a floating-point value that combines the magnitude of *`x`* and the sign of *`y`*. There's no error return.
6464
6565
## Remarks
6666

docs/c-runtime-library/reference/cos-cosf-cosl.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Angle in radians.
3535
3636
The cosine of *x*. If *x* is greater than or equal to 263, or less than or equal to -263, a loss of significance in the result occurs.
3737
38-
|Input|SEH Exception|Matherr Exception|
38+
|Input|SEH Exception|`Matherr` Exception|
3939
|-----------|-------------------|-----------------------|
4040
|± QNAN, IND|none|**_DOMAIN**|
4141
|± INF|**INVALID**|**_DOMAIN**|
@@ -59,15 +59,14 @@ For more compatibility information, see [Compatibility](../../c-runtime-library/
5959
6060
## Example
6161
62-
See the example in [sin, sinf, sinl](sin-sinf-sinl.md).
62+
See the example in [`sin`, `sinf`, `sinl`](sin-sinf-sinl.md).
6363
6464
## See also
6565
6666
[Floating-Point Support](../../c-runtime-library/floating-point-support.md)<br/>
67-
[acos, acosf, acosl](acos-acosf-acosl.md)<br/>
68-
[asin, asinf, asinl](asin-asinf-asinl.md)<br/>
69-
[atan, atanf, atanl, atan2, atan2f, atan2l](atan-atanf-atanl-atan2-atan2f-atan2l.md)<br/>
70-
[_matherr](matherr.md)<br/>
71-
[sin, sinf, sinl](sin-sinf-sinl.md)<br/>
72-
[tan, tanf, tanl](tan-tanf-tanl.md)<br/>
73-
[_CIcos](../../c-runtime-library/cicos.md)<br/>
67+
[`acos`, `acosf`, `acosl`](acos-acosf-acosl.md)<br/>
68+
[`asin`, `asinf`, `asinl`](asin-asinf-asinl.md)<br/>
69+
[`atan`, `atanf`, `atanl`, `atan2`, `atan2f`, `atan2l`](atan-atanf-atanl-atan2-atan2f-atan2l.md)<br/>
70+
[`_matherr`](matherr.md)<br/>
71+
[`sin`, `sinf`, `sinl`](sin-sinf-sinl.md)<br/>
72+
[`tan`, `tanf`, `tanl`](tan-tanf-tanl.md)

docs/c-runtime-library/reference/countof-macro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.assetid: 86198767-f7e5-4beb-898d-3cbbf60350a3
1111
---
1212
# `_countof` Macro
1313

14-
Computes the number of elements in a statically-allocated array.
14+
Computes the number of elements in a statically allocated array.
1515

1616
## Syntax
1717

docs/c-runtime-library/reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The number of characters printed.
5252

5353
## Remarks
5454

55-
These functions format and print a series of characters and values directly to the console, using the **_putch** function (**_putwch** for **_cwprintf**) to output characters. Each argument in *argument_list* (if any) is converted and output according to the corresponding format specification in *format*. The *format* argument uses the [format specification syntax for printf and wprintf functions](../../c-runtime-library/format-specification-syntax-printf-and-wprintf-functions.md). Unlike the **fprintf**, **printf**, and **sprintf** functions, neither **_cprintf** nor **_cwprintf** translates line-feed characters into carriage return-line feed (CR-LF) combinations when output.
55+
These functions format and print a series of characters and values directly to the console, using the **_putch** function (**_putwch** for **_cwprintf**) to output characters. Each argument in *argument_list* (if any) is converted and output according to the corresponding format specification in *format*. The *format* argument uses the [format specification syntax for printf and wprintf functions](../../c-runtime-library/format-specification-syntax-printf-and-wprintf-functions.md). Unlike the **fprintf**, **printf**, and **sprintf** functions, **_cprintf** and **_cwprintf** don't translate line-feed characters into carriage return-line feed (CR-LF) combinations when output.
5656

5757
An important distinction is that **_cwprintf** displays Unicode characters when used in Windows. Unlike **_cprintf**, **_cwprintf** uses the current console locale settings.
5858

0 commit comments

Comments
 (0)