Skip to content

Commit f41c469

Browse files
colin-homecolin-home
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

Lines changed: 95 additions & 97 deletions

‎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

0 commit comments

Comments
 (0)