Merge pull request #3124 from MicrosoftDocs/master

9/8/2020 AM Publish

Author: Taojunshen

docs/c-runtime-library/crt-library-features.md

@@ -1,5 +1,6 @@
 ---
 title: "CRT Library Features"
+description: "This various .lib files that comprise the Microsoft C run-time libraries as well as their associated compiler options and preprocessor directives."
 ms.date: "08/20/2018"
 helpviewer_keywords: ["MSVCR71.dll", "libraries [C++], multithreaded", "library files, run-time", "LIBCMT.lib", "LIBCP.lib", "LIBCPMT.lib", "run-time libraries, C", "CRT, release versions", "MSVCP71.dll", "LIBC.lib", "libraries [C++]", "libraries [C++], run-time", "linking [C++], libraries"]
 ms.assetid: a889fd39-807d-48f2-807f-81492612463f
@@ -65,7 +66,7 @@ For more information on using the CRT with **/clr**, see [Mixed (Native and Mana
 
 To build a debug version of your application, the [_DEBUG](../c-runtime-library/debug.md) flag must be defined and the application must be linked with a debug version of one of these libraries. For more information about using the debug versions of the library files, see [CRT Debugging Techniques](/visualstudio/debugger/crt-debugging-techniques).
 
-This version of the CRT is not fully conformant with the C99 standard. In particular, the \<tgmath.h> header and the CX_LIMITED_RANGE/FP_CONTRACT pragma macros are not supported. Certain elements such as the meaning of parameter specifiers in standard IO functions use legacy interpretations by default. You can use /Zc compiler conformance options and specify linker options to control some aspects of library conformance,
+This version of the CRT is not fully conformant with the C99 standard. In particular, the \<tgmath.h> header and the CX_LIMITED_RANGE/FP_CONTRACT pragma macros are not supported. Certain elements such as the meaning of parameter specifiers in standard IO functions use legacy interpretations by default. You can use /Zc compiler conformance options and specify linker options to control some aspects of library conformance.
 
 ## C++ Standard Library
 

docs/c-runtime-library/global-state.md

@@ -1,5 +1,6 @@
 ---
 title: "Global state in the CRT"
+description: "Describes how shared global state is handled in the Universal C Runtime." 
 ms.date: "04/02/2020"
 helpviewer_keywords: ["CRT global state"]
 ---

docs/c-runtime-library/inp-inpw-inpd.md

@@ -39,7 +39,7 @@ I/O port number.
 
 ## Return Value
 
-The functions return the byte, word, or double word read from `port`. There is no error return.
+The functions return the byte, word, or double word read from `port`. There's no error return.
 
 ## Remarks
 

docs/c-runtime-library/reference/abs-labs-llabs-abs64.md

@@ -1,5 +1,6 @@
 ---
 title: "abs, labs, llabs, _abs64"
+description: "API reference for abs, labs, llabs, and _abs64; which calculates the absolute value of a value."
 ms.date: "04/05/2018"
 api_name: ["abs", "_abs64", "labs", "llabs"]
 api_location: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll", "api-ms-win-crt-utility-l1-1-0.dll"]
@@ -32,18 +33,18 @@ float abs( float n );   // C++ only
 
 ### Parameters
 
-*n*<br/>
+*n*\
 Numeric value.
 
 ## Return Value
 
-The **abs**, **labs**, **llabs** and **_abs64** functions return the absolute value of the parameter *n*. There is no error return.
+The **abs**, **labs**, **llabs**, and **_abs64** functions return the absolute value of the parameter *n*. There's no error return.
 
 ## Remarks
 
 Because C++ allows overloading, you can call overloads of **abs** that take and return **`long`**, **`long long`**, **`float`**, **`double`**, and **`long double`** values. These overloads are defined in the \<cmath> header. In a C program, **abs** always takes and returns an **`int`**.
 
-**Microsoft-specific**: Because the range of negative integers that can be represented by using any integral type is larger than the range of positive integers that can be represented by using that type, it's possible to supply an argument to these functions that can’t be converted. If the absolute value of the argument cannot be represented by the return type, the **abs** functions return the argument value unchanged. Specifically, `abs(INT_MIN)` returns `INT_MIN`, `labs(LONG_MIN)` returns `LONG_MIN`, `llabs(LLONG_MIN)` returns `LLONG_MIN`, and `_abs64(_I64_MIN)` returns `_I64_MIN`. This means that the **abs** functions cannot be used to guarantee a positive value.
+**Microsoft-specific**: Because the range of negative integers that can be represented by using any integral type is larger than the range of positive integers that can be represented by using that type, it's possible to supply an argument to these functions that can't be converted. If the absolute value of the argument cannot be represented by the return type, the **abs** functions return the argument value unchanged. Specifically, `abs(INT_MIN)` returns `INT_MIN`, `labs(LONG_MIN)` returns `LONG_MIN`, `llabs(LLONG_MIN)` returns `LLONG_MIN`, and `_abs64(_I64_MIN)` returns `_I64_MIN`. This means that the **abs** functions cannot be used to guarantee a positive value.
 
 ## Requirements
 

docs/c-runtime-library/reference/acos-acosf-acosl.md

@@ -1,6 +1,7 @@
 ---
 title: "acos, acosf, acosl"
-ms.date: "4/2/2020"
+description: "API reference for `acos`, `acosf`, and `acosl`; which calculate the arccosine of a floating-point value."
+ms.date: "08/31/2020"
 api_name: ["acosf", "acos", "acosl", "_o_acos"]
 api_location: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll", "api-ms-win-crt-math-l1-1-0.dll", "api-ms-win-crt-private-l1-1-0.dll"]
 api_type: ["DLLExport"]
@@ -19,16 +20,15 @@ Calculates the arccosine.
 double acos( double x );
 float acosf( float x );
 long double acosl( long double x );
-```
+#define acos(X) // Requires C11 or higher
 
-```cpp
 float acos( float x );   // C++ only
 long double acos( long double x );   // C++ only
 ```
 
 ### Parameters
 
-*x*<br/>
+*x*\
 Value between -1 and 1, for which to calculate the arccosine (the inverse cosine).
 
 ## Return Value
@@ -45,7 +45,9 @@ By default, if *x* is less than -1 or greater than 1, **acos** returns an indefi
 
 ## Remarks
 
-Because C++ allows overloading, you can call overloads of **acos** that take and return **`float`** and **`long double`** types. In a C program, **acos** always takes and returns a **`double`**.
+Because C++ allows overloading, you can call overloads of **acos** that take and return **`float`** and **`long double`** types. In a C program, unless you're using the \<tgmath.h> macro to call this function, **acos** always takes and returns a **`double`**.
+
+If you use the \<tgmath.h> `acos()` 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.
 
 By default, this function's global state is scoped to the application. To change this, see [Global state in the CRT](../global-state.md).
 
@@ -54,6 +56,7 @@ By default, this function's global state is scoped to the application. To change
 |Routine|Required header|Optional headers|
 |-------------|---------------------|----------------------|
 |**acos**, **acosf**, **acosl**|\<math.h>|\<errno.h>|
+|**acos()** macro | \<tgmath.h> ||
 
 ## Example
 

docs/c-runtime-library/reference/acosh-acoshf-acoshl.md

@@ -1,6 +1,7 @@
 ---
 title: "acosh, acoshf, acoshl"
-ms.date: "4/2/2020"
+description: "API reference for acosh, acoshf, and acoshl; which calculate the inverse hyperbolic cosine of a floating-point value."
+ms.date: "08/31/2020"
 api_name: ["acoshf", "acosh", "acoshl", "_o_acosh", "_o_acoshf", "_o_acoshl"]
 api_location: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll", "api-ms-win-crt-math-l1-1-0.dll", "api-ms-win-crt-private-l1-1-0.dll"]
 api_type: ["DLLExport"]
@@ -19,16 +20,15 @@ Calculates the inverse hyperbolic cosine.
 double acosh( double x );
 float acoshf( float x );
 long double acoshl( long double x );
-```
+#define acosh(X) // Requires C11 or higher
 
-```cpp
 float acosh( float x );  // C++ only
 long double acosh( long double x );  // C++ only
 ```
 
 ### Parameters
 
-*x*<br/>
+*x*\
 Floating-point value.
 
 ## Return Value
@@ -42,7 +42,9 @@ The **acosh** functions return the inverse hyberbolic cosine (arc hyperbolic cos
 
 ## Remarks
 
-When you use C++, you can call overloads of **acosh** that take and return **`float`** or **`long double`** values. In a C program, **acosh** always takes and returns **`double`**.
+When you use C++, you can call overloads of **acosh** 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, **acosh** always takes and returns **`double`**.
+
+If you use the \<tgmath.h> `acosh()` 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.
 
 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,6 +53,7 @@ By default, this function's global state is scoped to the application. To change
 |Function|C header|C++ header|
 |--------------|--------------|------------------|
 |**acosh**, **acoshf**, **acoshl**|\<math.h>|\<cmath>|
+|**acosh()** macro | \<tgmath.h> ||
 
 For additional compatibility information, see [Compatibility](../../c-runtime-library/compatibility.md).
 

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

@@ -1,6 +1,7 @@
 ---
 title: "asin, asinf, asinl"
-ms.date: "4/2/2020"
+description: "API reference for asin, asinf, and asinl; which calculate the arcsine of a floating-point value."
+ms.date: "08/31/2020"
 api_name: ["asinf", "asinl", "asin", "_o_asin"]
 api_location: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll", "api-ms-win-crt-math-l1-1-0.dll", "api-ms-win-crt-private-l1-1-0.dll"]
 api_type: ["DLLExport"]
@@ -19,16 +20,15 @@ Calculates the arcsine.
 double asin( double x );
 float asinf ( float x );
 long double asinl( long double x );
-```
+#define asin(X) // Requires C11 or higher
 
-```cpp
 float asin( float x );  // C++ only
 long double asin( long double x );  // C++ only
 ```
 
 ### Parameters
 
-*x*<br/>
+*x*\
 Value whose arcsine is to be calculated.
 
 ## Return Value
@@ -45,7 +45,9 @@ By default, if *x* is less than -1 or greater than 1, **asin** returns an indefi
 
 ## Remarks
 
-Because C++ allows overloading, you can call overloads of **asin** with **`float`** and **`long double`** values. In a C program, **asin** always takes and returns a **`double`**.
+Because C++ allows overloading, you can call overloads of **asin** with **`float`** and **`long double`** values. In a C program, unless you're using the \<tgmath.h> macro to call this function, **asin** always takes and returns a **`double`**.
+
+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.
 
 By default, this function's global state is scoped to the application. To change this, see [Global state in the CRT](../global-state.md).
 
@@ -54,6 +56,7 @@ By default, this function's global state is scoped to the application. To change
 |Routine|Required header (C)|Required header (C++)|
 |-------------|---------------------|-|
 |**asin**, **asinf**, **asinl**|\<math.h>|\<cmath> or \<math.h>|
+|**asin()** macro | \<tgmath.h> ||
 
 ## Example
 

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

@@ -1,6 +1,7 @@
 ---
 title: "asinh, asinhf, asinhl"
-ms.date: "4/2/2020"
+description: "API reference for asinh, asinhf, and asinhl; which calculate the inverse hyperbolic sine of a floating-point value."
+ms.date: "08/31/2020"
 api_name: ["asinh", "asinhf", "asinhl", "_o_asinh", "_o_asinhf", "_o_asinhl"]
 api_location: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll", "api-ms-win-crt-math-l1-1-0.dll", "api-ms-win-crt-private-l1-1-0.dll"]
 api_type: ["DLLExport"]
@@ -19,9 +20,8 @@ Calculates the inverse hyperbolic sine.
 double asinh( double x );
 float asinhf( float x );
 long double asinhl( long double x );
-```
+#define asinh(X) // Requires C11 or higher
 
-```cpp
 float asinh( float x );  // C++ only
 long double asinh( long double x );  // C++ only
 ```
@@ -41,15 +41,19 @@ The **asinh** functions return the inverse hyberbolic sine (arc hyperbolic sine)
 
 ## Remarks
 
-When you use C++, you can call overloads of **asinh** that take and return **`float`** or **`long double`** values. In a C program, **asinh** always takes and returns **`double`**.
+When you use C++, you can call overloads of **asinh** 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, **asinh** always takes and returns **`double`**.
+
+If you use the \<tgmath.h> `asinh()` 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.
+
 
 By default, this function's global state is scoped to the application. To change this, see [Global state in the CRT](../global-state.md).
 
 ## Requirements
 
 |Function|Required C header|Required C++ header|
 |--------------|--------------|------------------|
-|**asinh**, **asinhf**, **asinhl**|\<math.h>|\<cmath> or \<math.h<|
+|**asinh**, **asinhf**, **asinhl**|\<math.h>|\<cmath> or \<math.h>|
+|**asinh()** macro | \<tgmath.h> ||
 
 For additional compatibility information, see [Compatibility](../../c-runtime-library/compatibility.md).
 

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

@@ -1,6 +1,7 @@
 ---
 title: "atan, atanf, atanl, atan2, atan2f, atan2l"
-ms.date: "6/5/2020"
+description: "API reference for atan, atanf, atanl, atan2, atan2f, and atan2l; which calculate the arctangent of a floating-point value."
+ms.date: "08/31/2020"
 api_name: ["atan2f", "atan2l", "atan2", "atanf", "atan", "atanl", "_o_atan", "_o_atan2", "_o_atan2f"]
 api_location: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll", "api-ms-win-crt-math-l1-1-0.dll", "api-ms-win-crt-private-l1-1-0.dll"]
 api_type: ["DLLExport"]
@@ -19,23 +20,23 @@ Calculates the arctangent of **x** (**atan**, **atanf**, and **atanl**) or the a
 double atan( double x );
 float atanf( float x );
 long double atanl( long double x );
+#define atan(X) // Requires C11 or higher
+
+float atan( float x );  // C++ only
+long double atan( long double x );  // C++ only
 
 double atan2( double y, double x );
 float atan2f( float y, float x );
 long double atan2l( long double y, long double x );
-```
-
-```cpp
-float atan( float x );  // C++ only
-long double atan( long double x );  // C++ only
+#define atan2(Y, X) // Requires C11 or higher
 
 float atan2( float y, float x );  // C++ only
 long double atan2( long double y, long double x );  // C++ only
 ```
 
 ### Parameters
 
-*x*, *y*<br/>
+*x*, *y*\
 Any numbers.
 
 ## Return Value
@@ -52,9 +53,11 @@ Any numbers.
 
 The **atan** function calculates the arctangent (the inverse tangent function) of *x*. **atan2** calculates the arctangent of *y*/*x* (if *x* equals 0, **atan2** returns π/2 if *y* is positive, -π/2 if *y* is negative, or 0 if *y* is 0.)
 
+If you use the \<tgmath.h> `atan()` or `atan2()` 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.
+
 **atan** 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).
 
-Because C++ allows overloading, you can call overloads of **atan** and **atan2** that take **`float`** or **`long double`** arguments. In a C program, **atan** and **atan2** always take **`double`** arguments and return a **`double`**.
+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`**.
 
 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,6 +66,7 @@ By default, this function's global state is scoped to the application. To change
 |Routine|Required header (C)|Required header (C++)|
 |-------------|---------------------|-|
 |**atan**, **atan2**, **atanf**, **atan2f**, **atanl**, **atan2l**|\<math.h>|\<cmath> or \<math.h>|
+|**atan()**, **atan2** macros | \<tgmath.h> ||
 
 ## Example
 

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

@@ -1,6 +1,7 @@
 ---
 title: "atanh, atanhf, atanhl"
-ms.date: "4/2/2020"
+description: "API reference for atanh, atanhf, and atanhl; which calculate the inverse hyperbolic tangent of a floating-point value."
+ms.date: "08/31/2020"
 api_name: ["atanhl", "atanhf", "atanh", "_o_atanh", "_o_atanhf", "_o_atanhl"]
 api_location: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll", "api-ms-win-crt-math-l1-1-0.dll", "api-ms-win-crt-private-l1-1-0.dll"]
 api_type: ["DLLExport"]
@@ -19,16 +20,15 @@ Calculates the inverse hyperbolic tangent.
 double atanh( double x );
 float atanhf( float x );
 long double atanhl( long double x );
-```
+#define atanh(X) // Requires C11 or higher
 
-```cpp
 float atanh( float x );  // C++ only
 long double atanh( long double x );  // C++ only
 ```
 
 ### Parameters
 
-*x*<br/>
+*x*\
 Floating-point value.
 
 ## Return Value
@@ -42,7 +42,9 @@ The **atanh** functions return the inverse hyberbolic tangent (arc hyperbolic ta
 
 ## Remarks
 
-Because C++ allows overloading, you can call overloads of **atanh** that take and return **`float`** or **`long double`** values. In a C program, **atanh** always takes and returns **`double`**.
+Because C++ allows overloading, you can call overloads of **atanh** 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, **atanh** always takes and returns **`double`**.
+
+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.
 
 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,6 +53,7 @@ By default, this function's global state is scoped to the application. To change
 |Function|C header|C++ header|
 |--------------|--------------|------------------|
 |**atanh**, **atanhf**, **atanhl**|\<math.h>|\<cmath> or \<math.h>|
+|**atanh()** macro | \<tgmath.h> ||
 
 For additional compatibility information, see [Compatibility](../../c-runtime-library/compatibility.md).