Skip to content

Commit fea2fcb

Browse files
colin-homettorble
andauthored
Bulk Fix CRT Acrolinx issues, 7 of N (#4593)
* Bulk Fix CRT Acrolinx issues, 7 of N * Line 36: hyberbolic > hyperbolic Co-authored-by: Tracey Torble <[email protected]>
1 parent 2144c3a commit fea2fcb

30 files changed

+111
-111
lines changed

docs/c-runtime-library/reference/asctime-wasctime.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.assetid: 974f1727-10ff-4ed4-8cac-2eb2d681f576
1212
---
1313
# asctime, _wasctime
1414

15-
Convert a **tm** time structure to a character string. More secure versions of these functions are available; see [asctime_s, _wasctime_s](asctime-s-wasctime-s.md).
15+
Convert a `tm` time structure to a character string. More secure versions of these functions are available; see [asctime_s, _wasctime_s](asctime-s-wasctime-s.md).
1616

1717
## Syntax
1818

@@ -27,23 +27,23 @@ wchar_t *_wasctime(
2727

2828
### Parameters
2929

30-
*timeptr*<br/>
30+
*`timeptr`*<br/>
3131
Time/date structure.
3232

3333
## Return Value
3434

35-
**asctime** returns a pointer to the character string result; **_wasctime** returns a pointer to the wide-character string result. There is no error return value.
35+
**asctime** returns a pointer to the character string result; **_wasctime** returns a pointer to the wide-character string result. There's no error return value.
3636

3737
## Remarks
3838

3939
More secure versions of these functions are available; see [asctime_s, _wasctime_s](asctime-s-wasctime-s.md).
4040

41-
The **asctime** function converts a time stored as a structure to a character string. The *timeptr* value is usually obtained from a call to **gmtime** or **localtime**, which both return a pointer to a **tm** structure, defined in TIME.H.
41+
The **asctime** function converts a time stored as a structure to a character string. The *`timeptr`* value is typically obtained from a call to **gmtime** or **localtime**, which both return a pointer to a `tm` structure, defined in TIME.H.
4242

43-
|timeptr member|Value|
43+
|`timeptr` member|Value|
4444
|--------------------|-----------|
4545
|**tm_hour**|Hours since midnight (0-23)|
46-
|**tm_isdst**|Positive if daylight saving time is in effect; 0 if daylight saving time is not in effect; negative if status of daylight saving time is unknown. The C run-time library assumes the United States' rules for implementing the calculation of Daylight Saving Time (DST).|
46+
|**tm_isdst**|Positive if daylight saving time is in effect; 0 if daylight saving time isn't in effect; negative if status of daylight saving time is unknown. The C run-time library assumes the United States' rules for implementing the calculation of Daylight Saving Time (DST).|
4747
|**tm_mday**|Day of month (1-31)|
4848
|**tm_min**|Minutes after hour (0-59)|
4949
|**tm_mon**|Month (0-11; January = 0)|
@@ -52,15 +52,15 @@ The **asctime** function converts a time stored as a structure to a character st
5252
|**tm_yday**|Day of year (0-365; January 1 = 0)|
5353
|**tm_year**|Year (current year minus 1900)|
5454

55-
The converted character string is also adjusted according to the local time zone settings. For information about configuring the local time, see the [time](time-time32-time64.md), [_ftime](ftime-ftime32-ftime64.md), and [localtime](localtime-localtime32-localtime64.md) functions and the [_tzset](tzset.md) function for information about defining the time zone environment and global variables.
55+
The converted character string is also adjusted according to the local time zone settings. For information about configuring the local time, see the [time](time-time32-time64.md), [_ftime](ftime-ftime32-ftime64.md), and [localtime](localtime-localtime32-localtime64.md) functions. For information about defining the time zone environment and global variables, see the [_tzset](tzset.md) function.
5656

5757
The string result produced by **asctime** contains exactly 26 characters and has the form `Wed Jan 2 02:03:55 1980\n\0`. A 24-hour clock is used. All fields have a constant width. The newline character and the null character occupy the last two positions of the string. **asctime** uses a single, statically allocated buffer to hold the return string. Each call to this function destroys the result of the previous call.
5858

5959
**_wasctime** is a wide-character version of **asctime**. **_wasctime** and **asctime** behave identically otherwise.
6060

6161
These functions validate their parameters. If *timeptr* is a null pointer, or if it contains out-of-range values, 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 **NULL** and sets **errno** to **EINVAL**.
6262

63-
By default, this function's global state is scoped to the application. To change this, see [Global state in the CRT](../global-state.md).
63+
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).
6464

6565
### Generic-Text Routine Mapping
6666

@@ -77,7 +77,7 @@ By default, this function's global state is scoped to the application. To change
7777

7878
## Example
7979

80-
This program places the system time in the long integer **aclock**, translates it into the structure **newtime** and then converts it to string form for output, using the **asctime** function.
80+
This program places the system time in the long integer `aclock`, translates it into the structure `newtime` and then converts it to string form for output, using the **asctime** function.
8181

8282
```C
8383
// crt_asctime.c

docs/c-runtime-library/reference/asin-asinf-asinl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The **`asin`** function returns the arcsine (the inverse sine function) of *`x`*
3636
3737
By default, if *`x`* is less than -1 or greater than 1, **`asin`** returns an indefinite.
3838
39-
|Input|SEH exception|Matherr exception|
39+
|Input|SEH exception|`Matherr` exception|
4040
|-----------|-------------------|-----------------------|
4141
|`± ∞`|**`INVALID`**|**`_DOMAIN`**|
4242
|`± QNAN`, `IND`|none|**`_DOMAIN`**|
@@ -48,7 +48,7 @@ Because C++ allows overloading, you can call overloads of **`asin`** with **`flo
4848
4949
If you use the `<tgmath.h>` `asin()` macro, the type of the argument determines which version of the function is selected. See [Type-generic math](../../c-runtime-library/tgmath.md) for details.
5050
51-
By default, this function's global state is scoped to the application. To change this, see [Global state in the CRT](../global-state.md).
51+
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).
5252
5353
## Requirements
5454

