Skip to content

Commit af7cdc2

Browse files
author
Colin Robertson
authored
Merge pull request MicrosoftDocs#3667 from MicrosoftDocs/main637787314147102251
Repo sync for protected CLA branch
2 parents fce782b + b0f1edf commit af7cdc2

File tree

10 files changed

+327
-336
lines changed

10 files changed

+327
-336
lines changed

docs/c-runtime-library/gets-getws.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,13 @@ api_type: ["DLLExport"]
88
topic_type: ["apiref"]
99
f1_keywords: ["_getts", "gets", "_getws"]
1010
helpviewer_keywords: ["getws function", "getts function", "_getws function", "lines, getting", "streams, getting lines", "_getts function", "gets function", "standard input, reading from"]
11-
ms.assetid: 1ec2dd4b-f801-48ea-97c2-892590f16024
1211
---
13-
# gets, _getws
12+
# `gets`, `_getws`
1413

15-
Gets a line from the `stdin` stream. More secure versions of these functions are available; see [gets_s, _getws_s](../c-runtime-library/reference/gets-s-getws-s.md).
14+
Gets a line from the `stdin` stream. More secure versions of these functions are available; see [`gets_s`, `_getws_s`](../c-runtime-library/reference/gets-s-getws-s.md).
1615

1716
> [!IMPORTANT]
18-
> These functions are obsolete. Beginning in Visual Studio 2015, they are not available in the CRT. The secure versions of these functions, gets_s and _getws_s, are still available. For information on these alternative functions, see [gets_s, _getws_s](../c-runtime-library/reference/gets-s-getws-s.md).
17+
> These functions are obsolete. Beginning in Visual Studio 2015, they are not available in the CRT. The secure versions of these functions, `gets_s` and `_getws_s`, are still available. For information on these alternative functions, see [`gets_s`, `_getws_s`](../c-runtime-library/reference/gets-s-getws-s.md).
1918
2019
> [!IMPORTANT]
2120
> This API cannot be used in applications that execute in the Windows Runtime. For more information, see [CRT functions not supported in Universal Windows Platform apps](../cppcx/crt-functions-not-supported-in-universal-windows-platform-apps.md).
@@ -41,19 +40,19 @@ wchar_t *_getws(
4140

4241
#### Parameters
4342

44-
*buffer*<br/>
43+
*`buffer`*\
4544
Storage location for input string.
4645

4746
## Return Value
4847

49-
Returns its argument if successful. A **NULL** pointer indicates an error or end-of-file condition. Use [ferror](../c-runtime-library/reference/ferror.md) or [feof](../c-runtime-library/reference/feof.md) to determine which one has occurred. If `buffer` is **NULL**, these functions invoke an invalid parameter handler, as described in [Parameter Validation](../c-runtime-library/parameter-validation.md). If execution is allowed to continue, these functions return **NULL** and set errno to `EINVAL`.
48+
Returns its argument if successful. A **`NULL`** pointer indicates an error or end-of-file condition. Use [`ferror`](../c-runtime-library/reference/ferror.md) or [`feof`](../c-runtime-library/reference/feof.md) to determine which one has occurred. If `buffer` is **`NULL`**, these functions invoke an invalid parameter handler, as described in [Parameter Validation](../c-runtime-library/parameter-validation.md). If execution is allowed to continue, these functions return **`NULL`** and set `errno` to `EINVAL`.
5049

5150
## Remarks
5251

5352
The `gets` function reads a line from the standard input stream `stdin` and stores it in `buffer`. The line consists of all characters up to and including the first newline character ('\n'). `gets` then replaces the newline character with a null character ('\0') before returning the line. In contrast, the `fgets` function retains the newline character. `_getws` is a wide-character version of `gets`; its argument and return value are wide-character strings.
5453

5554
> [!IMPORTANT]
56-
> Because there is no way to limit the number of characters read by gets, untrusted input can easily cause buffer overruns. Use `fgets` instead.
55+
> Because there is no way to limit the number of characters read by `gets`, untrusted input can easily cause buffer overruns. Use `fgets` instead.
5756
5857
In C++, these functions have template overloads that invoke the newer, secure counterparts of these functions. For more information, see [Secure Template Overloads](../c-runtime-library/secure-template-overloads.md).
5958

@@ -69,8 +68,8 @@ By default, this function's global state is scoped to the application. To change
6968

7069
|Routine|Required header|
7170
|-------------|---------------------|
72-
|`gets`|\<stdio.h>|
73-
|`_getws`|\<stdio.h> or \<wchar.h>|
71+
|`gets`|`<stdio.h>`|
72+
|`_getws`|`<stdio.h>` or `<wchar.h>`|
7473

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

@@ -101,7 +100,7 @@ Hello there!The line entered was: Hello there!
101100

102101
## See also
103102

104-
[Stream I/O](../c-runtime-library/stream-i-o.md)<br/>
105-
[fgets, fgetws](../c-runtime-library/reference/fgets-fgetws.md)<br/>
106-
[fputs, fputws](../c-runtime-library/reference/fputs-fputws.md)<br/>
107-
[puts, _putws](../c-runtime-library/reference/puts-putws.md)
103+
[Stream I/O](../c-runtime-library/stream-i-o.md)\
104+
[`fgets`, `fgetws`](../c-runtime-library/reference/fgets-fgetws.md)\
105+
[`fputs`, `fputws`](../c-runtime-library/reference/fputs-fputws.md)\
106+
[`puts`, `_putws`](../c-runtime-library/reference/puts-putws.md)

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,12 @@ api_type: ["DLLExport"]
88
topic_type: ["apiref"]
99
f1_keywords: ["execl"]
1010
helpviewer_keywords: ["execl function"]
11-
ms.assetid: 10f24c52-7ff5-4a61-abcb-fce6d9553f23
1211
---
13-
# execl
12+
# `execl`
1413

15-
The Microsoft-implemented POSIX function name `execl` is a deprecated alias for the [_execl](execl-wexecl.md) function. By default, it generates [Compiler warning (level 3) C4996](../../error-messages/compiler-warnings/compiler-warning-level-3-c4996.md). The name is deprecated because it doesn't follow the Standard C rules for implementation-specific names. However, the function is still supported.
14+
The Microsoft-implemented POSIX function name `execl` is a deprecated alias for the [`_execl`](execl-wexecl.md) function. By default, it generates [Compiler warning (level 3) C4996](../../error-messages/compiler-warnings/compiler-warning-level-3-c4996.md). The name is deprecated because it doesn't follow the Standard C rules for implementation-specific names. However, the function is still supported.
1615

17-
We recommend you use [_execl](execl-wexecl.md) instead. Or, you can continue to use this function name, and disable the warning. For more information, see [Turn off the warning](../../error-messages/compiler-warnings/compiler-warning-level-3-c4996.md#turn-off-the-warning) and [POSIX function names](../../error-messages/compiler-warnings/compiler-warning-level-3-c4996.md#posix-function-names).
16+
We recommend you use [`_execl`](execl-wexecl.md) instead. Or, you can continue to use this function name, and disable the warning. For more information, see [Turn off the warning](../../error-messages/compiler-warnings/compiler-warning-level-3-c4996.md#turn-off-the-warning) and [POSIX function names](../../error-messages/compiler-warnings/compiler-warning-level-3-c4996.md#posix-function-names).
1817

1918
> [!IMPORTANT]
2019
> This API cannot be used in applications that execute in the Windows Runtime. For more information, see [CRT functions not supported in Universal Windows Platform apps](../../cppcx/crt-functions-not-supported-in-universal-windows-platform-apps.md).

docs/c-runtime-library/reference/sin-sinf-sinl.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@ api_type: ["DLLExport"]
88
topic_type: ["apiref"]
99
f1_keywords: ["_sinl", "sinf", "sinl", "sin"]
1010
helpviewer_keywords: ["_sinl function", "sinl function", "calculating sines", "sin function", "trigonometric functions", "sinf function"]
11-
ms.assetid: 737de73e-3590-45f9-8257-dc1c0c489dfc
1211
---
13-
# sin, sinf, sinl
12+
# `sin`, `sinf`, `sinl`
1413

1514
Calculates the sine of a floating-point value.
1615

@@ -30,34 +29,34 @@ long double sin(long double x); // C++ only
3029

3130
### Parameters
3231

33-
*x*\
32+
*`x`*\
3433
Angle in radians.
3534

3635
## Return value
3736

38-
The **sin** functions return the sine 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.
37+
The **`sin`** functions return the sine 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.
3938

4039
|Input|SEH Exception|Matherr Exception|
4140
|-----------|-------------------|-----------------------|
42-
|± QNAN,IND|None|_DOMAIN|
43-
|± ∞ (sin, sinf, sinl)|INVALID|_DOMAIN|
41+
|± `QNAN`,`IND`|None|`_DOMAIN`|
42+
|± ∞ (`sin`, `sinf`, `sinl`)|`INVALID`|`_DOMAIN`|
4443

45-
For more information about return codes, see [errno, _doserrno, _sys_errlist, and _sys_nerr](../../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md).
44+
For more information about return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md).
4645

4746
## Remarks
4847

49-
Because C++ allows overloading, you can call overloads of **sin** that take and return **`float`** or **`long double`** values. In a C program, unless you're using the \<tgmath.h> macro to call this function, **sin** always takes and returns **`double`**.
48+
Because C++ allows overloading, you can call overloads of **`sin`** that take and return **`float`** or **`long double`** values. In a C program, unless you're using the `<tgmath.h>` macro to call this function, **`sin`** always takes and returns **`double`**.
5049

51-
If you use the \<tgmath.h> `sin()` 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.
50+
If you use the `<tgmath.h> sin()` 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.
5251

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

5554
## Requirements
5655

5756
|Routine|Required header (C)|Required header (C++)|
5857
|-|-|-|
59-
|**sin**, **sinf**, **sinl**|\<math.h>|\<cmath> or \<math.h>|
60-
|**sin()** macro | \<tgmath.h> ||
58+
|**`sin`**, **`sinf`**, **`sinl`**|`<math.h>`|`<cmath>` or `<math.h>`|
59+
|**`sin()`** macro | `<tgmath.h>` ||
6160

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

@@ -91,10 +90,10 @@ cos( 1.570796 ) = 0.000000
9190

9291
## See also
9392

94-
[Floating-Point Support](../../c-runtime-library/floating-point-support.md)<br/>
95-
[acos, acosf, acosl](acos-acosf-acosl.md)<br/>
96-
[asin, asinf, asinl](asin-asinf-asinl.md)<br/>
97-
[atan, atanf, atanl, atan2, atan2f, atan2l](atan-atanf-atanl-atan2-atan2f-atan2l.md)<br/>
98-
[cos, cosf, cosl](cos-cosf-cosl.md)<br/>
99-
[tan, tanf, tanl](tan-tanf-tanl.md)<br/>
100-
[_CIsin](../../c-runtime-library/cisin.md)<br/>
93+
[Floating-Point Support](../../c-runtime-library/floating-point-support.md)\
94+
[`acos`, `acosf`, `acosl`](acos-acosf-acosl.md)\
95+
[`asin`, `asinf`, `asinl`](asin-asinf-asinl.md)\
96+
[`atan`, `atanf`, `atanl`, `atan2`, `atan2f`, `atan2l`](atan-atanf-atanl-atan2-atan2f-atan2l.md)\
97+
[`cos`, `cosf`, `cosl`](cos-cosf-cosl.md)\
98+
[`tan`, `tanf`, `tanl`](tan-tanf-tanl.md)\
99+
[`_CIsin`](../../c-runtime-library/cisin.md)\

docs/c-runtime-library/reference/sqrt-sqrtf-sqrtl.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@ api_type: ["DLLExport"]
88
topic_type: ["apiref"]
99
f1_keywords: ["sqrt", "sqrtf", "_sqrtl"]
1010
helpviewer_keywords: ["sqrtf function", "sqrt function", "sqrtl function", "_sqrtl function", "calculating square roots", "square roots, calculating"]
11-
ms.assetid: 2ba9467b-f172-41dc-8f10-b86f68fa813c
1211
---
13-
# sqrt, sqrtf, sqrtl
12+
# `sqrt`, `sqrtf`, `sqrtl`
1413

1514
Calculates the square root.
1615

@@ -37,33 +36,33 @@ long double sqrtl(
3736
3837
### Parameters
3938
40-
*x*\
39+
*`x`*\
4140
Non-negative floating-point value
4241
4342
## Remarks
4443
45-
Because C++ allows overloading, you can call overloads of **sqrt** that take **`float`** or **`long double`** types. In a C program, unless you're using the \<tgmath.h> macro to call this function, **sqrt** always takes and returns **`double`**.
44+
Because C++ allows overloading, you can call overloads of **`sqrt`** that take **`float`** or **`long double`** types. In a C program, unless you're using the `<tgmath.h>` macro to call this function, **`sqrt`** always takes and returns **`double`**.
4645
47-
If you use the \<tgmath.h> `sqrt()` 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.
46+
If you use the `<tgmath.h> sqrt()` 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.
4847
4948
By default, this function's global state is scoped to the application. To change this, see [Global state in the CRT](../global-state.md).
5049
5150
## Return Value
5251
53-
The **sqrt** functions return the square-root of *x*. By default, if *x* is negative, **sqrt** returns an indefinite NaN.
52+
The **`sqrt`** functions return the square-root of *`x`*. By default, if *`x`* is negative, **`sqrt`** returns an indefinite `NaN`.
5453
55-
|Input|SEH Exception|**_matherr** Exception|
54+
|Input|SEH Exception|**`_matherr`** Exception|
5655
|-----------|-------------------|--------------------------|
57-
|± QNAN,IND|none|_DOMAIN|
58-
|- ∞|none|_DOMAIN|
59-
|x<0|none|_DOMAIN|
56+
`QNAN`,`IND`|none|`_DOMAIN`|
57+
|- ∞|none|`_DOMAIN`|
58+
|`x<0`|none|`_DOMAIN`|
6059
6160
## Requirements
6261
6362
|Function|C header|C++ header|
6463
|--------------|--------------|------------------|
65-
|**sqrt**, **sqrtf**, **sqrtl**|\<math.h>|\<cmath>|
66-
|**sqrt()** macro | \<tgmath.h> ||
64+
|**`sqrt`**, **`sqrtf`**, **`sqrtl`**|`<math.h>`|`<cmath>`|
65+
|**`sqrt()`** macro | `<tgmath.h>` ||
6766
6867
For compatibility information, see [Compatibility](../../c-runtime-library/compatibility.md).
6968
@@ -94,8 +93,8 @@ The square root of 45.35 is 6.73
9493

9594
## See also
9695

97-
[Floating-Point Support](../../c-runtime-library/floating-point-support.md)<br/>
98-
[exp, expf, expl](exp-expf.md)<br/>
99-
[log, logf, log10, log10f](log-logf-log10-log10f.md)<br/>
100-
[pow, powf, powl](pow-powf-powl.md)<br/>
101-
[_CIsqrt](../../c-runtime-library/cisqrt.md)<br/>
96+
[Floating-Point Support](../../c-runtime-library/floating-point-support.md)\
97+
[`exp`, `expf`, `expl`](exp-expf.md)\
98+
[`log`, `logf`, `log10`, `log10f`](log-logf-log10-log10f.md)\
99+
[`pow`, `powf`, `powl`](pow-powf-powl.md)\
100+
[`_CIsqrt`](../../c-runtime-library/cisqrt.md)\

0 commit comments

Comments
 (0)