Skip to content

Commit 2c97e11

Browse files
authored
Merge pull request #3518 from msebolt/code-escape-pr10
initial
2 parents b143bef + 20825f8 commit 2c97e11

10 files changed

+176
-176
lines changed

docs/c-runtime-library/errno-constants.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ helpviewer_keywords: ["E2BIG constant", "EACCES constant", "EAGAIN constant", "E
1717

1818
The **`errno`** constants are values assigned to [`errno`](../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md) in the event of various error conditions.
1919

20-
ERRNO.H contains the definitions of the **`errno`** values. However, not all the definitions given in ERRNO.H are used in 32-bit Windows operating systems. Some of the values in ERRNO.H are present to maintain compatibility with the UNIX family of operating systems. The **`errno`** values in a 32-bit Windows operating system are a subset of the values for **`errno`** in UNIX systems.
20+
`ERRNO.H` contains the definitions of the **`errno`** values. However, not all the definitions given in `ERRNO.H` are used in 32-bit Windows operating systems. Some of the values in `ERRNO.H` are present to maintain compatibility with the UNIX family of operating systems. The **`errno`** values in a 32-bit Windows operating system are a subset of the values for **`errno`** in UNIX systems.
2121

2222
The **`errno`** value isn't necessarily the same as the actual error code returned by a system call from the Windows operating system. To access the actual operating system error code, use the [`_doserrno`](../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md) variable, which contains this value.
2323

@@ -37,7 +37,7 @@ The following **`errno`** values are supported:
3737
| `EEXIST` | Files exists. An attempt has been made to create a file that already exists. For example, the `_O_CREAT` and `_O_EXCL` flags are specified in an `_open` call, but the named file already exists. | 17 |
3838
| `EFAULT` | Bad address. | 14 |
3939
| `EFBIG` | File too large. | 27 |
40-
| `EILSEQ` | Illegal sequence of bytes (for example, in an MBCS string). | 42 |
40+
| `EILSEQ` | Illegal sequence of bytes (for example, in an `MBCS` string). | 42 |
4141
| `EINTR` | Interrupted function. | 4 |
4242
| `EINVAL` | Invalid argument. An invalid value was given for one of the arguments to a function. For example, the value given for the origin when positioning a file pointer (by means of a call to `fseek`) is before the beginning of the file. | 22 |
4343
| `EIO` | I/O error. | 5 |

docs/c-runtime-library/reference/atof-atof-l-wtof-wtof-l.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ f1_keywords: ["_tstof", "_ttof", "atof", "stdlib/atof", "math/atof", "_atof_l",
1010
helpviewer_keywords: ["tstof function", "atof_l function", "_atof_l function", "atof function", "_tstof function", "_ttof function", "wtof function", "_wtof_l function", "ttof function", "wtof_l function", "_wtof function", "string conversion, to floating point values"]
1111
ms.assetid: eb513241-c9a9-4f5c-b7e7-a49b14abfb75
1212
---
13-
# atof, _atof_l, _wtof, _wtof_l
13+
# `atof`, `_atof_l`, `_wtof`, `_wtof_l`
1414

1515
Convert a string to double.
1616

@@ -35,53 +35,53 @@ double _wtof_l(
3535

3636
## Parameters
3737

38-
*str*<br/>
38+
*`str`*<br/>
3939
String to be converted.
4040

41-
*locale*<br/>
41+
*`locale`*<br/>
4242
Locale to use.
4343

4444
## Return Value
4545

4646
Each function returns the **`double`** value produced by interpreting the input characters as a number. The return value is 0.0 if the input cannot be converted to a value of that type.
4747

48-
In all out-of-range cases, **errno** is set to **ERANGE**. If the parameter passed in 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, these functions set **errno** to **EINVAL** and return 0.
48+
In all out-of-range cases, **`errno`** is set to **`ERANGE`**. If the parameter passed in 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, these functions set **`errno`** to **`EINVAL`** and return 0.
4949

5050
## Remarks
5151

5252
These functions convert a character string to a double-precision, floating-point value.
5353

5454
The input string is a sequence of characters that can be interpreted as a numerical value of the specified type. The function stops reading the input string at the first character that it cannot recognize as part of a number. This character may be the null character ('\0' or L'\0') terminating the string.
5555

56-
The *str* argument to **atof** and **_wtof** has the following form:
56+
The *`str`* argument to **`atof`** and **`_wtof`** has the following form:
5757

5858
[*whitespace*] [*sign*] [*digits*] [__.__*digits*] [ {**e** &#124; **E** }[*sign*]*digits*]
5959

60-
A *whitespace* consists of space or tab characters, which are ignored; *sign* is either plus (+) or minus (-); and *digits* are one or more decimal digits. If no digits appear before the decimal point, at least one must appear after the decimal point. The decimal digits may be followed by an exponent, which consists of an introductory letter (**e**, or **E**) and an optionally signed decimal integer.
60+
A *`whitespace`* consists of space or tab characters, which are ignored; *`sign`* is either plus (+) or minus (-); and *`digits`* are one or more decimal digits. If no digits appear before the decimal point, at least one must appear after the decimal point. The decimal digits may be followed by an exponent, which consists of an introductory letter (**`e`**, or **`E`**) and an optionally signed decimal integer.
6161

62-
The UCRT versions of these functions do not support conversion of Fortran-style (**d** or **D**) exponent letters. This non-standard extension was supported by earlier versions of the CRT, and may be a breaking change for your code.
62+
The UCRT versions of these functions do not support conversion of Fortran-style (**`d`** or **`D`**) exponent letters. This non-standard extension was supported by earlier versions of the CRT, and may be a breaking change for your code.
6363

64-
The versions of these functions with the **_l** suffix are identical except that they use the *locale* parameter passed in instead of the current locale.
64+
The versions of these functions with the **`_l`** suffix are identical except that they use the *`locale`* parameter passed in instead of the current locale.
6565

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

6868
### Generic-Text Routine Mappings
6969

70-
|TCHAR.H routine|_UNICODE & _MBCS not defined|_MBCS defined|_UNICODE defined|
70+
|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined|
7171
|---------------------|------------------------------------|--------------------|-----------------------|
72-
|**_tstof**|**atof**|**atof**|**_wtof**|
73-
|**_ttof**|**atof**|**atof**|**_wtof**|
72+
|**`_tstof`**|**`atof`**|**`atof`**|**`_wtof`**|
73+
|**`_ttof`**|**`atof`**|**`atof`**|**`_wtof`**|
7474

7575
## Requirements
7676

7777
|Routine(s)|Required header|
7878
|------------------|---------------------|
79-
|**atof**, **_atof_l**|C: \<math.h> or \<stdlib.h> C++: \<cstdlib>, \<stdlib.h>, \<cmath> or \<math.h>|
80-
|**_wtof**, **_wtof_l**|C: \<stdlib.h> or \<wchar.h> C++: \<cstdlib>, \<stdlib.h> or \<wchar.h>|
79+
|**`atof`**, **`_atof_l`**|C: `<math.h>` or `<stdlib.h>` C++: `<cstdlib>`, `<stdlib.h>`, `<cmath>` or `<math.h>`|
80+
|**`_wtof`**, **`_wtof_l`**|C: `<stdlib.h>` or `<wchar.h>` C++: `<cstdlib>`, `<stdlib.h>` or `<wchar.h>`|
8181

8282
## Example
8383

84-
This program shows how numbers stored as strings can be converted to numeric values using the **atof** and **_atof_l** functions.
84+
This program shows how numbers stored as strings can be converted to numeric values using the **`atof`** and **`_atof_l`** functions.
8585

8686
```C
8787
// crt_atof.c
@@ -135,8 +135,8 @@ Function: _atof_l(" -2,309e-25", fr)) = -2.309000e-25
135135
[Data Conversion](../../c-runtime-library/data-conversion.md)<br/>
136136
[Floating-Point Support](../../c-runtime-library/floating-point-support.md)<br/>
137137
[Locale](../../c-runtime-library/locale.md)<br/>
138-
[_ecvt](ecvt.md)<br/>
139-
[_fcvt](fcvt.md)<br/>
140-
[_gcvt](gcvt.md)<br/>
141-
[setlocale, _wsetlocale](setlocale-wsetlocale.md)<br/>
142-
[_atodbl, _atodbl_l, _atoldbl, _atoldbl_l, _atoflt, _atoflt_l](atodbl-atodbl-l-atoldbl-atoldbl-l-atoflt-atoflt-l.md)<br/>
138+
[`_ecvt`](ecvt.md)<br/>
139+
[`_fcvt`](fcvt.md)<br/>
140+
[`_gcvt`](gcvt.md)<br/>
141+
[`setlocale`, `_wsetlocale`](setlocale-wsetlocale.md)<br/>
142+
[`_atodbl`, `_atodbl_l`, `_atoldbl`, `_atoldbl_l`, `_atoflt`, `_atoflt_l`](atodbl-atodbl-l-atoldbl-atoldbl-l-atoflt-atoflt-l.md)<br/>

docs/c-runtime-library/reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ topic_type: ["apiref"]
99
f1_keywords: ["fprintf", "fwprintf", "_ftprintf"]
1010
helpviewer_keywords: ["_fwprintf_l function", "fprintf function", "fprintf_l function", "_fprintf_l function", "_ftprintf function", "fwprintf function", "ftprintf_l function", "ftprintf function", "_ftprintf_l function", "print formatted data to streams", "fwprintf_l function"]
1111
---
12-
# fprintf, _fprintf_l, fwprintf, _fwprintf_l
12+
# `fprintf`, `_fprintf_l`, `fwprintf`, `_fwprintf_l`
1313

14-
Print formatted data to a stream. More secure versions of these functions are available; see [fprintf_s, _fprintf_s_l, fwprintf_s, _fwprintf_s_l](fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md).
14+
Print formatted data to a stream. More secure versions of these functions are available; see [`fprintf_s`, `_fprintf_s_l`, `fwprintf_s`, `_fwprintf_s_l`](fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md).
1515

1616
## Syntax
1717

@@ -42,31 +42,31 @@ int _fwprintf_l(
4242

4343
### Parameters
4444

45-
*stream*<br/>
45+
*`stream`*<br/>
4646
Pointer to **FILE** structure.
4747

48-
*format*<br/>
48+
*`format`*<br/>
4949
Format-control string.
5050

51-
*argument*<br/>
51+
*`argument`*<br/>
5252
Optional arguments.
5353

54-
*locale*<br/>
54+
*`locale`*<br/>
5555
The locale to use.
5656

5757
## Return Value
5858

59-
**fprintf** returns the number of bytes written. **fwprintf** returns the number of wide characters written. Each of these functions returns a negative value instead when an output error occurs. If *stream* or *format* is **NULL**, these functions invoke the invalid parameter handler, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, the functions return -1 and set **errno** to **EINVAL**. The format string is not checked for valid formatting characters as it is when using **fprintf_s** or **fwprintf_s**.
59+
**`fprintf`** returns the number of bytes written. **`fwprintf`** returns the number of wide characters written. Each of these functions returns a negative value instead when an output error occurs. If *`stream`* or *`format`* is **`NULL`**, these functions invoke the invalid parameter handler, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, the functions return -1 and set **`errno`** to **`EINVAL`**. The format string is not checked for valid formatting characters as it is when using **`fprintf_s`** or **`fwprintf_s`**.
6060

61-
See [_doserrno, errno, _sys_errlist, and _sys_nerr](../../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md) for more information on these, and other, error codes.
61+
See [`_doserrno`, `errno`, `_sys_errlist`, and `_sys_nerr`](../../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md) for more information on these, and other, error codes.
6262

6363
## Remarks
6464

65-
**fprintf** formats and prints a series of characters and values to the output *stream*. Each function *argument* (if any) is converted and output according to the corresponding format specification in *format*. For **fprintf**, the *format* argument has the same syntax and use that it has in **printf**.
65+
**`fprintf`** formats and prints a series of characters and values to the output *`stream`*. Each function *`argument`* (if any) is converted and output according to the corresponding format specification in *`format`*. For **`fprintf`**, the *`format`* argument has the same syntax and use that it has in **`printf`**.
6666

67-
**fwprintf** is a wide-character version of **fprintf**; in **fwprintf**, *format* is a wide-character string. These functions behave identically if the stream is opened in ANSI mode. **fprintf** does not currently support output into a UNICODE stream.
67+
**`fwprintf`** is a wide-character version of **`fprintf`**; in **`fwprintf`**, *`format`* is a wide-character string. These functions behave identically if the stream is opened in ANSI mode. **`fprintf`** does not currently support output into a UNICODE stream.
6868

69-
The versions of these functions with the **_l** suffix are identical except that they use the locale parameter passed in instead of the current thread locale.
69+
The versions of these functions with the **`_l`** suffix are identical except that they use the locale parameter passed in instead of the current thread locale.
7070

7171
> [!IMPORTANT]
7272
> Ensure that *format* is not a user-defined string.
@@ -76,19 +76,19 @@ The versions of these functions with the **_l** suffix are identical except that
7676
7777
### Generic-Text Routine Mappings
7878

79-
|TCHAR.H routine|_UNICODE & _MBCS not defined|_MBCS defined|_UNICODE defined|
79+
|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined|
8080
|---------------------|------------------------------------|--------------------|-----------------------|
81-
|**_ftprintf**|**fprintf**|**fprintf**|**fwprintf**|
82-
|**_ftprintf_l**|**_fprintf_l**|**_fprintf_l**|**_fwprintf_l**|
81+
|**`_ftprintf`**|**`fprintf`**|**`fprintf`**|**`fwprintf`**|
82+
|**`_ftprintf_l`**|**`_fprintf_l`**|**`_fprintf_l`**|**`_fwprintf_l`**|
8383

8484
For more information, see [Format Specifications](../../c-runtime-library/format-specification-syntax-printf-and-wprintf-functions.md).
8585

8686
## Requirements
8787

8888
|Function|Required header|
8989
|--------------|---------------------|
90-
|**fprintf**, **_fprintf_l**|\<stdio.h>|
91-
|**fwprintf**, **_fwprintf_l**|\<stdio.h> or \<wchar.h>|
90+
|**`fprintf`**, **`_fprintf_l`**|`<stdio.h>`|
91+
|**`fwprintf`**, **`_fwprintf_l`**|`<stdio.h>` or `<wchar.h>`|
9292

9393
For additional compatibility information, see [Compatibility](../../c-runtime-library/compatibility.md).
9494

@@ -132,7 +132,7 @@ this is a string
132132
## See also
133133

134134
[Stream I/O](../../c-runtime-library/stream-i-o.md)<br/>
135-
[_cprintf, _cprintf_l, _cwprintf, _cwprintf_l](cprintf-cprintf-l-cwprintf-cwprintf-l.md)<br/>
136-
[fscanf, _fscanf_l, fwscanf, _fwscanf_l](fscanf-fscanf-l-fwscanf-fwscanf-l.md)<br/>
137-
[sprintf, _sprintf_l, swprintf, _swprintf_l, \__swprintf_l](sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md)<br/>
138-
[Format Specification Syntax: printf and wprintf Functions](../../c-runtime-library/format-specification-syntax-printf-and-wprintf-functions.md)<br/>
135+
[`_cprintf`, `_cprintf_l`, `_cwprintf`, `_cwprintf_l`](cprintf-cprintf-l-cwprintf-cwprintf-l.md)<br/>
136+
[`fscanf`, `_fscanf_l`, `fwscanf`, `_fwscanf_l`](fscanf-fscanf-l-fwscanf-fwscanf-l.md)<br/>
137+
[`sprintf`, `_sprintf_l`, `swprintf`, `_swprintf_l`, `_swprintf_l`](sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md)<br/>
138+
[Format Specification Syntax: `printf` and `wprintf` Functions](../../c-runtime-library/format-specification-syntax-printf-and-wprintf-functions.md)<br/>

docs/c-runtime-library/reference/pow-powf-powl.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ f1_keywords: ["powl", "pow", "_powl", "powf"]
1010
helpviewer_keywords: ["exponential calculations", "powl function", "_powl function", "exponentiation", "powers, calculating", "calculating exponentials", "powf function", "pow function"]
1111
ms.assetid: e75c33ed-2e59-48b1-be40-81da917324f1
1212
---
13-
# pow, powf, powl
13+
# `pow`, `powf`, `powl`
1414

15-
Calculates *x* raised to the power of *y*.
15+
Calculates *`x`* raised to the power of *`y`*.
1616

1717
## Syntax
1818

@@ -31,15 +31,15 @@ long double pow( long double x, int y ); // C++ only
3131
3232
### Parameters
3333
34-
*x*\
34+
*`x`*\
3535
Base.
3636
37-
*y*\
37+
*`y`*\
3838
Exponent.
3939
4040
## Return Value
4141
42-
Returns the value of *x*<sup>*y*</sup>. No error message is printed on overflow or underflow.
42+
Returns the value of *`x`*<sup>*`y`*</sup>. No error message is printed on overflow or underflow.
4343
4444
|Values of x and y|Return value of pow|
4545
|-----------------------|-------------------------|
@@ -49,13 +49,13 @@ Returns the value of *x*<sup>*y*</sup>. No error message is printed on overflow
4949
5050
## Remarks
5151
52-
**pow** does not recognize integral floating-point values greater than 2<sup>64</sup> (for example, 1.0E100).
52+
**`pow`** does not recognize integral floating-point values greater than 2<sup>64</sup> (for example, 1.0E100).
5353
54-
**pow** has an implementation that uses Streaming SIMD Extensions 2 (SSE2). For information and restrictions about using the SSE2 implementation, see [_set_SSE2_enable](set-sse2-enable.md).
54+
**`pow`** has an implementation that uses Streaming SIMD Extensions 2 (SSE2). For information and restrictions about using the SSE2 implementation, see [`_set_SSE2_enable`](set-sse2-enable.md).
5555
56-
Because C++ allows overloading, you can call any of the various overloads of **pow**. In a C program, unless you're using the \<tgmath.h> macro to call this function, **pow** always takes two **`double`** values and returns a **`double`** value.
56+
Because C++ allows overloading, you can call any of the various overloads of **`pow`**. In a C program, unless you're using the `<tgmath.h>` macro to call this function, **`pow`** always takes two **`double`** values and returns a **`double`** value.
5757
58-
If you use the \<tgmath.h> `pow()` 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.
58+
If you use the `<tgmath.h>` `pow()` 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.
5959
6060
The `pow(int, int)` overload is no longer available. If you use this overload, the compiler may emit [C2668](../../error-messages/compiler-errors-2/compiler-error-c2668.md). To avoid this problem, cast the first parameter to **`double`**, **`float`**, or **`long double`**.
6161
@@ -67,8 +67,8 @@ By default, this function's global state is scoped to the application. To change
6767
6868
|Routine|Required header (C)|Required header (C++)|
6969
|-|-|-|
70-
|**pow**, **powf**, **powl**|\<math.h>|\<math.h> or \<cmath>|
71-
|**pow** macro | \<tgmath.h> ||
70+
|**`pow`**, **`powf`**, **`powl`**|`<math.h>`|`<math.h>` or `<cmath>`|
71+
|**`pow`** macro | `<tgmath.h>` ||
7272
7373
For additional compatibility information, see [Compatibility](../../c-runtime-library/compatibility.md).
7474

0 commit comments

Comments
 (0)