docs/c-runtime-library/reference/asinh-asinhf-asinhl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ Floating-point value.
3333
3434
## Return Value
3535
36-
The **asinh** functions return the inverse hyberbolic sine (arc hyperbolic sine) of *x*. This function is valid over the floating-point domain. If *x* is a quiet NaN, indefinite, or infinity, the same value is returned.
36+
The **asinh** functions return the inverse hyperbolic sine (arc hyperbolic sine) of *x*. This function is valid over the floating-point domain. If *x* is a quiet NaN, indefinite, or infinity, the same value is returned.
3737
38-
|Input|SEH Exception|**_matherr** Exception|
38+
|Input|SEH Exception|`_matherr` Exception|
3939
|-----------|-------------------|--------------------------|
4040
|± QNAN, IND, INF|none|none|
4141

docs/c-runtime-library/reference/assert-asserte-assert-expr-macros.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ A wide string to display as part of the report.
3131
3232
## Remarks
3333
34-
The **`_ASSERT_EXPR`**, **`_ASSERT`** and **`_ASSERTE`** macros provide an application with a clean and simple mechanism for checking assumptions during the debugging process. They're very flexible because they don't need to be enclosed in `#ifdef` statements to prevent them from being called in a retail build of an application. This flexibility is achieved by using the [`_DEBUG`](../../c-runtime-library/debug.md) macro. **`_ASSERT_EXPR`**, **`_ASSERT`** and **`_ASSERTE`** are only available when **`_DEBUG`** is defined at compile time. When **`_DEBUG`** isn't defined, calls to these macros are removed during preprocessing.
34+
The **`_ASSERT_EXPR`**, **`_ASSERT`** and **`_ASSERTE`** macros provide an application with a clean and simple mechanism for checking assumptions during the debugging process. They're flexible because they don't need to be enclosed in `#ifdef` statements to prevent them from being called in a retail build of an application. This flexibility is achieved by using the [`_DEBUG`](../../c-runtime-library/debug.md) macro. **`_ASSERT_EXPR`**, **`_ASSERT`** and **`_ASSERTE`** are only available when **`_DEBUG`** is defined at compile time. When **`_DEBUG`** isn't defined, calls to these macros are removed during preprocessing.
3535
3636
**`_ASSERT_EXPR`**, **`_ASSERT`** and **`_ASSERTE`** evaluate their *`booleanExpression`* argument and when the result is **`false`** (0), they print a diagnostic message and call [`_CrtDbgReportW`](crtdbgreport-crtdbgreportw.md) to generate a debug report. The **`_ASSERT`** macro prints a simple diagnostic message, **`_ASSERTE`** includes a string representation of the failed expression in the message, and **`_ASSERT_EXPR`** includes the *`message`* string in the diagnostic message. These macros do nothing when *`booleanExpression`* evaluates to nonzero.
3737
@@ -47,7 +47,7 @@ _CrtSetReportMode(CRT_ASSERT, _CRTDBG_MODE_WNDW);
4747
4848
**`_CrtDbgReportW`** generates the debug report and determines its destination or destinations, based on the current report mode or modes and file defined for the **`_CRT_ASSERT`** report type. By default, assertion failures and errors are directed to a debug message window. The [`_CrtSetReportMode`](crtsetreportmode.md) and [`_CrtSetReportFile`](crtsetreportfile.md) functions are used to define the destinations for each report type.
4949
50-
When the destination is a debug message window and the user selects the **Retry** button, **`_CrtDbgReportW`** returns 1, causing the **`_ASSERT_EXPR`**, **`_ASSERT`** and **`_ASSERTE`** macros to start the debugger provided that just-in-time (JIT) debugging is enabled.
50+
When the destination is a debug message window and the user selects the **Retry** button, **`_CrtDbgReportW`** returns 1, causing the **`_ASSERT_EXPR`**, **`_ASSERT`** and **`_ASSERTE`** macros to start the debugger if just-in-time (JIT) debugging is enabled.
5151
5252
For more information about the reporting process, see the [`_CrtDbgReport`, `_CrtDbgReportW`](crtdbgreport-crtdbgreportw.md) function. For more information about resolving assertion failures and using these macros as a debugging error handling mechanism, see [Using Macros for Verification and Reporting](/visualstudio/debugger/macros-for-reporting).
5353

docs/c-runtime-library/reference/assert-macro-assert-wassert.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,25 +54,25 @@ The `assert` macro prints a diagnostic message when *`expression`* evaluates to
5454

5555
The diagnostic message is printed in wide (`wchar_t`) characters. Therefore, it will work as expected even if there are Unicode characters in the expression.
5656

57-
The destination of the diagnostic message depends on the type of application that called the routine. Console applications receive the message through **`stderr`**. In a Windows-based application, `assert` calls the Windows [`MessageBox`](/windows/win32/api/winuser/nf-winuser-messagebox) function to create a message box to display the message with three buttons: **Abort**, **Retry**, and **Ignore**. If the user clicks **Abort**, the program aborts immediately. If the user clicks **Retry**, the debugger is called and the user can debug the program if just-in-time (JIT) debugging is enabled. If the user clicks **Ignore**, the program will continue with normal execution. Clicking **Ignore** when an error condition exists can result in undefined behavior since preconditions of the calling code weren't met.
57+
The destination of the diagnostic message depends on the type of application that called the routine. Console applications receive the message through **`stderr`**. In a Windows-based application, `assert` calls the Windows [`MessageBox`](/windows/win32/api/winuser/nf-winuser-messagebox) function to create a message box to display the message with three buttons: **Abort**, **Retry**, and **Ignore**. If the user chooses **Abort**, the program aborts immediately. If the user chooses **Retry**, the debugger is called, and the user can debug the program if just-in-time (JIT) debugging is enabled. If the user chooses **Ignore**, the program will continue with normal execution. Clicking **Ignore** when an error condition exists can result in undefined behavior since preconditions of the calling code weren't met.
5858

5959
To override the default output behavior regardless of the app type, call [`_set_error_mode`](set-error-mode.md) to select between the output-to-stderr and display-dialog-box behavior.
6060

61-
After `assert` displays its message, it calls [`abort`](abort.md), which displays a dialog box with **Abort**, **Retry**, and **Ignore** buttons. [`abort`](abort.md) exits the program, so the **Retry** and **Ignore** button won't resume program execution following the `assert` call. If `assert` displayed a dialog box, the [`abort`](abort.md) dialog box isn't shown. The only time the [`abort`](abort.md) dialog box is shown is when `assert` sends its output to stderr.
61+
After `assert` displays its message, it calls [`abort`](abort.md), which displays a dialog box with **Abort**, **Retry**, and **Ignore** buttons. [`abort`](abort.md) exits the program, so the **Retry** and **Ignore** button won't resume program execution following the `assert` call. If `assert` displayed a dialog box, the [`abort`](abort.md) dialog box isn't shown. The only time the [`abort`](abort.md) dialog box is shown, is when `assert` sends its output to stderr.
6262

6363
As a consequence of the above behavior, a dialog box is always displayed following an `assert` call in debug mode. The behavior of each button is captured in the below table.
6464

6565
|Error mode|Output to `stderr` (Console/`_OUT_TO_STDERR`)|Display Dialog Box (Windows/`_OUT_TO_MSGBOX`)|
6666
|----------|----------------|------------------|
6767
|`Abort`|Exit immediately with exit code 3|Exit immediately with exit code 3|
6868
|`Retry`|Break into debugger during `abort`|Break into debugger during `assert`|
69-
|`Ignore`|Finish exiting via `abort`|Continue program as though the assert didn't fire (may result in undefined behavior since preconditions of the calling code weren't met)|
69+
|`Ignore`|Finish exiting via `abort`|Continue program as though `assert` didn't fire (may result in undefined behavior since preconditions of the calling code weren't met)|
7070

7171
For more information about CRT debugging, see [CRT Debugging Techniques](/visualstudio/debugger/crt-debugging-techniques).
7272

7373
The `_assert` and `_wassert` functions are internal CRT functions. They help minimize the code required in your object files to support assertions. We don't recommend that you call these functions directly.
7474

75-
The `assert` macro is enabled in both the release and debug versions of the C run-time libraries when **`NDEBUG`** isn't defined. When **`NDEBUG`** is defined, the macro is available but doesn't evaluate its argument and has no effect. When it's enabled, the `assert` macro calls `_wassert` for its implementation. Other assertion macros, [`_ASSERT`](assert-asserte-assert-expr-macros.md), [`_ASSERTE`](assert-asserte-assert-expr-macros.md) and [`_ASSERT_EXPR`](assert-asserte-assert-expr-macros.md), are also available, but they only evaluate the expressions passed to them when the [`_DEBUG`](../../c-runtime-library/debug.md) macro has been defined and when they are in code linked with the debug version of the C run-time libraries.
75+
The `assert` macro is enabled in both the release and debug versions of the C run-time libraries when **`NDEBUG`** isn't defined. When **`NDEBUG`** is defined, the macro is available, but doesn't evaluate its argument and has no effect. When it's enabled, the `assert` macro calls `_wassert` for its implementation. Other assertion macros, [`_ASSERT`](assert-asserte-assert-expr-macros.md), [`_ASSERTE`](assert-asserte-assert-expr-macros.md) and [`_ASSERT_EXPR`](assert-asserte-assert-expr-macros.md), are also available, but they only evaluate the expressions passed to them when the [`_DEBUG`](../../c-runtime-library/debug.md) macro has been defined and when they are in code linked with the debug version of the C run-time libraries.
7676

7777
## Requirements
7878

docs/c-runtime-library/reference/atan-atanf-atanl-atan2-atan2f-atan2l.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Any numbers.
4444
4545
**`atan2`** uses the signs of both parameters to determine the quadrant of the return value.
4646
47-
|Input|SEH exception|Matherr exception|
47+
|Input|SEH exception|`Matherr` exception|
4848
|-----------|-------------------|-----------------------|
4949
|± **`QNAN`**, **`IND`**|none|**`_DOMAIN`**|
5050
@@ -58,7 +58,7 @@ If you use the `<tgmath.h>` `atan()` or `atan2()` macro, the type of the argumen
5858
5959
Because C++ allows overloading, you can call overloads of **`atan`** and **`atan2`** that take **`float`** or **`long double`** arguments. In a C program, unless you're using the `<tgmath.h>` macro to call this function, **`atan`** and **`atan2`** always take **`double`** arguments and return a **`double`**.
6060
61-
By default, this function's global state is scoped to the application. To change this, see [Global state in the CRT](../global-state.md).
61+
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).
6262
6363
## Requirements
6464

docs/c-runtime-library/reference/atanh-atanhf-atanhl.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ Floating-point value.
3333
3434
## Return Value
3535
36-
The **atanh** functions return the inverse hyberbolic tangent (arc hyperbolic tangent) of *x*. If *x* is greater than 1, or less than -1, **errno** is set to **EDOM** and the result is a quiet NaN. If *x* is equal to 1 or -1, a positive or negative infinity is returned, respectively, and **errno** is set to **ERANGE**.
36+
The **atanh** functions return the inverse hyperbolic tangent (arc hyperbolic tangent) of *x*. If *x* is greater than 1, or less than -1, **errno** is set to **EDOM** and the result is a quiet NaN. If *x* is equal to 1 or -1, a positive or negative infinity is returned, respectively, and **errno** is set to **ERANGE**.
3737
38-
|Input|SEH Exception|**Matherr** Exception|
38+
|Input|SEH Exception|`Matherr` Exception|
3939
|-----------|-------------------|-------------------------|
40-
|± QNAN,IND|none|none|
40+
|± QNAN, IND|none|none|
4141
|*X* ≥ 1; *x* ≤ -1|none|none|
4242
4343
## Remarks
@@ -46,7 +46,7 @@ Because C++ allows overloading, you can call overloads of **atanh** that take an
4646
4747
If you use the \<tgmath.h> `atanh()` macro, the type of the argument determines which version of the function is selected. See [Type-generic math](../../c-runtime-library/tgmath.md) for details.
4848
49-
By default, this function's global state is scoped to the application. To change this, see [Global state in the CRT](../global-state.md).
49+
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).
5050
5151
## Requirements
5252
@@ -55,7 +55,7 @@ By default, this function's global state is scoped to the application. To change
5555
|**atanh**, **atanhf**, **atanhl**|\<math.h>|\<cmath> or \<math.h>|
5656
|**atanh()** macro | \<tgmath.h> ||
5757
58-
For additional compatibility information, see [Compatibility](../../c-runtime-library/compatibility.md).
58+
For more compatibility information, see [Compatibility](../../c-runtime-library/compatibility.md).
5959
6060
## Example
6161

docs/c-runtime-library/reference/atodbl-atodbl-l-atoldbl-atoldbl-l-atoflt-atoflt-l.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ Returns 0 if successful. Possible error codes are **_UNDERFLOW** or **_OVERFLOW*
4242
4343
## Remarks
4444
45-
These functions convert a string to a floating-point value. The difference between these functions and the **atof** family of functions is that these functions do not generate floating-point code and do not cause hardware exceptions. Instead, error conditions are reported as error codes.
45+
These functions convert a string to a floating-point value. The difference between these functions and the **atof** family of functions is that these functions don't generate floating-point code and don't cause hardware exceptions. Instead, error conditions are reported as error codes.
4646
47-
If a string does not have a valid interpretation as a floating-point value, *value* is set to zero and the return value is zero.
47+
If a string doesn't have a valid interpretation as a floating-point value, *value* is set to zero, and the return value is zero.
4848
4949
The versions of these functions that have the **_l** suffix are identical the versions that don't have the suffix, except that they use the *locale* parameter that's passed in instead of the current thread locale.
5050
51-
By default, this function's global state is scoped to the application. To change this, see [Global state in the CRT](../global-state.md).
51+
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).
5252
5353
## Requirements
5454

0 commit comments

Comments
 (0)