diff --git a/docs/c-runtime-library/32-bit-windows-time-date-formats.md b/docs/c-runtime-library/32-bit-windows-time-date-formats.md index 28c4ca9b839..dfe8f3f72eb 100644 --- a/docs/c-runtime-library/32-bit-windows-time-date-formats.md +++ b/docs/c-runtime-library/32-bit-windows-time-date-formats.md @@ -12,20 +12,20 @@ The file time and the date are stored individually, using unsigned integers as b ### Time -|Bit position:|0 1 2 3 4|5 6 7 8 9 A|B C D E F| -|-------------------|-----------------------|---------------------------|-----------------------| -|Length:|5|6|5| -|Contents:|hours|minutes|2-second increments| -|Value Range:|0-23|0-59|0-29 in 2-second intervals| +| Bit position: | 0 1 2 3 4 | 5 6 7 8 9 A | B C D E F | +|---|---|---|---| +| Length: | 5 | 6 | 5 | +| Contents: | hours | minutes | 2-second increments | +| Value Range: | 0-23 | 0-59 | 0-29 in 2-second intervals | ### Date -|Bit position:|0 1 2 3 4 5 6|7 8 9 A|B C D E F| -|-------------------|-------------------------------|-------------------|-----------------------| -|Length:|7|4|5| -|Contents:|year|month|day| -|Value Range:|0-119|1-12|1-31| -||(relative to 1980)||| +| Bit position: | 0 1 2 3 4 5 6 | 7 8 9 A | B C D E F | +|---|---|---|---| +| Length: | 7 | 4 | 5 | +| Contents: | year | month | day | +| Value Range: | 0-119 | 1-12 | 1-31 | +| | (relative to 1980) | | | ## See also diff --git a/docs/c-runtime-library/abnormal-termination.md b/docs/c-runtime-library/abnormal-termination.md index 87abacd61cd..f513fc45d1d 100644 --- a/docs/c-runtime-library/abnormal-termination.md +++ b/docs/c-runtime-library/abnormal-termination.md @@ -6,7 +6,7 @@ api_name: ["_abnormal_termination"] api_location: ["msvcr110.dll", "msvcr110_clr0400.dll", "msvcr90.dll", "msvcr120.dll", "msvcrt.dll", "msvcr80.dll", "msvcr100.dll"] api_type: ["DLLExport"] topic_type: ["apiref"] -f1_keywords: ["_abnormal_termination"] +f1_keywords: ["_abnormal_termination", "EXCPT/_abnormal_termination"] helpviewer_keywords: ["_abnormal_termination"] ms.assetid: 952970a4-9586-4c3d-807a-db729448c91c --- @@ -27,13 +27,13 @@ int _abnormal_termination( ## Remarks -`_abnormal_termination` is an internal function used to manage unwinding exceptions, and isn't intended to be called from user code. +**`_abnormal_termination`** is an internal function used to manage unwinding exceptions, and isn't intended to be called from user code. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|_abnormal_termination|excpt.h| +| Routine | Required header | +|---|---| +| **`_abnormal_termination`** | `` | ## See also diff --git a/docs/c-runtime-library/acmdln-tcmdln-wcmdln.md b/docs/c-runtime-library/acmdln-tcmdln-wcmdln.md index 675ff9bfbd0..4d60eaa7afd 100644 --- a/docs/c-runtime-library/acmdln-tcmdln-wcmdln.md +++ b/docs/c-runtime-library/acmdln-tcmdln-wcmdln.md @@ -6,7 +6,7 @@ api_name: ["_wcmdln", "_acmdln"] api_location: ["msvcrt.dll"] api_type: ["DLLExport"] topic_type: ["apiref"] -f1_keywords: ["_acmdln", "acmdln", "_wcmdln", "wcmdln", "_tcmdln", "tcmdln"] +f1_keywords: ["_acmdln", "_wcmdln", "_tcmdln"] helpviewer_keywords: ["_wcmdln global variable", "wcmdln global variable", "_acmdln global variable", "_tcmdln global variable", "tcmdln global variable", "acmdln global variable"] ms.assetid: 4fc0a6a0-3f93-420a-a19f-5276061ba539 --- @@ -16,7 +16,7 @@ Internal CRT global variable. The command line. ## Syntax -``` +```C char * _acmdln; wchar_t * _wcmdln; diff --git a/docs/c-runtime-library/ansi-c-compliance.md b/docs/c-runtime-library/ansi-c-compliance.md index 115280fb685..e9aad2a0856 100644 --- a/docs/c-runtime-library/ansi-c-compliance.md +++ b/docs/c-runtime-library/ansi-c-compliance.md @@ -3,7 +3,6 @@ title: "ANSI C Conformance" description: "An overview of Microsoft C runtime naming conventions for ANSI C conformance." ms.date: "11/04/2016" ms.topic: "conceptual" -f1_keywords: ["Ansi"] helpviewer_keywords: ["underscores, leading", "compatibility [C++], ANSI C", "conformance with ANSI C", "conventions [C++], Microsoft extensions", "underscores", "naming conventions [C++], Microsoft library", "ANSI [C++], C standard", "Microsoft extensions naming conventions"] ms.assetid: 6be271bf-eecf-491a-a928-0ee2dd60e3b9 --- diff --git a/docs/c-runtime-library/argc-argv-wargv.md b/docs/c-runtime-library/argc-argv-wargv.md index 5ed4577bde4..776f920bae5 100644 --- a/docs/c-runtime-library/argc-argv-wargv.md +++ b/docs/c-runtime-library/argc-argv-wargv.md @@ -6,14 +6,14 @@ api_name: ["__wargv", "__argv", "__argc"] api_location: ["msvcrt120.dll"] api_type: ["DLLExport"] topic_type: ["apiref"] -f1_keywords: ["__argv", "__argc", "__wargv"] +f1_keywords: ["__argc", "STDLIB/__argc", "__argv", "STDLIB/__argv", "__wargv", "STDLIB/__wargv"] helpviewer_keywords: ["__argv", "__wargv", "__argc"] ms.assetid: 17001b0a-04ad-4762-b3a6-c54847f02d7c no-loc: [__argc, __argv, __wargv, main, wmain] --- # `__argc`, `__argv`, `__wargv` -The `__argc` global variable is a count of the number of command-line arguments passed to the program. `__argv` is a pointer to an array of single-byte-character or multi-byte-character strings that contain the program arguments, and `__wargv` is a pointer to an array of wide-character strings that contain the program arguments. These global variables provide the arguments to `main` or `wmain`. +The **`__argc`** global variable is a count of the number of command-line arguments passed to the program. **`__argv`** is a pointer to an array of single-byte-character or multi-byte-character strings that contain the program arguments, and **`__wargv`** is a pointer to an array of wide-character strings that contain the program arguments. These global variables provide the arguments to `main` or `wmain`. ## Syntax @@ -25,23 +25,23 @@ extern wchar_t ** __wargv; ## Remarks -In a program that uses the `main` function, `__argc` and `__argv` are initialized at program startup by using the command line that's used to start the program. The command line is parsed into individual arguments, and wildcards are expanded. The count of arguments is assigned to `__argc` and the argument strings are allocated on the heap, and a pointer to the array of arguments is assigned to `__argv`. In a program compiled to use wide characters and a `wmain` function, the arguments are parsed and wildcards are expanded as wide-character strings, and a pointer to the array of argument strings is assigned to `__wargv`. +In a program that uses the `main` function, **`__argc`** and **`__argv`** are initialized at program startup by using the command line that's used to start the program. The command line is parsed into individual arguments, and wildcards are expanded. The count of arguments is assigned to **`__argc`** and the argument strings are allocated on the heap, and a pointer to the array of arguments is assigned to **`__argv`**. In a program compiled to use wide characters and a `wmain` function, the arguments are parsed and wildcards are expanded as wide-character strings, and a pointer to the array of argument strings is assigned to **`__wargv`**. For portable code, we recommend you use the arguments passed to `main` to get the command-line arguments in your program. ### Generic-text routine mappings -|Tchar.h routine|_UNICODE not defined|_UNICODE defined| -|---------------------|---------------------------|-----------------------| -|`__targv`|`__argv`|`__wargv`| +| Tchar.h routine | `_UNICODE` not defined | `_UNICODE` defined | +|---|---|---| +| `__targv` | **`__argv`** | **`__wargv`** | ## Requirements -|Global variable|Required header| -|---------------------|---------------------| -|`__argc`, `__argv`, `__wargv`|\, \ (C++)| +| Global variable | Required header | +|---|---| +| **`__argc`**, **`__argv`**, **`__wargv`** | \, \ (C++) | -`__argc`, `__argv`, and `__wargv` are Microsoft extensions. For compatibility information, see [Compatibility](./compatibility.md). +**`__argc`**, **`__argv`**, and **`__wargv`** are Microsoft extensions. For compatibility information, see [Compatibility](./compatibility.md). ## See also diff --git a/docs/c-runtime-library/argument-access.md b/docs/c-runtime-library/argument-access.md index a19f0ec69ac..a596c13d288 100644 --- a/docs/c-runtime-library/argument-access.md +++ b/docs/c-runtime-library/argument-access.md @@ -12,11 +12,11 @@ The `va_arg`, `va_end`, and `va_start` macros provide access to function argumen ## Argument-access macros -|Macro|Use| -|-----------|-------------------------------| -|[`va_arg`](./reference/va-arg-va-copy-va-end-va-start.md)|Retrieve argument from list| -|[`va_end`](./reference/va-arg-va-copy-va-end-va-start.md)|Reset pointer| -|[`va_start`](./reference/va-arg-va-copy-va-end-va-start.md)|Set pointer to beginning of argument list| +| Macro | Use | +|---|---| +| [`va_arg`](./reference/va-arg-va-copy-va-end-va-start.md) | Retrieve argument from list | +| [`va_end`](./reference/va-arg-va-copy-va-end-va-start.md) | Reset pointer | +| [`va_start`](./reference/va-arg-va-copy-va-end-va-start.md) | Set pointer to beginning of argument list | ## See also diff --git a/docs/c-runtime-library/buffer-manipulation.md b/docs/c-runtime-library/buffer-manipulation.md index bcf5dfc49a8..21c4336737a 100644 --- a/docs/c-runtime-library/buffer-manipulation.md +++ b/docs/c-runtime-library/buffer-manipulation.md @@ -11,16 +11,16 @@ Use these routines to work with areas of memory on a byte-by-byte basis. ## Buffer-manipulation routines -|Routine|Use| -|-------------|---------| -|[`_memccpy`](./reference/memccpy.md)|Copy characters from one buffer to another until given character or given number of characters has been copied| -|[`memchr`, `wmemchr`](./reference/memchr-wmemchr.md)|Return pointer to first occurrence, within specified number of characters, of given character in buffer| -|[`memcmp`, `wmemcmp`](./reference/memcmp-wmemcmp.md)|Compare specified number of characters from two buffers| -|[`memcpy`, `wmemcpy`](./reference/memcpy-wmemcpy.md), [`memcpy_s`, `wmemcpy_s`](./reference/memcpy-s-wmemcpy-s.md)|Copy specified number of characters from one buffer to another| -|[`_memicmp`, `_memicmp_l`](./reference/memicmp-memicmp-l.md)|Compare specified number of characters from two buffers without regard to case| -|[`memmove`, `wmemmove`](./reference/memmove-wmemmove.md),[`memmove_s`, `wmemmove_s`](./reference/memmove-s-wmemmove-s.md)|Copy specified number of characters from one buffer to another| -|[`memset`, `wmemset`](./reference/memset-wmemset.md)|Use given character to initialize specified number of bytes in the buffer| -|[`_swab`](./reference/swab.md)|Swap bytes of data and store them at specified location| +| Routine | Use | +|---|---| +| [`_memccpy`](./reference/memccpy.md) | Copy characters from one buffer to another until given character or given number of characters has been copied | +| [`memchr`, `wmemchr`](./reference/memchr-wmemchr.md) | Return pointer to first occurrence, within specified number of characters, of given character in buffer | +| [`memcmp`, `wmemcmp`](./reference/memcmp-wmemcmp.md) | Compare specified number of characters from two buffers | +| [`memcpy`, `wmemcpy`](./reference/memcpy-wmemcpy.md), [`memcpy_s`, `wmemcpy_s`](./reference/memcpy-s-wmemcpy-s.md) | Copy specified number of characters from one buffer to another | +| [`_memicmp`, `_memicmp_l`](./reference/memicmp-memicmp-l.md) | Compare specified number of characters from two buffers without regard to case | +| [`memmove`, `wmemmove`](./reference/memmove-wmemmove.md),[`memmove_s`, `wmemmove_s`](./reference/memmove-s-wmemmove-s.md) | Copy specified number of characters from one buffer to another | +| [`memset`, `wmemset`](./reference/memset-wmemset.md) | Use given character to initialize specified number of bytes in the buffer | +| [`_swab`](./reference/swab.md) | Swap bytes of data and store them at specified location | When the source and target areas overlap, only `memmove` is guaranteed to copy the full source properly. diff --git a/docs/c-runtime-library/bufsiz.md b/docs/c-runtime-library/bufsiz.md index 410a1c201f9..35fcf77acfe 100644 --- a/docs/c-runtime-library/bufsiz.md +++ b/docs/c-runtime-library/bufsiz.md @@ -2,7 +2,7 @@ description: "Learn more about: BUFSIZ" title: "BUFSIZ" ms.date: "11/04/2016" -f1_keywords: ["BUFSIZ"] +f1_keywords: ["BUFSIZ", "STDIO/BUFSIZ"] helpviewer_keywords: ["BUFSIZ constant"] ms.assetid: 94ac04a3-d154-476b-bd89-eefbc7b949ae --- @@ -10,7 +10,7 @@ ms.assetid: 94ac04a3-d154-476b-bd89-eefbc7b949ae ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/byte-and-wide-streams.md b/docs/c-runtime-library/byte-and-wide-streams.md index 6e59ac7be8c..634f4df7b88 100644 --- a/docs/c-runtime-library/byte-and-wide-streams.md +++ b/docs/c-runtime-library/byte-and-wide-streams.md @@ -3,7 +3,6 @@ title: "Byte and Wide Streams" description: "An overview of byte streams in the Microsoft C runtime library." ms.date: "11/04/2016" ms.topic: "conceptual" -f1_keywords: ["Byte and Wide Streams"] helpviewer_keywords: ["byte streams", "wide streams"] ms.assetid: 61ef0587-4cbc-4eb8-aae5-4c298dbbc6f9 --- diff --git a/docs/c-runtime-library/cgets-cgetws.md b/docs/c-runtime-library/cgets-cgetws.md index 4513784af30..1443775ff92 100644 --- a/docs/c-runtime-library/cgets-cgetws.md +++ b/docs/c-runtime-library/cgets-cgetws.md @@ -22,7 +22,7 @@ Gets a character string from the console. More secure versions of these function ## Syntax -``` +```C char *_cgets( char *buffer ); @@ -46,13 +46,13 @@ Storage location for data. ## Return value -`_cgets` and `_cgetws` return a pointer to the start of the string, at `buffer[2]`. If `buffer` is `NULL`, these functions invoke the invalid parameter handler, as described in [Parameter validation](./parameter-validation.md). If execution is allowed to continue, they return `NULL` and set `errno` to `EINVAL`. +**`_cgets`** and **`_cgetws`** return a pointer to the start of the string, at `buffer[2]`. If *`buffer`* is `NULL`, these functions invoke the invalid parameter handler, as described in [Parameter validation](./parameter-validation.md). If execution is allowed to continue, they return `NULL` and set `errno` to `EINVAL`. ## Remarks -These functions read a string of characters from the console and store the string and its length in the location pointed to by `buffer`. The `buffer` parameter must be a pointer to a character array. The first element of the array, `buffer[0]`, must contain the maximum length (in characters) of the string to be read. The array must contain enough elements to hold the string, a terminating null character ('\0'), and 2 extra bytes. The function reads characters until a carriage return-line feed (CR-LF) combination or the specified number of characters is read. The string is stored starting at `buffer[2]`. If the function reads a CR-LF, it stores the null character ('\0'). The function then stores the actual length of the string in the second array element, `buffer[1]`. +These functions read a string of characters from the console and store the string and its length in the location pointed to by *`buffer`*. The *`buffer`* parameter must be a pointer to a character array. The first element of the array, `buffer[0]`, must contain the maximum length (in characters) of the string to be read. The array must contain enough elements to hold the string, a terminating null character ('\0'), and 2 extra bytes. The function reads characters until a carriage return-line feed (CR-LF) combination or the specified number of characters is read. The string is stored starting at `buffer[2]`. If the function reads a CR-LF, it stores the null character ('\0'). The function then stores the actual length of the string in the second array element, `buffer[1]`. -Because all editing keys are active when `_cgets` or `_cgetws` is called while in a console window, pressing the F3 key repeats the last entered entry. +Because all editing keys are active when **`_cgets`** or **`_cgetws`** is called while in a console window, pressing the F3 key repeats the last entered entry. In C++, these functions have template overloads that invoke the newer, secure counterparts of these functions. For more information, see [Secure template overloads](./secure-template-overloads.md). @@ -60,16 +60,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_cgetts`|`_cgets`|`_cgets`|`_cgetws`| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_cgetts` | **`_cgets`** | **`_cgets`** | **`_cgetws`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`_cgets`|\| -|`_cgetws`|\ or \| +| Routine | Required header | +|---|---| +| **`_cgets`** | \ | +| **`_cgetws`** | \ or \ | For more compatibility information, see [Compatibility](./compatibility.md). diff --git a/docs/c-runtime-library/character-classification.md b/docs/c-runtime-library/character-classification.md index 8a8cad773d2..3a040c99cc1 100644 --- a/docs/c-runtime-library/character-classification.md +++ b/docs/c-runtime-library/character-classification.md @@ -21,33 +21,33 @@ if ((c >= 'A') && (c <= 'Z')) || ((c >= 'a') && (c <= 'z')) ## Character-classification routines -|Routine|Character test condition| -|-------------|------------------------------| -|[`isalnum`, `iswalnum`, `_isalnum_l`, `_iswalnum_l`](./reference/isalnum-iswalnum-isalnum-l-iswalnum-l.md), [`_ismbcalnum`, `_ismbcalnum_l`, `_ismbcalpha`, `_ismbcalpha_l`, `_ismbcdigit`, `_ismbcdigit_l`](./reference/ismbcalnum-functions.md)|Alphanumeric| -|[`_ismbcalnum`, `_ismbcalnum_l`, `_ismbcalpha`, `_ismbcalpha_l`, `_ismbcdigit`, `_ismbcdigit_l`](./reference/ismbcalnum-functions.md)|Multibyte alphanumeric| -|[`isalpha`, `iswalpha`, `_isalpha_l`, `_iswalpha_l`](./reference/isalpha-iswalpha-isalpha-l-iswalpha-l.md), [`_ismbcalnum`, `_ismbcalnum_l`, `_ismbcalpha`, `_ismbcalpha_l`, `_ismbcdigit`, `_ismbcdigit_l`](./reference/ismbcalnum-functions.md)|Alphabetic| -|[`isascii`, `__isascii`, `iswascii`](./reference/isascii-isascii-iswascii.md)|ASCII| -|[`isblank`, `iswblank`, `_isblank_l`, `_iswblank_l`](./reference/isblank-iswblank-isblank-l-iswblank-l.md), [`_ismbcsblank`, `_ismbcsblank_l`](./reference/ismbcgraph-functions.md)|Blank (space or horizontal tab)| -|[`iscntrl`, `iswcntrl`, `_iscntrl_l`, `_iswcntrl_l`](./reference/iscntrl-iswcntrl-iscntrl-l-iswcntrl-l.md)|Control| -|[`iscsym`, `iscsymf`, `__iscsym`, `__iswcsym`, `__iscsymf`, `__iswcsymf`, `_iscsym_l`, `_iswcsym_l`, `_iscsymf_l`, `_iswcsymf_l`](./reference/iscsym-functions.md)|Letter, underscore, or digit| -|[`iscsym`, `iscsymf`, `__iscsym`, `__iswcsym`, `__iscsymf`, `__iswcsymf`, `_iscsym_l`, `_iswcsym_l`, `_iscsymf_l`, `_iswcsymf_l`](./reference/iscsym-functions.md)|Letter or underscore| -|[`isdigit`, `iswdigit`, `_isdigit_l`, `_iswdigit_l`](./reference/isdigit-iswdigit-isdigit-l-iswdigit-l.md), [`_ismbcalnum`, `_ismbcalnum_l`, `_ismbcalpha`, `_ismbcalpha_l`, `_ismbcdigit`, `_ismbcdigit_l`](./reference/ismbcalnum-functions.md)|Decimal digit| -|[`isgraph`, `iswgraph`, `_isgraph_l`, `_iswgraph_l`](./reference/isgraph-iswgraph-isgraph-l-iswgraph-l.md), [`_ismbcgraph`, `_ismbcgraph_l`, `_ismbcprint`, `_ismbcprint_l`, `_ismbcpunct`, `_ismbcpunct_l`, `_ismbcblank`, `_ismbcblank_l`, `_ismbcspace`, `_ismbcspace_l`](./reference/ismbcgraph-functions.md)|Printable other than space| -|[`islower`, `iswlower`, `_islower_l`, `_iswlower_l`](./reference/islower-iswlower-islower-l-iswlower-l.md), [`_ismbclower`, `_ismbclower_l`, `_ismbcupper`, `_ismbcupper_l`](./reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md)|Lowercase| -|[`_ismbchira`, `_ismbchira_l`, `_ismbckata`, `_ismbckata_l`](./reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md)|Hiragana| -|[`_ismbchira`, `_ismbchira_l`, `_ismbckata`, `_ismbckata_l`](./reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md)|Katakana| -|[`_ismbclegal`, `_ismbclegal_l`, `_ismbcsymbol`, `_ismbcsymbol_l`](./reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md)|Legal multibyte character| -|[`_ismbcl0`, `_ismbcl0_l`, `_ismbcl1`, `_ismbcl1_l`, `_ismbcl2`, `_ismbcl2_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md)|Japan-level 0 multibyte character| -|[`_ismbcl0`, `_ismbcl0_l`, `_ismbcl1`, `_ismbcl1_l`, `_ismbcl2`, `_ismbcl2_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md)|Japan-level 1 multibyte character| -|[`_ismbcl0`, `_ismbcl0_l`, `_ismbcl1`, `_ismbcl1_l`, `_ismbcl2`, `_ismbcl2_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md)|Japan-level 2 multibyte character| -|[`_ismbclegal`, `_ismbclegal_l`, `_ismbcsymbol`, `_ismbcsymbol_l`](./reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md)|Non-alphanumeric multibyte character| -|[`isprint`, `iswprint`, `_isprint_l`, `_iswprint_l`](./reference/isprint-iswprint-isprint-l-iswprint-l.md), [`_ismbcgraph`, `_ismbcgraph_l`, `_ismbcprint`, `_ismbcprint_l`, `_ismbcpunct`, `_ismbcpunct_l`, `_ismbcblank`, `_ismbcblank_l`, `_ismbcspace`, `_ismbcspace_l`](./reference/ismbcgraph-functions.md)|Printable| -|[`ispunct`, `iswpunct`, `_ispunct_l`, `_iswpunct_l`](./reference/ispunct-iswpunct-ispunct-l-iswpunct-l.md), [`_ismbcgraph`, `_ismbcgraph_l`, `_ismbcprint`, `_ismbcprint_l`, `_ismbcpunct`, `_ismbcpunct_l`, `_ismbcblank`, `_ismbcblank_l`, `_ismbcspace`, `_ismbcspace_l`](./reference/ismbcgraph-functions.md)|Punctuation| -|[`isspace`, `iswspace`, `_isspace_l`, `_iswspace_l`](./reference/isspace-iswspace-isspace-l-iswspace-l.md), [`_ismbcgraph`, `_ismbcgraph_l`, `_ismbcprint`, `_ismbcprint_l`, `_ismbcpunct`, `_ismbcpunct_l`, `_ismbcblank`, `_ismbcblank_l`, `_ismbcspace`, `_ismbcspace_l`](./reference/ismbcgraph-functions.md)|White-space| -|[`isupper`, `iswupper`](./reference/isupper-isupper-l-iswupper-iswupper-l.md), [`_ismbclower`, `_ismbclower_l`, `_ismbcupper`, `_ismbcupper_l`](./reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md)|Uppercase| -|[`_isctype`, `iswctype`, `_isctype_l`, `_iswctype_l`](./reference/isctype-iswctype-isctype-l-iswctype-l.md)|Property specified by *`desc`* argument| -|[`isxdigit`, `iswxdigit`, `_isxdigit_l`, `_iswxdigit_l`](./reference/isxdigit-iswxdigit-isxdigit-l-iswxdigit-l.md)|Hexadecimal digit| -|[`_mbclen`, `mblen`, `_mblen_l`](./reference/mbclen-mblen-mblen-l.md)|Return length of valid multibyte character; result depends on `LC_CTYPE` category setting of current locale| +| Routine | Character test condition | +|---|---| +| [`isalnum`, `iswalnum`, `_isalnum_l`, `_iswalnum_l`](./reference/isalnum-iswalnum-isalnum-l-iswalnum-l.md), [`_ismbcalnum`, `_ismbcalnum_l`, `_ismbcalpha`, `_ismbcalpha_l`, `_ismbcdigit`, `_ismbcdigit_l`](./reference/ismbcalnum-functions.md) | Alphanumeric | +| [`_ismbcalnum`, `_ismbcalnum_l`, `_ismbcalpha`, `_ismbcalpha_l`, `_ismbcdigit`, `_ismbcdigit_l`](./reference/ismbcalnum-functions.md) | Multibyte alphanumeric | +| [`isalpha`, `iswalpha`, `_isalpha_l`, `_iswalpha_l`](./reference/isalpha-iswalpha-isalpha-l-iswalpha-l.md), [`_ismbcalnum`, `_ismbcalnum_l`, `_ismbcalpha`, `_ismbcalpha_l`, `_ismbcdigit`, `_ismbcdigit_l`](./reference/ismbcalnum-functions.md) | Alphabetic | +| [`isascii`, `__isascii`, `iswascii`](./reference/isascii-isascii-iswascii.md) | ASCII | +| [`isblank`, `iswblank`, `_isblank_l`, `_iswblank_l`](./reference/isblank-iswblank-isblank-l-iswblank-l.md), [`_ismbcsblank`, `_ismbcsblank_l`](./reference/ismbcgraph-functions.md) | Blank (space or horizontal tab) | +| [`iscntrl`, `iswcntrl`, `_iscntrl_l`, `_iswcntrl_l`](./reference/iscntrl-iswcntrl-iscntrl-l-iswcntrl-l.md) | Control | +| [`iscsym`, `iscsymf`, `__iscsym`, `__iswcsym`, `__iscsymf`, `__iswcsymf`, `_iscsym_l`, `_iswcsym_l`, `_iscsymf_l`, `_iswcsymf_l`](./reference/iscsym-functions.md) | Letter, underscore, or digit | +| [`iscsym`, `iscsymf`, `__iscsym`, `__iswcsym`, `__iscsymf`, `__iswcsymf`, `_iscsym_l`, `_iswcsym_l`, `_iscsymf_l`, `_iswcsymf_l`](./reference/iscsym-functions.md) | Letter or underscore | +| [`isdigit`, `iswdigit`, `_isdigit_l`, `_iswdigit_l`](./reference/isdigit-iswdigit-isdigit-l-iswdigit-l.md), [`_ismbcalnum`, `_ismbcalnum_l`, `_ismbcalpha`, `_ismbcalpha_l`, `_ismbcdigit`, `_ismbcdigit_l`](./reference/ismbcalnum-functions.md) | Decimal digit | +| [`isgraph`, `iswgraph`, `_isgraph_l`, `_iswgraph_l`](./reference/isgraph-iswgraph-isgraph-l-iswgraph-l.md), [`_ismbcgraph`, `_ismbcgraph_l`, `_ismbcprint`, `_ismbcprint_l`, `_ismbcpunct`, `_ismbcpunct_l`, `_ismbcblank`, `_ismbcblank_l`, `_ismbcspace`, `_ismbcspace_l`](./reference/ismbcgraph-functions.md) | Printable other than space | +| [`islower`, `iswlower`, `_islower_l`, `_iswlower_l`](./reference/islower-iswlower-islower-l-iswlower-l.md), [`_ismbclower`, `_ismbclower_l`, `_ismbcupper`, `_ismbcupper_l`](./reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md) | Lowercase | +| [`_ismbchira`, `_ismbchira_l`, `_ismbckata`, `_ismbckata_l`](./reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md) | Hiragana | +| [`_ismbchira`, `_ismbchira_l`, `_ismbckata`, `_ismbckata_l`](./reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md) | Katakana | +| [`_ismbclegal`, `_ismbclegal_l`, `_ismbcsymbol`, `_ismbcsymbol_l`](./reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md) | Legal multibyte character | +| [`_ismbcl0`, `_ismbcl0_l`, `_ismbcl1`, `_ismbcl1_l`, `_ismbcl2`, `_ismbcl2_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md) | Japan-level 0 multibyte character | +| [`_ismbcl0`, `_ismbcl0_l`, `_ismbcl1`, `_ismbcl1_l`, `_ismbcl2`, `_ismbcl2_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md) | Japan-level 1 multibyte character | +| [`_ismbcl0`, `_ismbcl0_l`, `_ismbcl1`, `_ismbcl1_l`, `_ismbcl2`, `_ismbcl2_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md) | Japan-level 2 multibyte character | +| [`_ismbclegal`, `_ismbclegal_l`, `_ismbcsymbol`, `_ismbcsymbol_l`](./reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md) | Non-alphanumeric multibyte character | +| [`isprint`, `iswprint`, `_isprint_l`, `_iswprint_l`](./reference/isprint-iswprint-isprint-l-iswprint-l.md), [`_ismbcgraph`, `_ismbcgraph_l`, `_ismbcprint`, `_ismbcprint_l`, `_ismbcpunct`, `_ismbcpunct_l`, `_ismbcblank`, `_ismbcblank_l`, `_ismbcspace`, `_ismbcspace_l`](./reference/ismbcgraph-functions.md) | Printable | +| [`ispunct`, `iswpunct`, `_ispunct_l`, `_iswpunct_l`](./reference/ispunct-iswpunct-ispunct-l-iswpunct-l.md), [`_ismbcgraph`, `_ismbcgraph_l`, `_ismbcprint`, `_ismbcprint_l`, `_ismbcpunct`, `_ismbcpunct_l`, `_ismbcblank`, `_ismbcblank_l`, `_ismbcspace`, `_ismbcspace_l`](./reference/ismbcgraph-functions.md) | Punctuation | +| [`isspace`, `iswspace`, `_isspace_l`, `_iswspace_l`](./reference/isspace-iswspace-isspace-l-iswspace-l.md), [`_ismbcgraph`, `_ismbcgraph_l`, `_ismbcprint`, `_ismbcprint_l`, `_ismbcpunct`, `_ismbcpunct_l`, `_ismbcblank`, `_ismbcblank_l`, `_ismbcspace`, `_ismbcspace_l`](./reference/ismbcgraph-functions.md) | White-space | +| [`isupper`, `iswupper`](./reference/isupper-isupper-l-iswupper-iswupper-l.md), [`_ismbclower`, `_ismbclower_l`, `_ismbcupper`, `_ismbcupper_l`](./reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md) | Uppercase | +| [`_isctype`, `iswctype`, `_isctype_l`, `_iswctype_l`](./reference/isctype-iswctype-isctype-l-iswctype-l.md) | Property specified by *`desc`* argument | +| [`isxdigit`, `iswxdigit`, `_isxdigit_l`, `_iswxdigit_l`](./reference/isxdigit-iswxdigit-isxdigit-l-iswxdigit-l.md) | Hexadecimal digit | +| [`_mbclen`, `mblen`, `_mblen_l`](./reference/mbclen-mblen-mblen-l.md) | Return length of valid multibyte character; result depends on `LC_CTYPE` category setting of current locale | ## See also diff --git a/docs/c-runtime-library/clocks-per-sec-clk-tck.md b/docs/c-runtime-library/clocks-per-sec-clk-tck.md index da49b06f852..927a19ef920 100644 --- a/docs/c-runtime-library/clocks-per-sec-clk-tck.md +++ b/docs/c-runtime-library/clocks-per-sec-clk-tck.md @@ -2,7 +2,7 @@ description: "Learn more about: CLOCKS_PER_SEC, CLK_TCK" title: "CLOCKS_PER_SEC, CLK_TCK" ms.date: "11/04/2016" -f1_keywords: ["CLOCKS_PER_SEC", "CLK_TCK"] +f1_keywords: ["CLOCKS_PER_SEC", "TIME/CLOCKS_PER_SEC", "CLK_TCK", "TIME/CLK_TCK"] helpviewer_keywords: ["CLOCKS_PER_SEC", "CLK_TCK constant"] ms.assetid: bc285106-383d-44cb-91bf-276ad7de57bf --- @@ -10,7 +10,7 @@ ms.assetid: bc285106-383d-44cb-91bf-276ad7de57bf ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/commit-to-disk-constants.md b/docs/c-runtime-library/commit-to-disk-constants.md index 520ffb9f5d3..9b0fd03de3f 100644 --- a/docs/c-runtime-library/commit-to-disk-constants.md +++ b/docs/c-runtime-library/commit-to-disk-constants.md @@ -12,7 +12,7 @@ ms.assetid: 0b903b23-b4fa-431e-a937-51d95f695ecf ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/compatibility.md b/docs/c-runtime-library/compatibility.md index 0bd8cc1b7e0..e1c99c1d613 100644 --- a/docs/c-runtime-library/compatibility.md +++ b/docs/c-runtime-library/compatibility.md @@ -28,11 +28,11 @@ Except as noted within the documentation for specific functions, the UCRT is com ## Related articles -|Title|Description| -|-----------|-----------------| -|[UWP apps, the Windows Runtime, and the C runtime](./windows-store-apps-the-windows-runtime-and-the-c-run-time.md)|Describes when UCRT routines aren't compatible with Universal Windows apps or Microsoft Store apps.| -|[ANSI C conformance](./ansi-c-compliance.md)|Describes standard-conforming names in the UCRT.| -|[UNIX](./unix.md)|Provides guidelines for porting programs to UNIX.| -|[Windows platforms (CRT)](./windows-platforms-crt.md)|Lists the operating systems that are the CRT supports.| -|[Backward compatibility](./backward-compatibility.md)|Describes how to map old CRT names to the new ones.| -|[C runtime (CRT) and C++ Standard Library (STL) `.lib` files](./crt-library-features.md)|Provides an overview of the CRT library (.lib) files and the associated compiler options.| +| Title | Description | +|---|---| +| [UWP apps, the Windows Runtime, and the C runtime](./windows-store-apps-the-windows-runtime-and-the-c-run-time.md) | Describes when UCRT routines aren't compatible with Universal Windows apps or Microsoft Store apps. | +| [ANSI C conformance](./ansi-c-compliance.md) | Describes standard-conforming names in the UCRT. | +| [UNIX](./unix.md) | Provides guidelines for porting programs to UNIX. | +| [Windows platforms (CRT)](./windows-platforms-crt.md) | Lists the operating systems that are the CRT supports. | +| [Backward compatibility](./backward-compatibility.md) | Describes how to map old CRT names to the new ones. | +| [C runtime (CRT) and C++ Standard Library (STL) `.lib` files](./crt-library-features.md) | Provides an overview of the CRT library (.lib) files and the associated compiler options. | diff --git a/docs/c-runtime-library/complex-math-support.md b/docs/c-runtime-library/complex-math-support.md index bd1ca4df1c9..218495fa17b 100644 --- a/docs/c-runtime-library/complex-math-support.md +++ b/docs/c-runtime-library/complex-math-support.md @@ -17,11 +17,11 @@ The complex math routines rely on the floating point math library functions for The Microsoft implementation of the `complex.h` header defines these types as equivalents for the C99 standard native complex types: -|Standard type|Microsoft type| -|-|-| -|**`float complex`** or **`float _Complex`**|**`_Fcomplex`**| -|**`double complex`** or **`double _Complex`**|**`_Dcomplex`**| -|**`long double complex`** or **`long double _Complex`**|**`_Lcomplex`**| +| Standard type | Microsoft type | +|---|---| +| **`float complex`** or **`float _Complex`** | **`_Fcomplex`** | +| **`double complex`** or **`double _Complex`** | **`_Dcomplex`** | +| **`long double complex`** or **`long double _Complex`** | **`_Lcomplex`** | The `math.h` header defines a separate type, **`struct _complex`**, used for the [`_cabs`](./reference/cabs.md) function. The **`struct _complex`** type isn't used by the equivalent complex math functions [`cabs`, `cabsf`, `cabsl`](./reference/cabs-cabsf-cabsl.md). @@ -31,62 +31,62 @@ The `math.h` header defines a separate type, **`struct _complex`**, used for the ## Trigonometric functions -|Function|Description| -|-|-| -|[`cacos`, `cacosf`, `cacosl`](./reference/cacos-cacosf-cacosl.md)|Compute the complex arc cosine of a complex number| -|[`casin`, `casinf`, `casinl`](./reference/casin-casinf-casinl.md)|Compute the complex arc sine of a complex number| -|[`catan`, `catanf`, `catanl`](./reference/catan-catanf-catanl.md)|Compute the complex arc tangent of a complex number| -|[`ccos`, `ccosf`, `ccosl`](./reference/ccos-ccosf-ccosl.md)|Compute the complex cosine of a complex number| -|[`csin`, `csinf`, `csinl`](./reference/csin-csinf-csinl.md)|Compute the complex sine of a complex number| -|[`ctan`, `ctanf`, `ctanl`](./reference/ctan-ctanf-ctanl.md)|Compute the complex tangent of a complex number| +| Function | Description | +|---|---| +| [`cacos`, `cacosf`, `cacosl`](./reference/cacos-cacosf-cacosl.md) | Compute the complex arc cosine of a complex number | +| [`casin`, `casinf`, `casinl`](./reference/casin-casinf-casinl.md) | Compute the complex arc sine of a complex number | +| [`catan`, `catanf`, `catanl`](./reference/catan-catanf-catanl.md) | Compute the complex arc tangent of a complex number | +| [`ccos`, `ccosf`, `ccosl`](./reference/ccos-ccosf-ccosl.md) | Compute the complex cosine of a complex number | +| [`csin`, `csinf`, `csinl`](./reference/csin-csinf-csinl.md) | Compute the complex sine of a complex number | +| [`ctan`, `ctanf`, `ctanl`](./reference/ctan-ctanf-ctanl.md) | Compute the complex tangent of a complex number | ## Hyperbolic functions -|Function|Description| -|-|-| -|[`cacosh`, `cacoshf`, `cacoshl`](./reference/cacosh-cacoshf-cacoshl.md)|Compute the complex arc hyperbolic cosine of a complex number| -|[`casinh`, `casinhf`, `casinhl`](./reference/casinh-casinhf-casinhl.md)|Compute the complex arc hyperbolic sine of a complex number| -|[`catanh`, `catanhf`, `catanhl`](./reference/catanh-catanhf-catanhl.md)|Compute the complex arc hyperbolic tangent of a complex number| -|[`ccosh`, `ccoshf`, `ccoshl`](./reference/ccosh-ccoshf-ccoshl.md)|Compute the complex hyperbolic cosine of a complex number| -|[`csinh`, `csinhf`, `csinhl`](./reference/csinh-csinhf-csinhl.md)|Compute the complex hyperbolic sine of a complex number| -|[`ctanh`, `ctanhf`, `ctanhl`](./reference/ctanh-ctanhf-ctanhl.md)|Compute the complex hyperbolic tangent of a complex number| +| Function | Description | +|---|---| +| [`cacosh`, `cacoshf`, `cacoshl`](./reference/cacosh-cacoshf-cacoshl.md) | Compute the complex arc hyperbolic cosine of a complex number | +| [`casinh`, `casinhf`, `casinhl`](./reference/casinh-casinhf-casinhl.md) | Compute the complex arc hyperbolic sine of a complex number | +| [`catanh`, `catanhf`, `catanhl`](./reference/catanh-catanhf-catanhl.md) | Compute the complex arc hyperbolic tangent of a complex number | +| [`ccosh`, `ccoshf`, `ccoshl`](./reference/ccosh-ccoshf-ccoshl.md) | Compute the complex hyperbolic cosine of a complex number | +| [`csinh`, `csinhf`, `csinhl`](./reference/csinh-csinhf-csinhl.md) | Compute the complex hyperbolic sine of a complex number | +| [`ctanh`, `ctanhf`, `ctanhl`](./reference/ctanh-ctanhf-ctanhl.md) | Compute the complex hyperbolic tangent of a complex number | ## Exponential and logarithmic functions -|Function|Description| -|-|-| -|[`cexp`, `cexpf`, `cexpl`](./reference/cexp-cexpf-cexpl.md)|Compute the complex base-*e* exponential of a complex number| -|[`clog`, `clogf`, `clogl`](./reference/clog-clogf-clogl.md)|Compute the complex natural (base-*e*) logarithm of a complex number| -|[`clog10`, `clog10f`, `clog10l`](./reference/clog10-clog10f-clog10l.md)|Compute the complex base-10 logarithm of a complex number| +| Function | Description | +|---|---| +| [`cexp`, `cexpf`, `cexpl`](./reference/cexp-cexpf-cexpl.md) | Compute the complex base-*e* exponential of a complex number | +| [`clog`, `clogf`, `clogl`](./reference/clog-clogf-clogl.md) | Compute the complex natural (base-*e*) logarithm of a complex number | +| [`clog10`, `clog10f`, `clog10l`](./reference/clog10-clog10f-clog10l.md) | Compute the complex base-10 logarithm of a complex number | ## Power and absolute-value functions -|Function|Description| -|-|-| -|[`cabs`, `cabsf`, `cabsl`](./reference/cabs-cabsf-cabsl.md)|Compute the complex absolute value (also called the norm, modulus, or magnitude) of a complex number| -|[`cpow`, `cpowf`, `cpowl`](./reference/cpow-cpowf-cpowl.md)|Compute the complex power function| -|[`csqrt`, `csqrtf`, `csqrtl`](./reference/csqrt-csqrtf-csqrtl.md)|Compute the complex square root of a complex number| +| Function | Description | +|---|---| +| [`cabs`, `cabsf`, `cabsl`](./reference/cabs-cabsf-cabsl.md) | Compute the complex absolute value (also called the norm, modulus, or magnitude) of a complex number | +| [`cpow`, `cpowf`, `cpowl`](./reference/cpow-cpowf-cpowl.md) | Compute the complex power function | +| [`csqrt`, `csqrtf`, `csqrtl`](./reference/csqrt-csqrtf-csqrtl.md) | Compute the complex square root of a complex number | ## Manipulation functions -|Function|Description| -|-|-| -|[`_Cbuild`, `_FCbuild`, `_LCbuild`](./reference/cbuild-fcbuild-lcbuild.md)|Construct a complex number from real and imaginary parts| -|[`carg`, `cargf`, `cargl`](./reference/carg-cargf-cargl.md)|Compute the argument (also called the phase angle) of a complex number| -|[`cimag`, `cimagf`, `cimagl`](./reference/cimag-cimagf-cimagl.md)|Compute the imaginary part of a complex number| -|[`conj`, `conjf`, `conjl`](./reference/conj-conjf-conjl.md)|Compute the complex conjugate of a complex number| -|[`cproj`, `cprojf`, `cprojl`](./reference/cproj-cprojf-cprojl.md)|Compute a projection of a complex number onto the Riemann sphere| -|[`creal`, `crealf`, `creall`](./reference/creal-crealf-creall.md)|Compute the real part of a complex number| -|[`norm`, `normf`, `norml`](./reference/norm-normf-norml1.md)|Compute the squared magnitude of a complex number| +| Function | Description | +|---|---| +| [`_Cbuild`, `_FCbuild`, `_LCbuild`](./reference/cbuild-fcbuild-lcbuild.md) | Construct a complex number from real and imaginary parts | +| [`carg`, `cargf`, `cargl`](./reference/carg-cargf-cargl.md) | Compute the argument (also called the phase angle) of a complex number | +| [`cimag`, `cimagf`, `cimagl`](./reference/cimag-cimagf-cimagl.md) | Compute the imaginary part of a complex number | +| [`conj`, `conjf`, `conjl`](./reference/conj-conjf-conjl.md) | Compute the complex conjugate of a complex number | +| [`cproj`, `cprojf`, `cprojl`](./reference/cproj-cprojf-cprojl.md) | Compute a projection of a complex number onto the Riemann sphere | +| [`creal`, `crealf`, `creall`](./reference/creal-crealf-creall.md) | Compute the real part of a complex number | +| [`norm`, `normf`, `norml`](./reference/norm-normf-norml1.md) | Compute the squared magnitude of a complex number | ## Operation functions Because complex numbers aren't a native type in the Microsoft compiler, the standard arithmetic operators aren't defined on complex types. For convenience, these complex math library functions are provided to enable limited manipulation of complex numbers in user code: -|Function|Description| -|-|-| -|[`_Cmulcc`, `_FCmulcc`, `_LCmulcc`](./reference/cmulcc-fcmulcc-lcmulcc.md)|Multiply two complex numbers| -|[`_Cmulcr`, `_FCmulcr`, `_LCmulcr`](./reference/cmulcr-fcmulcr-lcmulcr.md)|Multiply a complex and a floating-point number| +| Function | Description | +|---|---| +| [`_Cmulcc`, `_FCmulcc`, `_LCmulcc`](./reference/cmulcc-fcmulcc-lcmulcc.md) | Multiply two complex numbers | +| [`_Cmulcr`, `_FCmulcr`, `_LCmulcr`](./reference/cmulcr-fcmulcr-lcmulcr.md) | Multiply a complex and a floating-point number | ## See also diff --git a/docs/c-runtime-library/console-and-port-i-o.md b/docs/c-runtime-library/console-and-port-i-o.md index 5dd04351feb..df8063f3005 100644 --- a/docs/c-runtime-library/console-and-port-i-o.md +++ b/docs/c-runtime-library/console-and-port-i-o.md @@ -10,23 +10,23 @@ These routines read and write on your console or on the specified port. The cons ## Console and port I/O routines -|Routine|Use| -|-------------|---------| -|[`_cgets`, `_cgetws`](./cgets-cgetws.md), [`_cgets_s`, `_cgetws_s`](./reference/cgets-s-cgetws-s.md)|Read string from console| -|[`_cprintf`, `_cwprintf`](./reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md), [`_cprintf_s`, `_cprintf_s_l`, `_cwprintf_s`, `_cwprintf_s_l`](./reference/cprintf-s-cprintf-s-l-cwprintf-s-cwprintf-s-l.md)|Write formatted data to console| -|[`_cputs`](./reference/cputs-cputws.md)|Write string to console| -|[`_cscanf`, `_cwscanf`](./reference/cscanf-cscanf-l-cwscanf-cwscanf-l.md), [`_cscanf_s`, `_cscanf_s_l`, `_cwscanf_s`, `_cwscanf_s_l`](./reference/cscanf-s-cscanf-s-l-cwscanf-s-cwscanf-s-l.md)|Read formatted data from console| -|[`_getch`, `_getwch`](./reference/getch-getwch.md)|Read character from console| -|[`_getche`, `_getwche`](./reference/getch-getwch.md)|Read character from console and echo it| -|[`_inp`](./inp-inpw-inpd.md)|Read a byte from the specified I/O port| -|[`_inpd`](./inp-inpw-inpd.md)|Read double word from specified I/O port| -|[`_inpw`](./inp-inpw-inpd.md)|Read 2-byte word from specified I/O port| -|[`_kbhit`](./reference/kbhit.md)|Check for keystroke at console; use before attempting to read from console| -|[`_outp`](./outp-outpw-outpd.md)|Write a byte to the specified I/O port| -|[`_outpd`](./outp-outpw-outpd.md)|Write double word to specified I/O port| -|[`_outpw`](./outp-outpw-outpd.md)|Write word to specified I/O port| -|[`_putch`, `_putwch`](./reference/putch-putwch.md)|Write character to console| -|[`_ungetch`, `_ungetwch`](./reference/ungetch-ungetwch-ungetch-nolock-ungetwch-nolock.md)|"Unget" last character read from console so it becomes next character read| +| Routine | Use | +|---|---| +| [`_cgets`, `_cgetws`](./cgets-cgetws.md), [`_cgets_s`, `_cgetws_s`](./reference/cgets-s-cgetws-s.md) | Read string from console | +| [`_cprintf`, `_cwprintf`](./reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md), [`_cprintf_s`, `_cprintf_s_l`, `_cwprintf_s`, `_cwprintf_s_l`](./reference/cprintf-s-cprintf-s-l-cwprintf-s-cwprintf-s-l.md) | Write formatted data to console | +| [`_cputs`](./reference/cputs-cputws.md) | Write string to console | +| [`_cscanf`, `_cwscanf`](./reference/cscanf-cscanf-l-cwscanf-cwscanf-l.md), [`_cscanf_s`, `_cscanf_s_l`, `_cwscanf_s`, `_cwscanf_s_l`](./reference/cscanf-s-cscanf-s-l-cwscanf-s-cwscanf-s-l.md) | Read formatted data from console | +| [`_getch`, `_getwch`](./reference/getch-getwch.md) | Read character from console | +| [`_getche`, `_getwche`](./reference/getch-getwch.md) | Read character from console and echo it | +| [`_inp`](./inp-inpw-inpd.md) | Read a byte from the specified I/O port | +| [`_inpd`](./inp-inpw-inpd.md) | Read double word from specified I/O port | +| [`_inpw`](./inp-inpw-inpd.md) | Read 2-byte word from specified I/O port | +| [`_kbhit`](./reference/kbhit.md) | Check for keystroke at console; use before attempting to read from console | +| [`_outp`](./outp-outpw-outpd.md) | Write a byte to the specified I/O port | +| [`_outpd`](./outp-outpw-outpd.md) | Write double word to specified I/O port | +| [`_outpw`](./outp-outpw-outpd.md) | Write word to specified I/O port | +| [`_putch`, `_putwch`](./reference/putch-putwch.md) | Write character to console | +| [`_ungetch`, `_ungetwch`](./reference/ungetch-ungetwch-ungetch-nolock-ungetwch-nolock.md) | "Unget" last character read from console so it becomes next character read | ## See also diff --git a/docs/c-runtime-library/constant-and-global-variable-mappings.md b/docs/c-runtime-library/constant-and-global-variable-mappings.md index b957278f0c4..92f33e1dd75 100644 --- a/docs/c-runtime-library/constant-and-global-variable-mappings.md +++ b/docs/c-runtime-library/constant-and-global-variable-mappings.md @@ -2,8 +2,8 @@ description: "Learn more about: Constant and Global Variable Mappings" title: "Constant and Global Variable Mappings" ms.date: "11/04/2016" -f1_keywords: ["_tenviron", "_TEOF", "_tfinddata_t"] -helpviewer_keywords: ["tfinddatat function", "tenviron function", "TEOF type", "_TEOF type", "generic-text mappings", "_tenviron function", "_tfinddata_t function"] +f1_keywords: ["_tenviron", "TCHAR/_tenviron", "_TEOF", "TCHAR/_TEOF", "_tpgmptr", "TCHAR/_tpgmptr"] +helpviewer_keywords: ["_tenviron global constant", "_TEOF global constant", "_tpgmptr global constant"] ms.assetid: 3af4fd3e-9ed5-4ed9-96fd-7031e5126fd1 --- # Constant and global variable mappings @@ -12,11 +12,11 @@ These generic-text constant, global variable, and standard-type mappings are def ### Generic-text constant and global variable mappings -|Generic-text - object name|SBCS (_UNICODE, _MBCS not defined)|_MBCS defined|_UNICODE defined| -|----------------------------------|--------------------------------------------|--------------------|-----------------------| -|`_TEOF`|`EOF`|`EOF`|`WEOF`| -|`_tenviron`|`_environ`|`_environ`|`_wenviron`| -|`_tpgmptr`|`_pgmptr`|`_pgmptr`|`_wpgmptr`| +| Generic-text - object name | SBCS (`_UNICODE`, `_MBCS` not defined) | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_TEOF` | `EOF` | `EOF` | `WEOF` | +| `_tenviron` | `_environ` | `_environ` | `_wenviron` | +| `_tpgmptr` | `_pgmptr` | `_pgmptr` | `_wpgmptr` | ## See also diff --git a/docs/c-runtime-library/control-flags.md b/docs/c-runtime-library/control-flags.md index dd618b6181d..69eb347a57e 100644 --- a/docs/c-runtime-library/control-flags.md +++ b/docs/c-runtime-library/control-flags.md @@ -10,11 +10,11 @@ ms.assetid: 8dbd24a5-0633-42d1-9771-776db338465f The debug version of the Microsoft C run-time library uses the following flags to control the heap allocation and reporting process. For more information, see [CRT debugging techniques](/visualstudio/debugger/crt-debugging-techniques). -|Flag|Description| -|----------|-----------------| -|[`_CRTDBG_MAP_ALLOC`](./crtdbg-map-alloc.md)|Maps the base heap functions to their debug version counterparts| -|[`_DEBUG`](./debug.md)|Enables the use of the debugging versions of the run-time functions| -|[`_crtDbgFlag`](./crtdbgflag.md)|Controls how the debug heap manager tracks allocations| +| Flag | Description | +|---|---| +| [`_CRTDBG_MAP_ALLOC`](./crtdbg-map-alloc.md) | Maps the base heap functions to their debug version counterparts | +| [`_DEBUG`](./debug.md) | Enables the use of the debugging versions of the run-time functions | +| [`_crtDbgFlag`](./crtdbgflag.md) | Controls how the debug heap manager tracks allocations | These flags can be defined with a /D command-line option or with a `#define` directive. When the flag is defined with `#define`, the directive must appear before the header file `#include` directive for the routine declarations. diff --git a/docs/c-runtime-library/controlling-streams.md b/docs/c-runtime-library/controlling-streams.md index 4748de8e7d8..7bdf6321eb2 100644 --- a/docs/c-runtime-library/controlling-streams.md +++ b/docs/c-runtime-library/controlling-streams.md @@ -3,7 +3,6 @@ title: "Controlling Streams" description: "An overview of working with streams in the Microsoft C runtime library." ms.date: "11/04/2016" ms.topic: "conceptual" -f1_keywords: ["Controlling Streams"] helpviewer_keywords: ["streams, controlling", "controlling streams", "streams"] ms.assetid: 267e9013-9afc-45f6-91e3-ca093230d9d9 --- diff --git a/docs/c-runtime-library/country-region-strings.md b/docs/c-runtime-library/country-region-strings.md index ea2679e4072..30b8889911b 100644 --- a/docs/c-runtime-library/country-region-strings.md +++ b/docs/c-runtime-library/country-region-strings.md @@ -14,31 +14,31 @@ For lists of country and region names that are supported by various Windows oper The Microsoft C run-time library implementation also supports the following country/region strings and abbreviations: -|Country/region string|Abbreviation|Equivalent locale name| -|----------------------------|------------------|----------------------------| -|`america`|`USA`|`en-US`| -|`britain`|`GBR`|`en-GB`| -|`china`|`CHN`|`zh-CN`| -|`czech`|`CZE`|`cs-CZ`| -|`england`|`GBR`|`en-GB`| -|`great britain`|`GBR`|`en-GB`| -|`holland`|`NLD`|`nl-NL`| -|`hong-kong`|`HKG`|`zh-HK`| -|`new-zealand`|`NZL`|`en-NZ`| -|`nz`|`NZL`|`en-NZ`| -|`pr china`|`CHN`|`zh-CN`| -|`pr-china`|`CHN`|`zh-CN`| -|`puerto-rico`|`PRI`|`es-PR`| -|`slovak`|`SVK`|`sk-SK`| -|`south africa`|`ZAF`|`af-ZA`| -|`south korea`|`KOR`|`ko-KR`| -|`south-africa`|`ZAF`|`af-ZA`| -|`south-korea`|`KOR`|`ko-KR`| -|`trinidad & tobago`|`TTO`|`en-TT`| -|`uk`|`GBR`|`en-GB`| -|`united-kingdom`|`GBR`|`en-GB`| -|`united-states`|`USA`|`en-US`| -|`us`|`USA`|`en-US`| +| Country/region string | Abbreviation | Equivalent locale name | +|---|---|---| +| `america` | `USA` | `en-US` | +| `britain` | `GBR` | `en-GB` | +| `china` | `CHN` | `zh-CN` | +| `czech` | `CZE` | `cs-CZ` | +| `england` | `GBR` | `en-GB` | +| `great britain` | `GBR` | `en-GB` | +| `holland` | `NLD` | `nl-NL` | +| `hong-kong` | `HKG` | `zh-HK` | +| `new-zealand` | `NZL` | `en-NZ` | +| `nz` | `NZL` | `en-NZ` | +| `pr china` | `CHN` | `zh-CN` | +| `pr-china` | `CHN` | `zh-CN` | +| `puerto-rico` | `PRI` | `es-PR` | +| `slovak` | `SVK` | `sk-SK` | +| `south africa` | `ZAF` | `af-ZA` | +| `south korea` | `KOR` | `ko-KR` | +| `south-africa` | `ZAF` | `af-ZA` | +| `south-korea` | `KOR` | `ko-KR` | +| `trinidad & tobago` | `TTO` | `en-TT` | +| `uk` | `GBR` | `en-GB` | +| `united-kingdom` | `GBR` | `en-GB` | +| `united-states` | `USA` | `en-US` | +| `us` | `USA` | `en-US` | ## See also diff --git a/docs/c-runtime-library/crt-disable-perfcrit-locks.md b/docs/c-runtime-library/crt-disable-perfcrit-locks.md index 17a61e20ebe..bd9a092c1be 100644 --- a/docs/c-runtime-library/crt-disable-perfcrit-locks.md +++ b/docs/c-runtime-library/crt-disable-perfcrit-locks.md @@ -2,7 +2,7 @@ description: "Learn more about: _CRT_DISABLE_PERFCRIT_LOCKS" title: "_CRT_DISABLE_PERFCRIT_LOCKS" ms.date: "11/04/2016" -f1_keywords: ["_CRT_DISABLE_PERFCRIT_LOCKS", "CRT_DISABLE_PERFCRIT_LOCKS"] +f1_keywords: ["_CRT_DISABLE_PERFCRIT_LOCKS"] helpviewer_keywords: ["CRT_DISABLE_PERFCRIT_LOCKS constant", "_CRT_DISABLE_PERFCRIT_LOCKS constant"] ms.assetid: 36cc2d86-cdb1-4b2b-a03c-c0d3818e7c6f --- @@ -12,7 +12,7 @@ Disables performance-critical locking in I/O operations. ## Syntax -``` +```C #define _CRT_DISABLE_PERFCRIT_LOCKS ``` diff --git a/docs/c-runtime-library/crt-initialization.md b/docs/c-runtime-library/crt-initialization.md index 134fa7c633d..705348bd86b 100644 --- a/docs/c-runtime-library/crt-initialization.md +++ b/docs/c-runtime-library/crt-initialization.md @@ -18,7 +18,7 @@ It's possible, though not recommended, to take advantage of Microsoft-specific l Consider the following code: -``` +```C int func(void) { return 3; diff --git a/docs/c-runtime-library/crtdbgflag.md b/docs/c-runtime-library/crtdbgflag.md index c9902015d66..14c2ada306a 100644 --- a/docs/c-runtime-library/crtdbgflag.md +++ b/docs/c-runtime-library/crtdbgflag.md @@ -2,7 +2,7 @@ description: "Learn more about: _crtDbgFlag" title: "_crtDbgFlag" ms.date: "11/04/2016" -f1_keywords: ["_crtDbgFlag", "crtDbgFlag"] +f1_keywords: ["_crtDbgFlag", "CRTDBG/_crtDbgFlag"] helpviewer_keywords: ["memory allocation, tracking flag", "crtDbgFlag constant", "_crtDbgFlag constant", "debug heap, tracking memory on", "debug heap, control flags", "enable memory allocation tracking flag", "memory, tracking on the debug heap"] ms.assetid: 9e7adb47-8ab9-4e19-81d5-e2f237979973 --- diff --git a/docs/c-runtime-library/crtlcmapstringw.md b/docs/c-runtime-library/crtlcmapstringw.md index 59d2a159558..c75880b05f6 100644 --- a/docs/c-runtime-library/crtlcmapstringw.md +++ b/docs/c-runtime-library/crtlcmapstringw.md @@ -58,10 +58,10 @@ Zero indicates failure. To get extended error information, call the `GetLastErro ## Remarks -If `cchSrc` is greater than zero and `lpSrcStr` is a null-terminated string, `__crtLCMapStringW` sets `cchSrc` to the length of the string. Then `__crtLCMapStringW` calls the wide string (Unicode) version of the `LCMapString` function with the specified parameters. For more information about the parameters and return value of this function, see the [`LCMapString`](/windows/win32/api/winnls/nf-winnls-lcmapstringw). +If `cchSrc` is greater than zero and `lpSrcStr` is a null-terminated string, **`__crtLCMapStringW`** sets `cchSrc` to the length of the string. Then **`__crtLCMapStringW`** calls the wide string (Unicode) version of the `LCMapString` function with the specified parameters. For more information about the parameters and return value of this function, see the [`LCMapString`](/windows/win32/api/winnls/nf-winnls-lcmapstringw). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|__crtLCMapStringW|awint.h| +| Routine | Required header | +|---|---| +| **`__crtLCMapStringW`** | `` | diff --git a/docs/c-runtime-library/cxxframehandler.md b/docs/c-runtime-library/cxxframehandler.md index 02be7305cbe..85f3251d0e7 100644 --- a/docs/c-runtime-library/cxxframehandler.md +++ b/docs/c-runtime-library/cxxframehandler.md @@ -22,7 +22,7 @@ EXCEPTION_DISPOSITION __CxxFrameHandler( EHRegistrationNode *pRN, void *pContext, DispatcherContext *pDC - ) + ); ``` #### Parameters @@ -47,6 +47,6 @@ One of the *filter expression* values used by the [try-except Statement](../cpp/ ## Requirements -|Routine|Required header| -|-------------|---------------------| -|__CxxFrameHandler|excpt.h, ehdata.h| +| Routine | Required header | +|---|---| +| **`__CxxFrameHandler`** | ``, `` | diff --git a/docs/c-runtime-library/data-alignment.md b/docs/c-runtime-library/data-alignment.md index 6235dcc300e..e9c8d32d667 100644 --- a/docs/c-runtime-library/data-alignment.md +++ b/docs/c-runtime-library/data-alignment.md @@ -12,24 +12,24 @@ The following C run-time functions support data alignment. ## Data-alignment routines -|Routine|Use| -|-------------|---------| -|[`_aligned_free`](./reference/aligned-free.md)|Frees a block of memory that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md)or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md).| -|[`_aligned_free_dbg`](./reference/aligned-free-dbg.md)|Frees a block of memory that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) (debug only).| -|[`_aligned_malloc`](./reference/aligned-malloc.md)|Allocates memory on a specified alignment boundary.| -|[`_aligned_malloc_dbg`](./reference/aligned-malloc-dbg.md)|Allocates memory on a specified alignment boundary with extra space for a debugging header and overwrite buffers (debug version only).| -|[`_aligned_msize`](./reference/aligned-msize.md)|Returns the size of a memory block allocated in the heap.| -|[`_aligned_msize_dbg`](./reference/aligned-msize-dbg.md)|Returns the size of a memory block allocated in the heap (debug version only).| -|[`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md)|Allocates memory on a specified alignment boundary.| -|[`_aligned_offset_malloc_dbg`](./reference/aligned-offset-malloc-dbg.md)|Allocates memory on a specified alignment boundary (debug version only).| -|[`_aligned_offset_realloc`](./reference/aligned-offset-realloc.md)|Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md).| -|[`_aligned_offset_realloc_dbg`](./reference/aligned-offset-realloc-dbg.md)|Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) (debug version only).| -|[`_aligned_offset_recalloc`](./reference/aligned-offset-recalloc.md)|Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) and initializes the memory to 0.| -|[`_aligned_offset_recalloc_dbg`](./reference/aligned-offset-recalloc-dbg.md)|Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) and initializes the memory to 0 (debug version only).| -|[`_aligned_realloc`](./reference/aligned-realloc.md)|Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md).| -|[`_aligned_realloc_dbg`](./reference/aligned-realloc-dbg.md)|Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) (debug version only).| -|[`_aligned_recalloc`](./reference/aligned-recalloc.md)|Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) and initializes the memory to 0.| -|[`_aligned_recalloc_dbg`](./reference/aligned-recalloc-dbg.md)|Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) and initializes the memory to 0 (debug version only).| +| Routine | Use | +|---|---| +| [`_aligned_free`](./reference/aligned-free.md) | Frees a block of memory that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md)or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md). | +| [`_aligned_free_dbg`](./reference/aligned-free-dbg.md) | Frees a block of memory that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) (debug only). | +| [`_aligned_malloc`](./reference/aligned-malloc.md) | Allocates memory on a specified alignment boundary. | +| [`_aligned_malloc_dbg`](./reference/aligned-malloc-dbg.md) | Allocates memory on a specified alignment boundary with extra space for a debugging header and overwrite buffers (debug version only). | +| [`_aligned_msize`](./reference/aligned-msize.md) | Returns the size of a memory block allocated in the heap. | +| [`_aligned_msize_dbg`](./reference/aligned-msize-dbg.md) | Returns the size of a memory block allocated in the heap (debug version only). | +| [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) | Allocates memory on a specified alignment boundary. | +| [`_aligned_offset_malloc_dbg`](./reference/aligned-offset-malloc-dbg.md) | Allocates memory on a specified alignment boundary (debug version only). | +| [`_aligned_offset_realloc`](./reference/aligned-offset-realloc.md) | Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md). | +| [`_aligned_offset_realloc_dbg`](./reference/aligned-offset-realloc-dbg.md) | Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) (debug version only). | +| [`_aligned_offset_recalloc`](./reference/aligned-offset-recalloc.md) | Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) and initializes the memory to 0. | +| [`_aligned_offset_recalloc_dbg`](./reference/aligned-offset-recalloc-dbg.md) | Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) and initializes the memory to 0 (debug version only). | +| [`_aligned_realloc`](./reference/aligned-realloc.md) | Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md). | +| [`_aligned_realloc_dbg`](./reference/aligned-realloc-dbg.md) | Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) (debug version only). | +| [`_aligned_recalloc`](./reference/aligned-recalloc.md) | Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) and initializes the memory to 0. | +| [`_aligned_recalloc_dbg`](./reference/aligned-recalloc-dbg.md) | Changes the size of a memory block that was allocated with [`_aligned_malloc`](./reference/aligned-malloc.md) or [`_aligned_offset_malloc`](./reference/aligned-offset-malloc.md) and initializes the memory to 0 (debug version only). | ## See also diff --git a/docs/c-runtime-library/data-conversion.md b/docs/c-runtime-library/data-conversion.md index 9f67a01e779..5c3c7b5b610 100644 --- a/docs/c-runtime-library/data-conversion.md +++ b/docs/c-runtime-library/data-conversion.md @@ -11,44 +11,44 @@ These routines convert data from one form to another. Generally these routines e ## Data-conversion routines -|Routine|Use| -|-------------|---------| -|[`abs`](./reference/abs-labs-llabs-abs64.md)|Find absolute value of integer| -|[`atof`, `_atof_l`](./reference/atof-atof-l-wtof-wtof-l.md)|Convert string to **`float`**| -|[`atoi`, `_atoi_l`](./reference/atoi-atoi-l-wtoi-wtoi-l.md)|Convert string to **`int`**| -|[`_atoi64`, `_atoi64_l`](./reference/atoi64-atoi64-l-wtoi64-wtoi64-l.md)|Convert string to **`__int64`** or **`long long`**| -|[`atol`, `_atol_l`](./reference/atol-atol-l-wtol-wtol-l.md)|Convert string to **`long`**| -|[`c16rtomb`, `c32rtomb`](./reference/c16rtomb-c32rtomb1.md)|Convert UTF-16 or UTF-32 character to equivalent multibyte character| -|[`_ecvt`](./reference/ecvt.md), [`_ecvt_s`](./reference/ecvt-s.md)|Convert **`double`** to string of specified length| -|[`_fcvt`](./reference/fcvt.md), [`_fcvt_s`](./reference/fcvt-s.md)|Convert **`double`** to string with specified number of digits following decimal point| -|[`_gcvt`](./reference/gcvt.md), [`_gcvt_s`](./reference/gcvt-s.md)|Convert **`double`** number to string; store string in buffer| -|[`_itoa`, `_ltoa`, `_ultoa`, `_i64toa`, `_ui64toa`, `_itow`, `_ltow`, `ultow`, `_i64tow`, `_ui64tow`](./reference/itoa-itow.md), [`_itoa_s`, `_ltoa_s`, `_ultoa_s`, `_i64toa_s`, `_ui64toa_s`, `_itow_s`, `_ltow_s`, `_ultow_s`, `_i64tow_s`, `_ui64tow_s`](./reference/itoa-s-itow-s.md)|Convert integer types to string| -|[`labs`](./reference/abs-labs-llabs-abs64.md)|Find absolute value of **`long`** integer| -|[`llabs`](./reference/abs-labs-llabs-abs64.md)|Find absolute value of **`long long`** integer| -|[`_mbbtombc`, `_mbbtombc_l`](./reference/mbbtombc-mbbtombc-l.md)|Convert 1-byte multibyte character to corresponding 2-byte multibyte character| -|[`_mbcjistojms`, `_mbcjistojms_l`, `_mbcjmstojis`, `_mbcjmstojis_l`](./reference/mbcjistojms-mbcjistojms-l-mbcjmstojis-mbcjmstojis-l.md)|Convert Japan Industry Standard (JIS) character to Japan Microsoft (JMS) character| -|[`_mbcjistojms`, `_mbcjistojms_l`, `_mbcjmstojis`, `_mbcjmstojis_l`](./reference/mbcjistojms-mbcjistojms-l-mbcjmstojis-mbcjmstojis-l.md)|Convert JMS character to JIS character| -|[`_mbctohira`, `_mbctohira_l`, `_mbctokata`, `_mbctokata_l`](./reference/mbctohira-mbctohira-l-mbctokata-mbctokata-l.md)|Convert multibyte character to 1-byte hiragana code| -|[`_mbctohira`, `_mbctohira_l`, `_mbctokata`, `_mbctokata_l`](./reference/mbctohira-mbctohira-l-mbctokata-mbctokata-l.md)|Convert multibyte character to 1-byte katakana code| -|[`_mbctombb`, `_mbctombb_l`](./reference/mbctombb-mbctombb-l.md)|Convert 2-byte multibyte character to corresponding 1-byte multibyte character| -|[`mbrtoc16`, `mbrtoc32`](./reference/mbrtoc16-mbrtoc323.md)|Convert multibyte character to equivalent UTF-16 or UTF-32 character| -|[`mbstowcs`, `_mbstowcs_l`](./reference/mbstowcs-mbstowcs-l.md), [`mbstowcs_s`, `_mbstowcs_s_l`](./reference/mbstowcs-s-mbstowcs-s-l.md)|Convert sequence of multibyte characters to corresponding sequence of wide characters| -|[`mbtowc`, `_mbtowc_l`](./reference/mbtowc-mbtowc-l.md)|Convert multibyte character to corresponding wide character| -|[`strtod`, `_strtod_l`, `wcstod`, `_wcstod_l`](./reference/strtod-strtod-l-wcstod-wcstod-l.md)|Convert string to **`double`**| -|[`strtol`, `wcstol`, `_strtol_l`, `_wcstol_l`](./reference/strtol-wcstol-strtol-l-wcstol-l.md)|Convert string to **`long`** integer| -|[`strtoul`, `_strtoul_l`, `wcstoul`, `_wcstoul_l`](./reference/strtoul-strtoul-l-wcstoul-wcstoul-l.md)|Convert string to **`unsigned long`** integer| -|[`strxfrm`, `wcsxfrm`, `_strxfrm_l`, `_wcsxfrm_l`](./reference/strxfrm-wcsxfrm-strxfrm-l-wcsxfrm-l.md)|Transform string into collated form based on locale-specific information| -|[`toascii`, `__toascii`](./reference/toascii-toascii.md)|Convert character to ASCII code| -|[`tolower`, `_tolower`, `towlower`, `_tolower_l`, `_towlower_l`](./reference/tolower-tolower-towlower-tolower-l-towlower-l.md), [`_mbctolower`, `_mbctolower_l`, `_mbctoupper`, `_mbctoupper_l`](./reference/mbctolower-mbctolower-l-mbctoupper-mbctoupper-l.md)|Test character and convert to lowercase if currently uppercase| -|[`tolower`, `_tolower`, `towlower`, `_tolower_l`, `_towlower_l`](./reference/tolower-tolower-towlower-tolower-l-towlower-l.md)|Convert character to lowercase unconditionally| -|[`toupper`, `_toupper`, `towupper`, `_toupper_l`, `_towupper_l`](./reference/toupper-toupper-towupper-toupper-l-towupper-l.md), [`_mbctolower`, `_mbctolower_l`, `_mbctoupper`, `_mbctoupper_l`](./reference/mbctolower-mbctolower-l-mbctoupper-mbctoupper-l.md)|Test character and convert to uppercase if currently lowercase| -|[`toupper`, `_toupper`, `towupper`, `_toupper_l`, `_towupper_l`](./reference/toupper-toupper-towupper-toupper-l-towupper-l.md)|Convert character to uppercase unconditionally| -|[`wcstombs`, `_wcstombs_l`](./reference/wcstombs-wcstombs-l.md), [`wcstombs_s`, `_wcstombs_s_l`](./reference/wcstombs-s-wcstombs-s-l.md)|Convert sequence of wide characters to corresponding sequence of multibyte characters| -|[`wctomb`, `_wctomb_l`](./reference/wctomb-wctomb-l.md), [`wctomb_s`, `_wctomb_s_l`](./reference/wctomb-s-wctomb-s-l.md)|Convert wide character to corresponding multibyte character| -|[`_wtof`, `_wtof_l`](./reference/atof-atof-l-wtof-wtof-l.md)|Convert wide-character string to a **`double`**| -|[`_wtoi`, `_wtoi_l`](./reference/atoi-atoi-l-wtoi-wtoi-l.md)|Convert wide-character string to **`int`**| -|[`_wtoi64`, `_wtoi64_l`](./reference/atoi64-atoi64-l-wtoi64-wtoi64-l.md)|Convert wide-character string to **`__int64`** or **`long long`**| -|[`_wtol`, `_wtol_l`](./reference/atol-atol-l-wtol-wtol-l.md)|Convert wide-character string to **`long`**| +| Routine | Use | +|---|---| +| [`abs`](./reference/abs-labs-llabs-abs64.md) | Find absolute value of integer | +| [`atof`, `_atof_l`](./reference/atof-atof-l-wtof-wtof-l.md) | Convert string to **`float`** | +| [`atoi`, `_atoi_l`](./reference/atoi-atoi-l-wtoi-wtoi-l.md) | Convert string to **`int`** | +| [`_atoi64`, `_atoi64_l`](./reference/atoi64-atoi64-l-wtoi64-wtoi64-l.md) | Convert string to **`__int64`** or **`long long`** | +| [`atol`, `_atol_l`](./reference/atol-atol-l-wtol-wtol-l.md) | Convert string to **`long`** | +| [`c16rtomb`, `c32rtomb`](./reference/c16rtomb-c32rtomb1.md) | Convert UTF-16 or UTF-32 character to equivalent multibyte character | +| [`_ecvt`](./reference/ecvt.md), [`_ecvt_s`](./reference/ecvt-s.md) | Convert **`double`** to string of specified length | +| [`_fcvt`](./reference/fcvt.md), [`_fcvt_s`](./reference/fcvt-s.md) | Convert **`double`** to string with specified number of digits following decimal point | +| [`_gcvt`](./reference/gcvt.md), [`_gcvt_s`](./reference/gcvt-s.md) | Convert **`double`** number to string; store string in buffer | +| [`_itoa`, `_ltoa`, `_ultoa`, `_i64toa`, `_ui64toa`, `_itow`, `_ltow`, `ultow`, `_i64tow`, `_ui64tow`](./reference/itoa-itow.md), [`_itoa_s`, `_ltoa_s`, `_ultoa_s`, `_i64toa_s`, `_ui64toa_s`, `_itow_s`, `_ltow_s`, `_ultow_s`, `_i64tow_s`, `_ui64tow_s`](./reference/itoa-s-itow-s.md) | Convert integer types to string | +| [`labs`](./reference/abs-labs-llabs-abs64.md) | Find absolute value of **`long`** integer | +| [`llabs`](./reference/abs-labs-llabs-abs64.md) | Find absolute value of **`long long`** integer | +| [`_mbbtombc`, `_mbbtombc_l`](./reference/mbbtombc-mbbtombc-l.md) | Convert 1-byte multibyte character to corresponding 2-byte multibyte character | +| [`_mbcjistojms`, `_mbcjistojms_l`, `_mbcjmstojis`, `_mbcjmstojis_l`](./reference/mbcjistojms-mbcjistojms-l-mbcjmstojis-mbcjmstojis-l.md) | Convert Japan Industry Standard (JIS) character to Japan Microsoft (JMS) character | +| [`_mbcjistojms`, `_mbcjistojms_l`, `_mbcjmstojis`, `_mbcjmstojis_l`](./reference/mbcjistojms-mbcjistojms-l-mbcjmstojis-mbcjmstojis-l.md) | Convert JMS character to JIS character | +| [`_mbctohira`, `_mbctohira_l`, `_mbctokata`, `_mbctokata_l`](./reference/mbctohira-mbctohira-l-mbctokata-mbctokata-l.md) | Convert multibyte character to 1-byte hiragana code | +| [`_mbctohira`, `_mbctohira_l`, `_mbctokata`, `_mbctokata_l`](./reference/mbctohira-mbctohira-l-mbctokata-mbctokata-l.md) | Convert multibyte character to 1-byte katakana code | +| [`_mbctombb`, `_mbctombb_l`](./reference/mbctombb-mbctombb-l.md) | Convert 2-byte multibyte character to corresponding 1-byte multibyte character | +| [`mbrtoc16`, `mbrtoc32`](./reference/mbrtoc16-mbrtoc323.md) | Convert multibyte character to equivalent UTF-16 or UTF-32 character | +| [`mbstowcs`, `_mbstowcs_l`](./reference/mbstowcs-mbstowcs-l.md), [`mbstowcs_s`, `_mbstowcs_s_l`](./reference/mbstowcs-s-mbstowcs-s-l.md) | Convert sequence of multibyte characters to corresponding sequence of wide characters | +| [`mbtowc`, `_mbtowc_l`](./reference/mbtowc-mbtowc-l.md) | Convert multibyte character to corresponding wide character | +| [`strtod`, `_strtod_l`, `wcstod`, `_wcstod_l`](./reference/strtod-strtod-l-wcstod-wcstod-l.md) | Convert string to **`double`** | +| [`strtol`, `wcstol`, `_strtol_l`, `_wcstol_l`](./reference/strtol-wcstol-strtol-l-wcstol-l.md) | Convert string to **`long`** integer | +| [`strtoul`, `_strtoul_l`, `wcstoul`, `_wcstoul_l`](./reference/strtoul-strtoul-l-wcstoul-wcstoul-l.md) | Convert string to **`unsigned long`** integer | +| [`strxfrm`, `wcsxfrm`, `_strxfrm_l`, `_wcsxfrm_l`](./reference/strxfrm-wcsxfrm-strxfrm-l-wcsxfrm-l.md) | Transform string into collated form based on locale-specific information | +| [`toascii`, `__toascii`](./reference/toascii-toascii.md) | Convert character to ASCII code | +| [`tolower`, `_tolower`, `towlower`, `_tolower_l`, `_towlower_l`](./reference/tolower-tolower-towlower-tolower-l-towlower-l.md), [`_mbctolower`, `_mbctolower_l`, `_mbctoupper`, `_mbctoupper_l`](./reference/mbctolower-mbctolower-l-mbctoupper-mbctoupper-l.md) | Test character and convert to lowercase if currently uppercase | +| [`tolower`, `_tolower`, `towlower`, `_tolower_l`, `_towlower_l`](./reference/tolower-tolower-towlower-tolower-l-towlower-l.md) | Convert character to lowercase unconditionally | +| [`toupper`, `_toupper`, `towupper`, `_toupper_l`, `_towupper_l`](./reference/toupper-toupper-towupper-toupper-l-towupper-l.md), [`_mbctolower`, `_mbctolower_l`, `_mbctoupper`, `_mbctoupper_l`](./reference/mbctolower-mbctolower-l-mbctoupper-mbctoupper-l.md) | Test character and convert to uppercase if currently lowercase | +| [`toupper`, `_toupper`, `towupper`, `_toupper_l`, `_towupper_l`](./reference/toupper-toupper-towupper-toupper-l-towupper-l.md) | Convert character to uppercase unconditionally | +| [`wcstombs`, `_wcstombs_l`](./reference/wcstombs-wcstombs-l.md), [`wcstombs_s`, `_wcstombs_s_l`](./reference/wcstombs-s-wcstombs-s-l.md) | Convert sequence of wide characters to corresponding sequence of multibyte characters | +| [`wctomb`, `_wctomb_l`](./reference/wctomb-wctomb-l.md), [`wctomb_s`, `_wctomb_s_l`](./reference/wctomb-s-wctomb-s-l.md) | Convert wide character to corresponding multibyte character | +| [`_wtof`, `_wtof_l`](./reference/atof-atof-l-wtof-wtof-l.md) | Convert wide-character string to a **`double`** | +| [`_wtoi`, `_wtoi_l`](./reference/atoi-atoi-l-wtoi-wtoi-l.md) | Convert wide-character string to **`int`** | +| [`_wtoi64`, `_wtoi64_l`](./reference/atoi64-atoi64-l-wtoi64-wtoi64-l.md) | Convert wide-character string to **`__int64`** or **`long long`** | +| [`_wtol`, `_wtol_l`](./reference/atol-atol-l-wtol-wtol-l.md) | Convert wide-character string to **`long`** | ## See also diff --git a/docs/c-runtime-library/data-type-constants.md b/docs/c-runtime-library/data-type-constants.md index 7d12148e366..1c631e5b87e 100644 --- a/docs/c-runtime-library/data-type-constants.md +++ b/docs/c-runtime-library/data-type-constants.md @@ -2,7 +2,7 @@ description: "Learn more about: Data Type Constants" title: "Data Type Constants" ms.date: "06/25/2018" -f1_keywords: ["FLT_MIN", "SHRT_MAX", "CHAR_MIN", "MB_LEN_MAX", "DBL_EPSILON", "SHRT_MIN", "_FLT_RADIX", "FLT_DIG", "FLT_MAX_10_EXP", "FLT_MANT_DIG", "DBL_MAX_EXP", "SCHAR_MIN", "SCHAR_MAX", "DBL_MIN", "FLT_MIN_10_EXP", "_DBL_ROUNDS", "USHRT_MAX", "FLT_MAX_EXP", "LONG_MAX", "DBL_MAX", "DBL_DIG", "FLT_MIN_EXP", "INT_MIN", "DBL_MIN_10_EXP", "CHAR_BIT", "INT_MAX", "ULONG_MAX", "DBL_MIN_EXP", "LONG_MIN", "_FLT_ROUNDS", "DBL_MANT_DIG", "_DBL_RADIX", "CHAR_MAX", "FLT_MAX", "DBL_MAX_10_EXP", "UCHAR_MAX", "FLT_EPSILON", "UINT_MAX", "LLONG_MIN", "LLONG_MAX", "ULLONG_MAX", "_I8_MIN", "_I8_MAX", "_UI8_MAX", "_I16_MIN", "_I16_MAX", "_UI16_MAX", "_I32_MIN", "_I32_MAX", "_UI32_MAX", "_I64_MIN", "_I64_MAX", "_UI64_MAX", "_I128_MIN", "_I128_MAX", "_UI128_MAX", "SIZE_MAX", "RSIZE_MAX", "LDBL_DIG", "LDBL_EPSILON", "LDBL_HAS_SUBNORM", "LDBL_MANT_DIG", "LDBL_MAX", "LDBL_MAX_10_EXP", "LDBL_MAX_EXP", "LDBL_MIN", "LDBL_MIN_10_EXP", "LDBL_MIN_EXP", "_LDBL_RADIX", "LDBL_TRUE_MIN", "DECIMAL_DIG"] +f1_keywords: ["CHAR_BIT", "SCHAR_MIN", "SCHAR_MAX", "UCHAR_MAX", "CHAR_MIN", "CHAR_MAX", "MB_LEN_MAX", "SHRT_MIN", "SHRT_MAX", "USHRT_MAX", "INT_MIN", "INT_MAX", "UINT_MAX", "LONG_MIN", "LONG_MAX", "ULONG_MAX", "LLONG_MIN", "LLONG_MAX", "ULLONG_MAX", "_I8_MIN", "_I8_MAX", "_UI8_MAX", "_I16_MIN", "_I16_MAX", "_UI16_MAX", "_I32_MIN", "_I32_MAX", "_UI32_MAX", "_I64_MIN", "_I64_MAX", "_UI64_MAX", "_I128_MIN", "_I128_MAX", "_UI128_MAX", "SIZE_MAX", "RSIZE_MAX", "LIMITS/CHAR_BIT", "LIMITS/SCHAR_MIN", "LIMITS/SCHAR_MAX", "LIMITS/UCHAR_MAX", "LIMITS/CHAR_MIN", "LIMITS/CHAR_MAX", "LIMITS/MB_LEN_MAX", "LIMITS/SHRT_MIN", "LIMITS/SHRT_MAX", "LIMITS/USHRT_MAX", "LIMITS/INT_MIN", "LIMITS/INT_MAX", "LIMITS/UINT_MAX", "LIMITS/LONG_MIN", "LIMITS/LONG_MAX", "LIMITS/ULONG_MAX", "LIMITS/LLONG_MIN", "LIMITS/LLONG_MAX", "LIMITS/ULLONG_MAX", "LIMITS/_I8_MIN", "LIMITS/_I8_MAX", "LIMITS/_UI8_MAX", "LIMITS/_I16_MIN", "LIMITS/_I16_MAX", "LIMITS/_UI16_MAX", "LIMITS/_I32_MIN", "LIMITS/_I32_MAX", "LIMITS/_UI32_MAX", "LIMITS/_I64_MIN", "LIMITS/_I64_MAX", "LIMITS/_UI64_MAX", "LIMITS/_I128_MIN", "LIMITS/_I128_MAX", "LIMITS/_UI128_MAX", "LIMITS/SIZE_MAX", "LIMITS/RSIZE_MAX", "DBL_DECIMAL_DIG", "DBL_DIG", "DBL_EPSILON", "DBL_HAS_SUBNORM", "DBL_MANT_DIG", "DBL_MAX", "DBL_MAX_10_EXP", "DBL_MAX_EXP", "DBL_MIN", "DBL_MIN_10_EXP", "DBL_MIN_EXP", "_DBL_RADIX", "DBL_TRUE_MIN", "FLT_DECIMAL_DIG", "FLT_DIG", "FLT_EPSILON", "FLT_HAS_SUBNORM", "FLT_MANT_DIG", "FLT_MAX", "FLT_MAX_10_EXP", "FLT_MAX_EXP", "FLT_MIN", "FLT_MIN_10_EXP", "FLT_MIN_EXP", "FLT_RADIX", "FLT_TRUE_MIN", "LDBL_DIG", "LDBL_EPSILON", "LDBL_HAS_SUBNORM", "LDBL_MANT_DIG", "LDBL_MAX", "LDBL_MAX_10_EXP", "LDBL_MAX_EXP", "LDBL_MIN", "LDBL_MIN_10_EXP", "LDBL_MIN_EXP", "_LDBL_RADIX", "LDBL_TRUE_MIN", "DECIMAL_DIG", "FLOAT/DBL_DECIMAL_DIG", "FLOAT/DBL_DIG", "FLOAT/DBL_EPSILON", "FLOAT/DBL_HAS_SUBNORM", "FLOAT/DBL_MANT_DIG", "FLOAT/DBL_MAX", "FLOAT/DBL_MAX_10_EXP", "FLOAT/DBL_MAX_EXP", "FLOAT/DBL_MIN", "FLOAT/DBL_MIN_10_EXP", "FLOAT/DBL_MIN_EXP", "FLOAT/_DBL_RADIX", "FLOAT/DBL_TRUE_MIN", "FLOAT/FLT_DECIMAL_DIG", "FLOAT/FLT_DIG", "FLOAT/FLT_EPSILON", "FLOAT/FLT_HAS_SUBNORM", "FLOAT/FLT_MANT_DIG", "FLOAT/FLT_MAX", "FLOAT/FLT_MAX_10_EXP", "FLOAT/FLT_MAX_EXP", "FLOAT/FLT_MIN", "FLOAT/FLT_MIN_10_EXP", "FLOAT/FLT_MIN_EXP", "FLOAT/FLT_RADIX", "FLOAT/FLT_TRUE_MIN", "FLOAT/LDBL_DIG", "FLOAT/LDBL_EPSILON", "FLOAT/LDBL_HAS_SUBNORM", "FLOAT/LDBL_MANT_DIG", "FLOAT/LDBL_MAX", "FLOAT/LDBL_MAX_10_EXP", "FLOAT/LDBL_MAX_EXP", "FLOAT/LDBL_MIN", "FLOAT/LDBL_MIN_10_EXP", "FLOAT/LDBL_MIN_EXP", "FLOAT/_LDBL_RADIX", "FLOAT/LDBL_TRUE_MIN", "FLOAT/DECIMAL_DIG"] helpviewer_keywords: ["DBL_MAX_EXP constant", "_DBL_RADIX constant", "FLT_MIN_EXP constant", "DBL_EPSILON constant", "INT_MIN constant", "FLT_EPSILON constant", "DBL_MANT_DIG constant", "_FLT_RADIX constant", "DBL_MIN constant", "USHRT_MAX constant", "FLT_MAX_10_EXP constant", "_FLT_ROUNDS constant", "data type constants [C++]", "_DBL_ROUNDS constant", "CHAR_MAX constant", "FLT_MAX_EXP constant", "FLT_MIN constant", "CHAR_MIN constant", "FLT_MIN_10_EXP constant", "DBL_MIN_EXP constant", "SCHAR_MAX constant", "FLT_RADIX constant", "CHAR_BIT constant", "UCHAR_MAX constant", "DBL_RADIX constant", "FLT_ROUNDS constant", "LONG_MIN constant", "SHRT_MAX constant", "LONG_MAX constant", "DBL_MAX_10_EXP constant", "DBL_MIN_10_EXP constant", "INT_MAX constant", "constants [C++], data type", "ULONG_MAX constant", "FLT_DIG constant", "MB_LEN_MAX constant", "DBL_DIG constant", "SHRT_MIN constant", "DBL_MAX constant", "DBL_ROUNDS constant", "FLT_MAX constant", "UINT_MAX constant", "FLT_MANT_DIG constant", "SCHAR_MIN constant", "LLONG_MIN constant", "LLONG_MAX constant", "ULLONG_MAX constant", "_I8_MIN constant", "_I8_MAX constant", "_UI8_MAX constant", "_I16_MIN constant", "_I16_MAX constant", "_UI16_MAX constant", "_I32_MIN constant", "_I32_MAX constant", "_UI32_MAX constant", "_I64_MIN constant", "_I64_MAX constant", "_UI64_MAX constant", "_I128_MIN constant", "_I128_MAX constant", "_UI128_MAX constant", "SIZE_MAX constant", "RSIZE_MAX constant"] --- # Data type constants @@ -20,44 +20,44 @@ These constants give the ranges for the integral data types. To use these consta > [!NOTE] > The [`/J`](../build/reference/j-default-char-type-is-unsigned.md) compiler option changes the default **`char`** type from **`signed char`** to **`unsigned char`**. -|Constant|Value|Description| -|--------------|-----------|-------------| -|`CHAR_BIT`|8|Number of bits in a **`char`**| -|`SCHAR_MIN`|(-128)|Minimum **`signed char`** value| -|`SCHAR_MAX`|127|Maximum **`signed char`** value| -|`UCHAR_MAX`|255 (0xff)|Maximum **`unsigned char`** value| -|`CHAR_MIN`|(-128) (0 if **`/J`** option used)|Minimum **`char`** value| -|`CHAR_MAX`|127 (255 if **`/J`** option used)|Maximum **`char`** value| -|`MB_LEN_MAX`|5|Maximum number of bytes in multibyte **`char`**| -|`SHRT_MIN`|-32768|Minimum **`signed short`** value| -|`SHRT_MAX`|32767|Maximum **`signed short`** value| -|`USHRT_MAX`|65535 (0xffff)|Maximum **`unsigned short`** value| -|`INT_MIN`|(-2147483647 - 1)|Minimum **`signed int`** value| -|`INT_MAX`|2147483647|Maximum **`signed int`** value| -|`UINT_MAX`|4294967295 (0xffffffff)|Maximum **`unsigned int`** value| -|`LONG_MIN`|(-2147483647L - 1)|Minimum **`signed long`** value| -|`LONG_MAX`|2147483647L|Maximum **`signed long`** value| -|`ULONG_MAX`|4294967295UL (0xfffffffful)|Maximum **`unsigned long`** value| -|`LLONG_MIN`|(-9223372036854775807LL - 1)|Minimum **`signed long long`** or **`__int64`** value| -|`LLONG_MAX`|9223372036854775807LL|Maximum **`signed long long`** or **`__int64`** value| -|`ULLONG_MAX`|0xffffffffffffffffull|Maximum **`unsigned long long`** value| -|`_I8_MIN`|(-127i8 - 1)|Minimum signed 8-bit value| -|`_I8_MAX`|127i8|Maximum signed 8-bit value| -|`_UI8_MAX`|0xffui8|Maximum unsigned 8-bit value| -|`_I16_MIN`|(-32767i16 - 1)|Minimum signed 16-bit value| -|`_I16_MAX`|32767i16|Maximum signed 16-bit value| -|`_UI16_MAX`|0xffffui16|Maximum unsigned 16-bit value| -|`_I32_MIN`|(-2147483647i32 - 1)|Minimum signed 32-bit value| -|`_I32_MAX`|2147483647i32|Maximum signed 32-bit value| -|`_UI32_MAX`|0xffffffffui32|Maximum unsigned 32-bit value| -|`_I64_MIN`|(-9223372036854775807 - 1)|Minimum signed 64-bit value| -|`_I64_MAX`|9223372036854775807|Maximum signed 64-bit value| -|`_UI64_MAX`|0xffffffffffffffffui64|Maximum unsigned 64-bit value| -|`_I128_MIN`|(-170141183460469231731687303715884105727i128 - 1)|Minimum signed 128-bit value| -|`_I128_MAX`|170141183460469231731687303715884105727i128|Maximum signed 128-bit value| -|`_UI128_MAX`|0xffffffffffffffffffffffffffffffffui128|Maximum unsigned 128-bit value| -|`SIZE_MAX`|same as `_UI64_MAX` if `_WIN64` is defined, or `UINT_MAX`|Maximum native integer size| -|`RSIZE_MAX`|same as (`SIZE_MAX` >> 1)|Maximum secure library integer size| +| Constant | Value | Description | +|---|---|---| +| `CHAR_BIT` | 8 | Number of bits in a **`char`** | +| `SCHAR_MIN` | (-128) | Minimum **`signed char`** value | +| `SCHAR_MAX` | 127 | Maximum **`signed char`** value | +| `UCHAR_MAX` | 255 (0xff) | Maximum **`unsigned char`** value | +| `CHAR_MIN` | (-128) (0 if **`/J`** option used) | Minimum **`char`** value | +| `CHAR_MAX` | 127 (255 if **`/J`** option used) | Maximum **`char`** value | +| `MB_LEN_MAX` | 5 | Maximum number of bytes in multibyte **`char`** | +| `SHRT_MIN` | -32768 | Minimum **`signed short`** value | +| `SHRT_MAX` | 32767 | Maximum **`signed short`** value | +| `USHRT_MAX` | 65535 (0xffff) | Maximum **`unsigned short`** value | +| `INT_MIN` | (-2147483647 - 1) | Minimum **`signed int`** value | +| `INT_MAX` | 2147483647 | Maximum **`signed int`** value | +| `UINT_MAX` | 4294967295 (0xffffffff) | Maximum **`unsigned int`** value | +| `LONG_MIN` | (-2147483647L - 1) | Minimum **`signed long`** value | +| `LONG_MAX` | 2147483647L | Maximum **`signed long`** value | +| `ULONG_MAX` | 4294967295UL (0xfffffffful) | Maximum **`unsigned long`** value | +| `LLONG_MIN` | (-9223372036854775807LL - 1) | Minimum **`signed long long`** or **`__int64`** value | +| `LLONG_MAX` | 9223372036854775807LL | Maximum **`signed long long`** or **`__int64`** value | +| `ULLONG_MAX` | 0xffffffffffffffffull | Maximum **`unsigned long long`** value | +| `_I8_MIN` | (-127i8 - 1) | Minimum signed 8-bit value | +| `_I8_MAX` | 127i8 | Maximum signed 8-bit value | +| `_UI8_MAX` | 0xffui8 | Maximum unsigned 8-bit value | +| `_I16_MIN` | (-32767i16 - 1) | Minimum signed 16-bit value | +| `_I16_MAX` | 32767i16 | Maximum signed 16-bit value | +| `_UI16_MAX` | 0xffffui16 | Maximum unsigned 16-bit value | +| `_I32_MIN` | (-2147483647i32 - 1) | Minimum signed 32-bit value | +| `_I32_MAX` | 2147483647i32 | Maximum signed 32-bit value | +| `_UI32_MAX` | 0xffffffffui32 | Maximum unsigned 32-bit value | +| `_I64_MIN` | (-9223372036854775807 - 1) | Minimum signed 64-bit value | +| `_I64_MAX` | 9223372036854775807 | Maximum signed 64-bit value | +| `_UI64_MAX` | 0xffffffffffffffffui64 | Maximum unsigned 64-bit value | +| `_I128_MIN` | (-170141183460469231731687303715884105727i128 - 1) | Minimum signed 128-bit value | +| `_I128_MAX` | 170141183460469231731687303715884105727i128 | Maximum signed 128-bit value | +| `_UI128_MAX` | 0xffffffffffffffffffffffffffffffffui128 | Maximum unsigned 128-bit value | +| `SIZE_MAX` | same as `_UI64_MAX` if `_WIN64` is defined, or `UINT_MAX` | Maximum native integer size | +| `RSIZE_MAX` | same as (`SIZE_MAX` >> 1) | Maximum secure library integer size | ## Floating-point type constants @@ -67,47 +67,47 @@ The following constants give the range and other characteristics of the **`long #include ``` -|Constant|Value|Description| -|--------------|-----------|-----------------| -|`DBL_DECIMAL_DIG`|17|# of decimal digits of rounding precision| -|`DBL_DIG`|15|# of decimal digits of precision| -|`DBL_EPSILON`|2.2204460492503131e-016|Smallest such that 1.0 + `DBL_EPSILON` != 1.0| -|`DBL_HAS_SUBNORM`|1|Type supports subnormal (denormal) numbers| -|`DBL_MANT_DIG`|53|# of bits in significand (mantissa)| -|`DBL_MAX`|1.7976931348623158e+308|Maximum value| -|`DBL_MAX_10_EXP`|308|Maximum decimal exponent| -|`DBL_MAX_EXP`|1024|Maximum binary exponent| -|`DBL_MIN`|2.2250738585072014e-308|Minimum normalized positive value| -|`DBL_MIN_10_EXP`|(-307)|Minimum decimal exponent| -|`DBL_MIN_EXP`|(-1021)|Minimum binary exponent| -|`_DBL_RADIX`|2|Exponent radix| -|`DBL_TRUE_MIN`|4.9406564584124654e-324|Minimum positive subnormal value| -|`FLT_DECIMAL_DIG`|9|Number of decimal digits of rounding precision| -|`FLT_DIG`|6|Number of decimal digits of precision| -|`FLT_EPSILON`|1.192092896e-07F|Smallest such that 1.0 + `FLT_EPSILON` != 1.0| -|`FLT_HAS_SUBNORM`|1|Type supports subnormal (denormal) numbers| -|`FLT_MANT_DIG`|24|Number of bits in significand (mantissa)| -|`FLT_MAX`|3.402823466e+38F|Maximum value| -|`FLT_MAX_10_EXP`|38|Maximum decimal exponent| -|`FLT_MAX_EXP`|128|Maximum binary exponent| -|`FLT_MIN`|1.175494351e-38F|Minimum normalized positive value| -|`FLT_MIN_10_EXP`|(-37)|Minimum decimal exponent| -|`FLT_MIN_EXP`|(-125)|Minimum binary exponent| -|`FLT_RADIX`|2|Exponent radix| -|`FLT_TRUE_MIN`|1.401298464e-45F|Minimum positive subnormal value| -|`LDBL_DIG`|15|# of decimal digits of precision| -|`LDBL_EPSILON`|2.2204460492503131e-016|Smallest such that 1.0 + `LDBL_EPSILON` != 1.0| -|`LDBL_HAS_SUBNORM`|1|Type supports subnormal (denormal) numbers| -|`LDBL_MANT_DIG`|53|# of bits in significand (mantissa)| -|`LDBL_MAX`|1.7976931348623158e+308|Maximum value| -|`LDBL_MAX_10_EXP`|308|Maximum decimal exponent| -|`LDBL_MAX_EXP`|1024|Maximum binary exponent| -|`LDBL_MIN`|2.2250738585072014e-308|Minimum normalized positive value| -|`LDBL_MIN_10_EXP`|(-307)|Minimum decimal exponent| -|`LDBL_MIN_EXP`|(-1021)|Minimum binary exponent| -|`_LDBL_RADIX`|2|Exponent radix| -|`LDBL_TRUE_MIN`|4.9406564584124654e-324|Minimum positive subnormal value| -|`DECIMAL_DIG`|same as `DBL_DECIMAL_DIG`|Default (double) decimal digits of rounding precision| +| Constant | Value | Description | +|---|---|---| +| `DBL_DECIMAL_DIG` | 17 | # of decimal digits of rounding precision | +| `DBL_DIG` | 15 | # of decimal digits of precision | +| `DBL_EPSILON` | 2.2204460492503131e-016 | Smallest such that 1.0 + `DBL_EPSILON` != 1.0 | +| `DBL_HAS_SUBNORM` | 1 | Type supports subnormal (denormal) numbers | +| `DBL_MANT_DIG` | 53 | # of bits in significand (mantissa) | +| `DBL_MAX` | 1.7976931348623158e+308 | Maximum value | +| `DBL_MAX_10_EXP` | 308 | Maximum decimal exponent | +| `DBL_MAX_EXP` | 1024 | Maximum binary exponent | +| `DBL_MIN` | 2.2250738585072014e-308 | Minimum normalized positive value | +| `DBL_MIN_10_EXP` | (-307) | Minimum decimal exponent | +| `DBL_MIN_EXP` | (-1021) | Minimum binary exponent | +| `_DBL_RADIX` | 2 | Exponent radix | +| `DBL_TRUE_MIN` | 4.9406564584124654e-324 | Minimum positive subnormal value | +| `FLT_DECIMAL_DIG` | 9 | Number of decimal digits of rounding precision | +| `FLT_DIG` | 6 | Number of decimal digits of precision | +| `FLT_EPSILON` | 1.192092896e-07F | Smallest such that 1.0 + `FLT_EPSILON` != 1.0 | +| `FLT_HAS_SUBNORM` | 1 | Type supports subnormal (denormal) numbers | +| `FLT_MANT_DIG` | 24 | Number of bits in significand (mantissa) | +| `FLT_MAX` | 3.402823466e+38F | Maximum value | +| `FLT_MAX_10_EXP` | 38 | Maximum decimal exponent | +| `FLT_MAX_EXP` | 128 | Maximum binary exponent | +| `FLT_MIN` | 1.175494351e-38F | Minimum normalized positive value | +| `FLT_MIN_10_EXP` | (-37) | Minimum decimal exponent | +| `FLT_MIN_EXP` | (-125) | Minimum binary exponent | +| `FLT_RADIX` | 2 | Exponent radix | +| `FLT_TRUE_MIN` | 1.401298464e-45F | Minimum positive subnormal value | +| `LDBL_DIG` | 15 | # of decimal digits of precision | +| `LDBL_EPSILON` | 2.2204460492503131e-016 | Smallest such that 1.0 + `LDBL_EPSILON` != 1.0 | +| `LDBL_HAS_SUBNORM` | 1 | Type supports subnormal (denormal) numbers | +| `LDBL_MANT_DIG` | 53 | # of bits in significand (mantissa) | +| `LDBL_MAX` | 1.7976931348623158e+308 | Maximum value | +| `LDBL_MAX_10_EXP` | 308 | Maximum decimal exponent | +| `LDBL_MAX_EXP` | 1024 | Maximum binary exponent | +| `LDBL_MIN` | 2.2250738585072014e-308 | Minimum normalized positive value | +| `LDBL_MIN_10_EXP` | (-307) | Minimum decimal exponent | +| `LDBL_MIN_EXP` | (-1021) | Minimum binary exponent | +| `_LDBL_RADIX` | 2 | Exponent radix | +| `LDBL_TRUE_MIN` | 4.9406564584124654e-324 | Minimum positive subnormal value | +| `DECIMAL_DIG` | same as `DBL_DECIMAL_DIG` | Default (double) decimal digits of rounding precision | ## See also diff --git a/docs/c-runtime-library/data-type-mappings.md b/docs/c-runtime-library/data-type-mappings.md index 5aae9eed3d1..11190a21108 100644 --- a/docs/c-runtime-library/data-type-mappings.md +++ b/docs/c-runtime-library/data-type-mappings.md @@ -2,7 +2,7 @@ description: "Learn more about: Data Type Mappings" title: "Data Type Mappings" ms.date: "11/04/2016" -f1_keywords: ["_TXCHAR", "_TUCHAR", "_TINT", "_TSCHAR", "_TCHAR", "TCHAR::H", "TCHAR", "_T", "_TEXT"] +f1_keywords: ["_TXCHAR", "_TUCHAR", "_TINT", "_TSCHAR", "_TCHAR", "TCHAR", "_T", "_TEXT"] helpviewer_keywords: ["_TXCHAR type", "TINT type", "_TCHAR type", "TSCHAR type", "TEXT type", "TCHAR type", "TCHAR.H data types, mappings defined in", "generic-text data types", "_TINT type", "TUCHAR type", "TXCHAR type", "_TSCHAR type", "T type", "_TUCHAR type", "_TEXT type", "_T type"] ms.assetid: 4e573c05-8800-468b-ae5f-76ff7409835e --- @@ -14,17 +14,17 @@ For related information, see [Using TCHAR.H Data Types with _MBCS Code](../text/ ### Generic-text data type mappings -|Generic-text

data type name|SBCS (_UNICODE,

_MBCS not

defined)|_MBCS

defined|_UNICODE

defined| -|--------------------------------------|----------------------------------------------------|------------------------|---------------------------| -|`_TCHAR`|**`char`**|**`char`**|**`wchar_t`**| -|`_tfinddata_t`|`_finddata_t`|`_finddata_t`|`_wfinddata_t`| -|`_tfinddata64_t`|`__finddata64_t`|`__finddata64_t`|`__wfinddata64_t`| -|`_tfinddatai64_t`|`_finddatai64_t`|`_finddatai64_t`|`_wfinddatai64_t`| -|`_TINT`|**`int`**|**`int`**|`wint_t`| -|`_TSCHAR`|**`signed char`**|**`signed char`**|**`wchar_t`**| -|`_TUCHAR`|**`unsigned char`**|**`unsigned char`**|**`wchar_t`**| -|`_TXCHAR`|**`char`**|**`unsigned char`**|**`wchar_t`**| -|`_T` or `_TEXT`|No effect (removed by preprocessor)|No effect (removed by preprocessor)|`L` (converts following character or string to its Unicode counterpart)| +| Generic-text

data type name | SBCS (_UNICODE,

_MBCS not

defined) | _MBCS

defined | _UNICODE

defined | +|---|---|---|---| +| `_TCHAR` | **`char`** | **`char`** | **`wchar_t`** | +| `_tfinddata_t` | `_finddata_t` | `_finddata_t` | `_wfinddata_t` | +| `_tfinddata64_t` | `__finddata64_t` | `__finddata64_t` | `__wfinddata64_t` | +| `_tfinddatai64_t` | `_finddatai64_t` | `_finddatai64_t` | `_wfinddatai64_t` | +| `_TINT` | **`int`** | **`int`** | `wint_t` | +| `_TSCHAR` | **`signed char`** | **`signed char`** | **`wchar_t`** | +| `_TUCHAR` | **`unsigned char`** | **`unsigned char`** | **`wchar_t`** | +| `_TXCHAR` | **`char`** | **`unsigned char`** | **`wchar_t`** | +| `_T` or `_TEXT` | No effect (removed by preprocessor) | No effect (removed by preprocessor) | `L` (converts following character or string to its Unicode counterpart) | ## See also diff --git a/docs/c-runtime-library/daylight-dstbias-timezone-and-tzname.md b/docs/c-runtime-library/daylight-dstbias-timezone-and-tzname.md index ffd330f3bbf..997a01c0ef5 100644 --- a/docs/c-runtime-library/daylight-dstbias-timezone-and-tzname.md +++ b/docs/c-runtime-library/daylight-dstbias-timezone-and-tzname.md @@ -2,26 +2,26 @@ description: "Learn more about: _daylight, _dstbias, _timezone, and _tzname" title: "_daylight, _dstbias, _timezone, and _tzname" ms.date: "11/04/2016" -f1_keywords: ["tzname", "_timezone", "timezone", "_daylight", "_tzname", "daylight"] -helpviewer_keywords: ["time zones", "time adjustments", "timezone variables", "_tzname function", "_daylight function", "_timezone function", "daylight function", "local time adjustments", "timezone function", "tzname function", "time-zone variables"] +f1_keywords: ["_daylight", "TIME/_daylight", "_dstbias", "TIME/_dstbias", "_timezone", "TIME/_timezone", "_tzname", "TIME/_tzname"] +helpviewer_keywords: ["time zones", "time adjustments", "timezone variables", "_daylight global variable", "_dstbias global variable", "_timezone global variable", "_tzname global variable", "local time adjustments", "time-zone variables"] ms.assetid: d06c7292-6b99-4aba-b284-16a96570c856 --- # `_daylight`, `_dstbias`, `_timezone`, and `_tzname` -`_daylight`, `_dstbias`, `_timezone`, and `_tzname` are used in some time and date routines to make local-time adjustments. These global variables have been deprecated for the more secure functional versions, which should be used in place of the global variables. +**`_daylight`**, **`_dstbias`**, **`_timezone`**, and **`_tzname`** are used in some time and date routines to make local-time adjustments. These global variables have been deprecated for the more secure functional versions, which should be used in place of the global variables. -|Global variable|Functional equivalent| -|---------------------|---------------------------| -|`_daylight`|[`_get_daylight`](./reference/get-daylight.md)| -|`_dstbias`|[`_get_dstbias`](./reference/get-dstbias.md)| -|`_timezone`|[`_get_timezone`](./reference/get-timezone.md)| -|`_tzname`|[`_get_tzname`](./reference/get-tzname.md)| +| Global variable | Functional equivalent | +|---|---| +| **`_daylight`** | [`_get_daylight`](./reference/get-daylight.md) | +| **`_dstbias`** | [`_get_dstbias`](./reference/get-dstbias.md) | +| **`_timezone`** | [`_get_timezone`](./reference/get-timezone.md) | +| **`_tzname`** | [`_get_tzname`](./reference/get-tzname.md) | They're declared in Time.h as follows. ## Syntax -``` +```C extern int _daylight; extern int _dstbias; extern long _timezone; @@ -30,15 +30,15 @@ extern char *_tzname[2]; ## Remarks -On a call to `_ftime`, `localtime`, or `_tzset`, the values of `_daylight`, `_dstbias`, `_timezone`, and `_tzname` are determined from the value of the `TZ` environment variable. If you don't explicitly set the value of `TZ`, `_tzname[0]` and `_tzname[1]` contain the default settings of "PST" and "PDT" respectively. The time-manipulation functions ([`_tzset`](./reference/tzset.md), [`_ftime`](./reference/ftime-ftime32-ftime64.md), and [`localtime`](./reference/localtime-localtime32-localtime64.md)) attempt to set the values of `_daylight`, `_dstbias` and `_timezone` by querying the operating system for the default value of each variable. The time-zone global variable values are shown in the following table. +On a call to `_ftime`, `localtime`, or `_tzset`, the values of **`_daylight`**, **`_dstbias`**, **`_timezone`**, and **`_tzname`** are determined from the value of the `TZ` environment variable. If you don't explicitly set the value of `TZ`, `_tzname[0]` and `_tzname[1]` contain the default settings of "PST" and "PDT" respectively. The time-manipulation functions ([`_tzset`](./reference/tzset.md), [`_ftime`](./reference/ftime-ftime32-ftime64.md), and [`localtime`](./reference/localtime-localtime32-localtime64.md)) attempt to set the values of **`_daylight`**, **`_dstbias`** and **`_timezone`** by querying the operating system for the default value of each variable. The time-zone global variable values are shown in the following table. -|Variable|Value| -|--------------|-----------| -|`_daylight`|Nonzero if daylight saving time (DST) zone is specified in `TZ` or determined from the operating system; otherwise, 0. The default value is 1.| -|`_dstbias`|Offset for daylight saving time.| -|`_timezone`|Difference in seconds between coordinated universal time and local time. The default value is 28,800.| -|`_tzname[0]`|Time-zone name derived from the `TZ` environment variable. The default value is "PST".| -|`_tzname[1]`|DST zone name derived from the `TZ` environment variable. The default value is "PDT" (Pacific daylight time).| +| Variable | Value | +|---|---| +| **`_daylight`** | Nonzero if daylight saving time (DST) zone is specified in `TZ` or determined from the operating system; otherwise, 0. The default value is 1. | +| **`_dstbias`** | Offset for daylight saving time. | +| **`_timezone`** | Difference in seconds between coordinated universal time and local time. The default value is 28,800. | +| `_tzname[0]` | Time-zone name derived from the `TZ` environment variable. The default value is "PST". | +| `_tzname[1]` | DST zone name derived from the `TZ` environment variable. The default value is "PDT" (Pacific daylight time). | ## See also diff --git a/docs/c-runtime-library/directory-control.md b/docs/c-runtime-library/directory-control.md index 51cf82210a0..9f47f3871df 100644 --- a/docs/c-runtime-library/directory-control.md +++ b/docs/c-runtime-library/directory-control.md @@ -11,18 +11,18 @@ These routines access, modify, and obtain information about the directory struct ## Directory-control routines -|Routine|Use| -|-------------|---------| -|[`_chdir`, `_wchdir`](./reference/chdir-wchdir.md)|Change current working directory| -|[`_chdrive`](./reference/chdrive.md)|Change current drive| -|[`_getcwd`, `_wgetcwd`](./reference/getcwd-wgetcwd.md)|Get current working directory for default drive| -|[`_getdcwd`, `_wgetdcwd`](./reference/getdcwd-wgetdcwd.md)|Get current working directory for specified drive| -|[`_getdiskfree`](./reference/getdiskfree.md)|Populates a `_diskfree_t` structure with information about a disk drive.| -|[`_getdrive`](./reference/getdrive.md)|Get current (default) drive| -|[`_getdrives`](./reference/getdrives.md)|Returns a bitmask representing the currently available disk drives.| -|[`_mkdir`, `_wmkdir`](./reference/mkdir-wmkdir.md)|Make new directory| -|[`_rmdir`, `_wrmdir`](./reference/rmdir-wrmdir.md)|Remove directory| -|[`_searchenv`, `_wsearchenv`](./reference/searchenv-wsearchenv.md), [`_searchenv_s`, `_wsearchenv_s`](./reference/searchenv-s-wsearchenv-s.md)|Search for given file on specified paths| +| Routine | Use | +|---|---| +| [`_chdir`, `_wchdir`](./reference/chdir-wchdir.md) | Change current working directory | +| [`_chdrive`](./reference/chdrive.md) | Change current drive | +| [`_getcwd`, `_wgetcwd`](./reference/getcwd-wgetcwd.md) | Get current working directory for default drive | +| [`_getdcwd`, `_wgetdcwd`](./reference/getdcwd-wgetdcwd.md) | Get current working directory for specified drive | +| [`_getdiskfree`](./reference/getdiskfree.md) | Populates a `_diskfree_t` structure with information about a disk drive. | +| [`_getdrive`](./reference/getdrive.md) | Get current (default) drive | +| [`_getdrives`](./reference/getdrives.md) | Returns a bitmask representing the currently available disk drives. | +| [`_mkdir`, `_wmkdir`](./reference/mkdir-wmkdir.md) | Make new directory | +| [`_rmdir`, `_wrmdir`](./reference/rmdir-wrmdir.md) | Remove directory | +| [`_searchenv`, `_wsearchenv`](./reference/searchenv-wsearchenv.md), [`_searchenv_s`, `_wsearchenv_s`](./reference/searchenv-s-wsearchenv-s.md) | Search for given file on specified paths | ## See also diff --git a/docs/c-runtime-library/dllonexit.md b/docs/c-runtime-library/dllonexit.md index 6c65b6dc478..8cadda4ee4c 100644 --- a/docs/c-runtime-library/dllonexit.md +++ b/docs/c-runtime-library/dllonexit.md @@ -16,11 +16,12 @@ Registers a routine to be called at exit time. ## Syntax -``` -_onexit_t __dllonexit( _onexit_t func, +```C +_onexit_t __dllonexit( + _onexit_t func, _PVFV ** pbegin, _PVFV ** pend - ) + ); ``` #### Parameters @@ -48,9 +49,9 @@ The `_PVFV` type is defined as `typedef void (__cdecl *_PVFV)(void)`. ## Requirements -|Routine|Required file| -|-------------|-------------------| -|__dllonexit|onexit.c| +| Routine | Required file | +|---|---| +| **`__dllonexit`** | `onexit.c` | ## See also diff --git a/docs/c-runtime-library/environ-wenviron.md b/docs/c-runtime-library/environ-wenviron.md index 5b0042df3da..8411febc714 100644 --- a/docs/c-runtime-library/environ-wenviron.md +++ b/docs/c-runtime-library/environ-wenviron.md @@ -2,8 +2,8 @@ description: "Learn more about: _environ, _wenviron" title: "_environ, _wenviron" ms.date: "11/04/2016" -f1_keywords: ["environ", "wenviron", "_wenviron", "_environ"] -helpviewer_keywords: ["environ function", "_environ function", "_wenviron function", "process environment", "wenviron function"] +f1_keywords: ["_environ", "STDLIB/_environ", "_wenviron", "STDLIB/_wenviron"] +helpviewer_keywords: ["_environ global variable", "_wenviron global variable", "process environment"] ms.assetid: 7e639962-6536-47cd-8095-0cbe44a56e03 --- # `_environ`, `_wenviron` @@ -15,7 +15,7 @@ The `_environ` variable is a pointer to an array of pointers to the multibyte-ch ## Syntax -``` +```C extern char **_environ; ``` @@ -29,7 +29,7 @@ In a program that uses the `main` function, `_environ` is initialized at program The `_wenviron` variable, declared in Stdlib.h as: -``` +```C extern wchar_t **_wenviron; ``` @@ -48,7 +48,7 @@ Polling `_environ` in a Unicode context is meaningless when [/MD](../build/refer The following pseudo-code illustrates how this creation can happen. -``` +```C int i, j; i = _wputenv( "env_var_x=string1" ); // results in the implicit call: // putenv ("env_var_z=string1") diff --git a/docs/c-runtime-library/environmental-constants.md b/docs/c-runtime-library/environmental-constants.md index 445dad2fb7f..bc19ee30a55 100644 --- a/docs/c-runtime-library/environmental-constants.md +++ b/docs/c-runtime-library/environmental-constants.md @@ -9,7 +9,7 @@ ms.assetid: 5224f540-231c-47aa-be9a-467efd1db281 ## Syntax -``` +```C #include ``` @@ -17,9 +17,9 @@ ms.assetid: 5224f540-231c-47aa-be9a-467efd1db281 The `_MAX_ENV` constant defines the environmental length for strings. -|Constant|Meaning| -|--------------|-------------| -|`_MAX_ENV`|Maximum string size of an environmental string.| +| Constant | Meaning | +|---|---| +| `_MAX_ENV` | Maximum string size of an environmental string. | ## See also diff --git a/docs/c-runtime-library/eof-weof.md b/docs/c-runtime-library/eof-weof.md index 96ee3bcda48..9845193f68f 100644 --- a/docs/c-runtime-library/eof-weof.md +++ b/docs/c-runtime-library/eof-weof.md @@ -2,14 +2,15 @@ description: "Learn more about: EOF, WEOF" title: "EOF, WEOF" ms.date: "11/04/2016" -helpviewer_keywords: ["EOF function", "WEOF function", "end of file"] +f1_keywords: ["EOF", "STDIO/EOF", "WEOF", "CORECRT_WSTDIO/WEOF"] +helpviewer_keywords: ["EOF constant", "WEOF constant", "end of file"] ms.assetid: a7150563-cdae-4cdf-9798-ad509990e505 --- # `EOF`, `WEOF` ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md b/docs/c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md index 0ee14181c4a..b71050dc510 100644 --- a/docs/c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md +++ b/docs/c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md @@ -6,7 +6,7 @@ api_name: ["_errno"] api_location: ["msvcrt.dll"] api_type: ["DLLExport"] topic_type: ["apiref"] -f1_keywords: ["_sys_errlist", "errno", "_sys_nerr", "_doserrno"] +f1_keywords: ["errno", "ERRNO/errno", "_doserrno", "ERRNO/_doserrno", "_sys_errlist", "STDLIB/_sys_errlist", "_sys_nerr", "STDLIB/_sys_nerr"] helpviewer_keywords: ["error codes, printing", "sys_errlist global variable", "doserrno global variable", "errno global variable", "_doserrno global variable", "_sys_errlist global variable", "_sys_nerr global variable", "sys_nerr global variable"] ms.assetid: adbec641-6d91-4e19-8398-9a34046bd369 --- @@ -16,7 +16,7 @@ Global macros that hold error codes that are set during program execution, and s ## Syntax -``` +```C #define errno (*_errno()) #define _doserrno (*__doserrno()) #define _sys_errlist (__sys_errlist()) @@ -25,28 +25,28 @@ Global macros that hold error codes that are set during program execution, and s ## Remarks -Both `errno` and `_doserrno` are set to 0 by the runtime during program startup. `errno` is set on an error in a system-level call. Because `errno` holds the value for the last call that set it, this value may be changed by succeeding calls. Run-time library calls that set `errno` on an error don't clear `errno` on success. Always clear `errno` by calling `_set_errno(0)` immediately before a call that may set it, and check it immediately after the call. +Both **`errno`** and **`_doserrno`** are set to 0 by the runtime during program startup. **`errno`** is set on an error in a system-level call. Because **`errno`** holds the value for the last call that set it, this value may be changed by succeeding calls. Run-time library calls that set **`errno`** on an error don't clear **`errno`** on success. Always clear **`errno`** by calling `_set_errno(0)` immediately before a call that may set it, and check it immediately after the call. -On an error, `errno` isn't necessarily set to the same value as the error code returned by a system call. For I/O operations, `_doserrno` stores the operating-system error-code equivalents of `errno` codes. For most non-I/O operations, the value of `_doserrno` isn't set. +On an error, **`errno`** isn't necessarily set to the same value as the error code returned by a system call. For I/O operations, **`_doserrno`** stores the operating-system error-code equivalents of **`errno`** codes. For most non-I/O operations, the value of **`_doserrno`** isn't set. -Each `errno` value is associated with an error message in `_sys_errlist` that can be printed by using one of the [`perror`](./reference/perror-wperror.md) functions, or stored in a string by using one of the [`strerror`](./reference/strerror-strerror-wcserror-wcserror.md) or [`strerror_s`](./reference/strerror-s-strerror-s-wcserror-s-wcserror-s.md) functions. The `perror` and `strerror` functions use the `_sys_errlist` array and `_sys_nerr`—the number of elements in `_sys_errlist`—to process error information. Direct access to `_sys_errlist` and `_sys_nerr` is deprecated for code-security reasons. We recommend that you use the more secure, functional versions instead of the global macros, as shown here: +Each **`errno`** value is associated with an error message in **`_sys_errlist`** that can be printed by using one of the [`perror`](./reference/perror-wperror.md) functions, or stored in a string by using one of the [`strerror`](./reference/strerror-strerror-wcserror-wcserror.md) or [`strerror_s`](./reference/strerror-s-strerror-s-wcserror-s-wcserror-s.md) functions. The `perror` and `strerror` functions use the **`_sys_errlist`** array and **`_sys_nerr`**—the number of elements in **`_sys_errlist`**—to process error information. Direct access to **`_sys_errlist`** and **`_sys_nerr`** is deprecated for code-security reasons. We recommend that you use the more secure, functional versions instead of the global macros, as shown here: -|Global Macro|Functional Equivalents| -|------------------|----------------------------| -|`_doserrno`|[`_get_doserrno`](./reference/get-doserrno.md), [`_set_doserrno`](./reference/set-doserrno.md)| -|`errno`|[`_get_errno`](./reference/get-errno.md), [`_set_errno`](./reference/set-errno.md)| -|`_sys_errlist`, `_sys_nerr`|[`strerror_s`, `_strerror_s`, `_wcserror_s`, `__wcserror_s`](./reference/strerror-s-strerror-s-wcserror-s-wcserror-s.md)| +| Global macro | Functional equivalents | +|---|---| +| **`_doserrno`** | [`_get_doserrno`](./reference/get-doserrno.md), [`_set_doserrno`](./reference/set-doserrno.md) | +| **`errno`** | [`_get_errno`](./reference/get-errno.md), [`_set_errno`](./reference/set-errno.md) | +| **`_sys_errlist`**, **`_sys_nerr`** | [`strerror_s`, `_strerror_s`, `_wcserror_s`, `__wcserror_s`](./reference/strerror-s-strerror-s-wcserror-s-wcserror-s.md) | -Library math routines set `errno` by calling [`_matherr`](./reference/matherr.md). To handle math errors differently, write your own routine according to the `_matherr` reference description and name it `_matherr`. +Library math routines set **`errno`** by calling [`_matherr`](./reference/matherr.md). To handle math errors differently, write your own routine according to the `_matherr` reference description and name it `_matherr`. -All `errno` values are predefined constants in ``, and are UNIX-compatible. Only `ERANGE`, `EILSEQ`, and `EDOM` are specified in the ISO C99 standard. For a complete list, see [`errno` constants](./errno-constants.md). +All **`errno`** values are predefined constants in ``, and are UNIX-compatible. Only `ERANGE`, `EILSEQ`, and `EDOM` are specified in the ISO C99 standard. For a complete list, see [`errno` constants](./errno-constants.md). ## Requirements -|Global macro|Required header|Optional header| -|------------------|---------------------|---------------------| -|`errno`|`` or ``, `` or `` (C++)|| -|`_doserrno`, `_sys_errlist`, `_sys_nerr`|``, `` (C++)|``, `` (C++)| +| Global macro | Required header | Optional header | +|---|---|---| +| `errno` | `` or ``, `` or `` (C++) | | +| `_doserrno`, `_sys_errlist`, `_sys_nerr` | ``, `` (C++) | ``, `` (C++) | The `_doserrno`, `_sys_errlist`, and `_sys_nerr` macros are Microsoft extensions. For more compatibility information, see [Compatibility](./compatibility.md). diff --git a/docs/c-runtime-library/error-handling-crt.md b/docs/c-runtime-library/error-handling-crt.md index 2be864988b1..e2eca821d5e 100644 --- a/docs/c-runtime-library/error-handling-crt.md +++ b/docs/c-runtime-library/error-handling-crt.md @@ -11,17 +11,17 @@ Use these routines to handle program errors. ## Error-handling routines -|Routine|Use| -|-------------|---------| -|[`assert`](./reference/assert-macro-assert-wassert.md) macro|Test for programming logic errors; available in both the release and debug versions of the run-time library.| -|[`_ASSERT`, `_ASSERTE`](./reference/assert-asserte-assert-expr-macros.md) macros|Similar to `assert`, but only available in the debug versions of the run-time library.| -|[`clearerr`](./reference/clearerr.md)|Reset error indicator. Calling `rewind` or closing a stream also resets the error indicator.| -|[`_eof`](./reference/eof.md)|Check for end of file in low-level I/O.| -|[`feof`](./reference/feof.md)|Test for end of file. End of file is also indicated when `_read` returns 0.| -|[`ferror`](./reference/ferror.md)|Test for stream I/O errors.| -|[`_RPT`, `_RPTF`](./reference/rpt-rptf-rptw-rptfw-macros.md) macros|Generate a report similar to `printf`, but only available in the debug versions of the run-time library.| -|[`_set_error_mode`](./reference/set-error-mode.md)|Modifies `__error_mode` to determine a non-default location where the C run time writes an error message for an error that will possibly end the program.| -|[`_set_purecall_handler`](./reference/get-purecall-handler-set-purecall-handler.md)|Sets the handler for a pure virtual function call.| +| Routine | Use | +|---|---| +| [`assert`](./reference/assert-macro-assert-wassert.md) macro | Test for programming logic errors; available in both the release and debug versions of the run-time library. | +| [`_ASSERT`, `_ASSERTE`](./reference/assert-asserte-assert-expr-macros.md) macros | Similar to `assert`, but only available in the debug versions of the run-time library. | +| [`clearerr`](./reference/clearerr.md) | Reset error indicator. Calling `rewind` or closing a stream also resets the error indicator. | +| [`_eof`](./reference/eof.md) | Check for end of file in low-level I/O. | +| [`feof`](./reference/feof.md) | Test for end of file. End of file is also indicated when `_read` returns 0. | +| [`ferror`](./reference/ferror.md) | Test for stream I/O errors. | +| [`_RPT`, `_RPTF`](./reference/rpt-rptf-rptw-rptfw-macros.md) macros | Generate a report similar to `printf`, but only available in the debug versions of the run-time library. | +| [`_set_error_mode`](./reference/set-error-mode.md) | Modifies `__error_mode` to determine a non-default location where the C run time writes an error message for an error that will possibly end the program. | +| [`_set_purecall_handler`](./reference/get-purecall-handler-set-purecall-handler.md) | Sets the handler for a pure virtual function call. | ## See also diff --git a/docs/c-runtime-library/except-handler3.md b/docs/c-runtime-library/except-handler3.md index 40c7638cd5d..fc1a1439485 100644 --- a/docs/c-runtime-library/except-handler3.md +++ b/docs/c-runtime-library/except-handler3.md @@ -16,7 +16,7 @@ Internal CRT function. Used by a framework to find the appropriate exception han ## Syntax -``` +```C int _except_handler3( PEXCEPTION_RECORD exception_record, PEXCEPTION_REGISTRATION registration, diff --git a/docs/c-runtime-library/exception-handling-constants.md b/docs/c-runtime-library/exception-handling-constants.md index 27de90ff6ed..3ea54bfa938 100644 --- a/docs/c-runtime-library/exception-handling-constants.md +++ b/docs/c-runtime-library/exception-handling-constants.md @@ -2,7 +2,7 @@ description: "Learn more about: Exception-Handling Constants" title: "Exception-Handling Constants" ms.date: "11/04/2016" -f1_keywords: ["EXCEPTION_CONTINUE_SEARCH", "EXCEPTION_CONTINUE_EXECUTION", "EXCEPTION_EXECUTE_HANDLER"] +f1_keywords: ["EXCEPTION_CONTINUE_SEARCH", "EXCEPTION_CONTINUE_EXECUTION", "EXCEPTION_EXECUTE_HANDLER", "EXCPT/EXCEPTION_CONTINUE_SEARCH", "EXCPT/EXCEPTION_CONTINUE_EXECUTION", "EXCPT/EXCEPTION_EXECUTE_HANDLER"] helpviewer_keywords: ["exception handling, constants", "EXCEPTION_CONTINUE_SEARCH constant", "EXCEPTION_EXECUTE_HANDLER constant", "EXCEPTION_CONTINUE_EXECUTION constant", "EH constants"] ms.assetid: e1870f41-be9e-46a3-a2ea-830dfbaa18fb --- diff --git a/docs/c-runtime-library/exception-handling-routines.md b/docs/c-runtime-library/exception-handling-routines.md index 2d099a16f0b..c9755f8bf90 100644 --- a/docs/c-runtime-library/exception-handling-routines.md +++ b/docs/c-runtime-library/exception-handling-routines.md @@ -12,13 +12,13 @@ Use the C++ exception-handling functions to recover from unexpected events durin ## Exception-handling functions -|Function|Use| -|--------------|---------| -|[`_set_se_translator`](./reference/set-se-translator.md)|Handle Win32 exceptions (C structured exceptions) as C++ typed exceptions| -|[`set_terminate`](./reference/set-terminate-crt.md)|Install your own termination routine to be called by `terminate`| -|[`set_unexpected`](./reference/set-unexpected-crt.md)|Install your own termination function to be called by `unexpected`| -|[`terminate`](./reference/terminate-crt.md)|Called automatically under certain circumstances after exception is thrown. The `terminate` function calls `abort` or a function you specify using `set_terminate`| -|[`unexpected`](./reference/unexpected-crt.md)|Calls `terminate` or a function you specify using `set_unexpected`. The `unexpected` function isn't used in current Microsoft C++ exception-handling implementation| +| Function | Use | +|---|---| +| [`_set_se_translator`](./reference/set-se-translator.md) | Handle Win32 exceptions (C structured exceptions) as C++ typed exceptions | +| [`set_terminate`](./reference/set-terminate-crt.md) | Install your own termination routine to be called by `terminate` | +| [`set_unexpected`](./reference/set-unexpected-crt.md) | Install your own termination function to be called by `unexpected` | +| [`terminate`](./reference/terminate-crt.md) | Called automatically under certain circumstances after exception is thrown. The `terminate` function calls `abort` or a function you specify using `set_terminate` | +| [`unexpected`](./reference/unexpected-crt.md) | Calls `terminate` or a function you specify using `set_unexpected`. The `unexpected` function isn't used in current Microsoft C++ exception-handling implementation | ## See also diff --git a/docs/c-runtime-library/exec-wexec-functions.md b/docs/c-runtime-library/exec-wexec-functions.md index e0be1f4f149..9b9921f56fb 100644 --- a/docs/c-runtime-library/exec-wexec-functions.md +++ b/docs/c-runtime-library/exec-wexec-functions.md @@ -31,12 +31,12 @@ Each function in this family loads and executes a new process: The letter at the end of the function name determines the variation. -|_exec function suffix|Description| -|----------------------------|-----------------| -|`e`|`envp`, array of pointers to environment settings, is passed to the new process.| -|`l`|Command-line arguments are passed individually to `_exec` function. Typically used when the number of parameters to the new process is known in advance.| -|`p`|`PATH` environment variable is used to find the file to execute.| -|`v`|`argv`, array of pointers to command-line arguments, is passed to `_exec`. Typically used when the number of parameters to the new process is variable.| +| `_exec` function suffix | Description | +|---|---| +| `e` | `envp`, array of pointers to environment settings, is passed to the new process. | +| `l` | Command-line arguments are passed individually to `_exec` function. Typically used when the number of parameters to the new process is known in advance. | +| `p` | `PATH` environment variable is used to find the file to execute. | +| `v` | `argv`, array of pointers to command-line arguments, is passed to `_exec`. Typically used when the number of parameters to the new process is variable. | ## Remarks @@ -44,18 +44,18 @@ Each `_exec` function loads and executes a new process. All `_exec` functions us ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE and _MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_texecl`|`_execl`|`_execl`|`_wexecl`| -|`_texecle`|`_execle`|`_execle`|`_wexecle`| -|`_texeclp`|`_execlp`|`_execlp`|`_wexeclp`| -|`_texeclpe`|`_execlpe`|`_execlpe`|`_wexeclpe`| -|`_texecv`|`_execv`|`_execv`|`_wexecv`| -|`_texecve`|`_execve`|`_execve`|`_wexecve`| -|`_texecvp`|`_execvp`|`_execvp`|`_wexecvp`| -|`_texecvpe`|`_execvpe`|`_execvpe`|`_wexecvpe`| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_texecl` | **`_execl`** | **`_execl`** | **`_wexecl`** | +| `_texecle` | **`_execle`** | **`_execle`** | **`_wexecle`** | +| `_texeclp` | **`_execlp`** | **`_execlp`** | **`_wexeclp`** | +| `_texeclpe` | **`_execlpe`** | **`_execlpe`** | **`_wexeclpe`** | +| `_texecv` | **`_execv`** | **`_execv`** | **`_wexecv`** | +| `_texecve` | **`_execve`** | **`_execve`** | **`_wexecve`** | +| `_texecvp` | **`_execvp`** | **`_execvp`** | **`_wexecvp`** | +| `_texecvpe` | **`_execvpe`** | **`_execvpe`** | **`_wexecvpe`** | -The `cmdname` parameter specifies the file to be executed as the new process. It can specify a full path (from the root), a partial path (from the current working directory), or a file name. If `cmdname` doesn't have a file name extension or doesn't end with a period (.), the `_exec` function searches for the named file. If the search is unsuccessful, it tries the same base name with the .com file name extension and then with the .exe, .bat, and .cmd file name extensions. If `cmdname` has a file name extension, only that extension is used in the search. If `cmdname` ends with a period, the `_exec` function searches for `cmdname` with no file name extension. `_execlp`, `_execlpe`, `_execvp`, and `_execvpe` search for `cmdname` (using the same procedures) in the directories specified by the `PATH` environment variable. If `cmdname` contains a drive specifier or any slashes (that is, if it's a relative path), the `_exec` call searches only for the specified file; the path isn't searched. +The `cmdname` parameter specifies the file to be executed as the new process. It can specify a full path (from the root), a partial path (from the current working directory), or a file name. If `cmdname` doesn't have a file name extension or doesn't end with a period (.), the `_exec` function searches for the named file. If the search is unsuccessful, it tries the same base name with the .com file name extension and then with the .exe, .bat, and .cmd file name extensions. If `cmdname` has a file name extension, only that extension is used in the search. If `cmdname` ends with a period, the `_exec` function searches for `cmdname` with no file name extension. **`_execlp`**, **`_execlpe`**, **`_execvp`**, and **`_execvpe`** search for `cmdname` (using the same procedures) in the directories specified by the `PATH` environment variable. If `cmdname` contains a drive specifier or any slashes (that is, if it's a relative path), the `_exec` call searches only for the specified file; the path isn't searched. Parameters are passed to the new process by giving one or more pointers to character strings as parameters in the `_exec` call. These character strings form the parameter list for the new process. The combined length of the inherited environment settings and the strings forming the parameter list for the new process must not exceed 32 kilobytes. The terminating `NULL` character (`\0`) for each string isn't included in the count, but space characters (inserted automatically to separate the parameters) are counted. @@ -67,13 +67,13 @@ Parameters are passed to the new process by giving one or more pointers to chara The `_exec` functions validate their parameters. If expected parameters are null pointers, empty strings, or omitted, the `_exec` functions invoke the invalid parameter handler as described in [Parameter validation](./parameter-validation.md). If execution is allowed to continue, these functions set `errno` to `EINVAL` and return -1. No new process is executed. -The argument pointers can be passed as separate parameters (in `_execl`, `_execle`, `_execlp`, and `_execlpe`) or as an array of pointers (in `_execv`, `_execve`, `_execvp`, and `_execvpe`). At least one parameter, `arg0`, must be passed to the new process; this parameter is `argv[0]` of the new process. Usually, this parameter is a copy of `cmdname`. (A different value doesn't produce an error.) +The argument pointers can be passed as separate parameters (in **`_execl`**, **`_execle`**, **`_execlp`**, and **`_execlpe`**) or as an array of pointers (in **`_execv`**, **`_execve`**, **`_execvp`**, and **`_execvpe`**). At least one parameter, `arg0`, must be passed to the new process; this parameter is `argv[0]` of the new process. Usually, this parameter is a copy of `cmdname`. (A different value doesn't produce an error.) -The `_execl`, `_execle`, `_execlp`, and `_execlpe` calls are typically used when the number of parameters is known in advance. The parameter `arg0` is usually a pointer to `cmdname`. The parameters `arg1` through `argn` point to the character strings forming the new parameter list. A null pointer must follow `argn` to mark the end of the parameter list. +The **`_execl`**, **`_execle`**, **`_execlp`**, and **`_execlpe`** calls are typically used when the number of parameters is known in advance. The parameter `arg0` is usually a pointer to `cmdname`. The parameters `arg1` through `argn` point to the character strings forming the new parameter list. A null pointer must follow `argn` to mark the end of the parameter list. -The `_execv`, `_execve`, `_execvp`, and `_execvpe` calls are useful when the number of parameters to the new process is variable. Pointers to the parameters are passed as an array, `argv`. The parameter `argv[0]` is usually a pointer to `cmdname`. The parameters `argv[1]` through `argv[n]` point to the character strings forming the new parameter list. The parameter `argv[n+1]` must be a `NULL` pointer to mark the end of the parameter list. +The **`_execv`**, **`_execve`**, **`_execvp`**, and **`_execvpe`** calls are useful when the number of parameters to the new process is variable. Pointers to the parameters are passed as an array, `argv`. The parameter `argv[0]` is usually a pointer to `cmdname`. The parameters `argv[1]` through `argv[n]` point to the character strings forming the new parameter list. The parameter `argv[n+1]` must be a `NULL` pointer to mark the end of the parameter list. -Files that are open when an `_exec` call is made remain open in the new process. In `_execl`, `_execlp`, `_execv`, and `_execvp` calls, the new process inherits the environment of the calling process. `_execle`, `_execlpe`, `_execve`, and `_execvpe` calls alter the environment for the new process by passing a list of environment settings through the `envp` parameter. `envp` is an array of character pointers, each element of which (except for the final element) points to a null-terminated string defining an environment variable. Such a string usually has the form `NAME=value` where `NAME` is the name of an environment variable and `value` is the string value to which that variable is set. (The `value` isn't enclosed in double quotation marks.) The final element of the `envp` array should be `NULL`. When `envp` itself is `NULL`, the new process inherits the environment settings of the calling process. +Files that are open when an `_exec` call is made remain open in the new process. In **`_execl`**, **`_execlp`**, **`_execv`**, and **`_execvp`** calls, the new process inherits the environment of the calling process. **`_execle`**, **`_execlpe`**, **`_execve`**, and **`_execvpe`** calls alter the environment for the new process by passing a list of environment settings through the `envp` parameter. `envp` is an array of character pointers, each element of which (except for the final element) points to a null-terminated string defining an environment variable. Such a string usually has the form `NAME=value` where `NAME` is the name of an environment variable and `value` is the string value to which that variable is set. (The `value` isn't enclosed in double quotation marks.) The final element of the `envp` array should be `NULL`. When `envp` itself is `NULL`, the new process inherits the environment settings of the calling process. A program executed with one of the `_exec` functions is always loaded into memory as if the maximum allocation field in the program's .exe file header were set to the default value of `0xFFFFH`. diff --git a/docs/c-runtime-library/execute-onexit-table-initialize-onexit-table-register-onexit-function.md b/docs/c-runtime-library/execute-onexit-table-initialize-onexit-table-register-onexit-function.md index 023b04ce7c7..90cff65a6c1 100644 --- a/docs/c-runtime-library/execute-onexit-table-initialize-onexit-table-register-onexit-function.md +++ b/docs/c-runtime-library/execute-onexit-table-initialize-onexit-table-register-onexit-function.md @@ -16,7 +16,7 @@ Manages the routines to be called at exit time. ## Syntax -``` +```C int _initialize_onexit_table( _onexit_table_t* table ); @@ -47,21 +47,21 @@ If successful, the function returns 0. Otherwise, it returns a negative value. These functions are infrastructure implementation details used to support the C runtime, and shouldn't be called directly from your code. The C runtime uses an `onexit` function table to represent the sequence of functions registered by calls to `atexit`, `at_quick_exit`, and `_onexit`. The `onexit` function table data structure is an opaque implementation detail of the C runtime; the order and meaning of its data members may change. They shouldn't be inspected by external code. -The `_initialize_onexit_table` function initializes the `onexit` function table to its initial value. This function must be called before the `onexit` function table is passed to either `_register_onexit_function` or `_execute_onexit_table`. +The **`_initialize_onexit_table`** function initializes the `onexit` function table to its initial value. This function must be called before the `onexit` function table is passed to either **`_register_onexit_function`** or **`_execute_onexit_table`**. -The `_register_onexit_function` function appends a function to the end of the `onexit` function table. +The **`_register_onexit_function`** function appends a function to the end of the `onexit` function table. -The `_execute_onexit_table` function executes all of the functions in the `onexit` function table, clears the table, and then returns. After a call to `_execute_onexit_table`, the table is in a non-valid state; it must be reinitialized by a call to `_initialize_onexit_table` before it's used again. +The **`_execute_onexit_table`** function executes all of the functions in the `onexit` function table, clears the table, and then returns. After a call to **`_execute_onexit_table`**, the table is in a non-valid state; it must be reinitialized by a call to **`_initialize_onexit_table`** before it's used again. 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). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`_initialize_onexit_table function`, `_register_onexit_function`, `_execute_onexit_table`|C, C++: \| +| Routine | Required header | +|---|---| +| **`_initialize_onexit_table`**, **`_register_onexit_function`**, **`_execute_onexit_table`** | C, C++: \ | -The `_initialize_onexit_table`, `_register_onexit_function`, and `_execute_onexit_table` functions are Microsoft-specific. For compatibility information, see [Compatibility](./compatibility.md). +The **`_initialize_onexit_table`**, **`_register_onexit_function`**, and **`_execute_onexit_table`** functions are Microsoft-specific. For compatibility information, see [Compatibility](./compatibility.md). ## See also diff --git a/docs/c-runtime-library/exit-success-exit-failure.md b/docs/c-runtime-library/exit-success-exit-failure.md index 813aa17c7d2..ddedc9aa4cd 100644 --- a/docs/c-runtime-library/exit-success-exit-failure.md +++ b/docs/c-runtime-library/exit-success-exit-failure.md @@ -2,7 +2,7 @@ description: "Learn more about: EXIT_SUCCESS, EXIT_FAILURE" title: "EXIT_SUCCESS, EXIT_FAILURE" ms.date: "06/25/2018" -f1_keywords: ["EXIT_FAILURE", "EXIT_SUCCESS"] +f1_keywords: ["EXIT_FAILURE", "EXIT_SUCCESS", "STDLIB/EXIT_FAILURE", "STDLIB/EXIT_SUCCESS"] helpviewer_keywords: ["EXIT_SUCCESS constant", "EXIT_FAILURE constant"] --- # `EXIT_SUCCESS`, `EXIT_FAILURE` @@ -15,12 +15,12 @@ helpviewer_keywords: ["EXIT_SUCCESS constant", "EXIT_FAILURE constant"] ## Remarks -The `EXIT_SUCCESS` and `EXIT_FAILURE` constants are arguments for the [`exit`](reference/exit-exit-exit.md) and [`_exit`](reference/exit-exit-exit.md) functions, and the return values for the [`atexit`](reference/atexit.md) and [`_onexit`](reference/onexit-onexit-m.md) functions. +The **`EXIT_SUCCESS`** and `EXIT_FAILURE` constants are arguments for the [`exit`](reference/exit-exit-exit.md) and [`_exit`](reference/exit-exit-exit.md) functions, and the return values for the [`atexit`](reference/atexit.md) and [`_onexit`](reference/onexit-onexit-m.md) functions. -|Constant|Defined value| -|-|-| -|`EXIT_SUCCESS`|0| -|`EXIT_FAILURE`|1| +| Constant | Defined value | +|---|---| +| **`EXIT_SUCCESS`** | 0 | +| **`EXIT_FAILURE`** | 1 | ## See also diff --git a/docs/c-runtime-library/file-attribute-constants.md b/docs/c-runtime-library/file-attribute-constants.md index a7fc3535e71..a7d89dbfd8d 100644 --- a/docs/c-runtime-library/file-attribute-constants.md +++ b/docs/c-runtime-library/file-attribute-constants.md @@ -2,7 +2,7 @@ description: "Learn more about: File Attribute Constants" title: "File Attribute Constants" ms.date: "11/04/2016" -f1_keywords: ["A_HIDDEN", "_A_NORMAL", "_A_SUBDIR", "_A_RDONLY", "A_NORMAL", "A_SUBDIR", "_A_SYSTEM", "c.constants.file", "_A_HIDDEN", "A_RDONLY", "_A_ARCH", "A_ARCH"] +f1_keywords: ["_A_ARCH", "_A_HIDDEN", "_A_NORMAL", "_A_RDONLY", "_A_SUBDIR", "_A_SYSTEM", "CORECRT_IO/_A_ARCH", "CORECRT_IO/_A_HIDDEN", "CORECRT_IO/_A_NORMAL", "CORECRT_IO/_A_RDONLY", "CORECRT_IO/_A_SUBDIR", "CORECRT_IO/_A_SYSTEM", "c.constants.file"] helpviewer_keywords: ["constants [C++], file attributes", "file attribute constants [C++]", "_A_SYSTEM constant", "files [C++], file attribute constants", "_A_SUBDIR constant", "_A_ARCH constant", "_A_NORMAL constant", "_A_HIDDEN constant", "_A_RDONLY constant"] ms.assetid: 8dc8ccb9-99f5-446b-876c-7ebecc2f764f --- @@ -10,7 +10,7 @@ ms.assetid: 8dc8ccb9-99f5-446b-876c-7ebecc2f764f ## Syntax -``` +```C #include ``` @@ -20,14 +20,14 @@ These constants specify the current attributes of the file or directory specifie The attributes are represented by the following manifest constants: -|Constant|Description| -|-|-| -|`_A_ARCH`| Archive. Set whenever the file is changed, and cleared by the BACKUP command. Value: 0x20| -|`_A_HIDDEN`| Hidden file. Not normally seen with the DIR command, unless the /AH option is used. Returns information about both normal files and files with this attribute. Value: 0x02| -|`_A_NORMAL`| Normal. File can be read or written to without restriction. Value: 0x00| -|`_A_RDONLY`| Read-only. File can't be opened for writing, and a file with the same name can't be created. Value: 0x01| -|`_A_SUBDIR`| Subdirectory. Value: 0x10| -|`_A_SYSTEM`| System file. Not normally seen with the DIR command, unless the /AS option is used. Value: 0x04| +| Constant | Description | +|---|---| +| `_A_ARCH` | Archive. Set whenever the file is changed, and cleared by the BACKUP command. Value: 0x20 | +| `_A_HIDDEN` | Hidden file. Not normally seen with the DIR command, unless the /AH option is used. Returns information about both normal files and files with this attribute. Value: 0x02 | +| `_A_NORMAL` | Normal. File can be read or written to without restriction. Value: 0x00 | +| `_A_RDONLY` | Read-only. File can't be opened for writing, and a file with the same name can't be created. Value: 0x01 | +| `_A_SUBDIR` | Subdirectory. Value: 0x10 | +| `_A_SYSTEM` | System file. Not normally seen with the DIR command, unless the /AS option is used. Value: 0x04 | Multiple constants can be combined with the OR operator (`|`). diff --git a/docs/c-runtime-library/file-constants.md b/docs/c-runtime-library/file-constants.md index 782e5d869fe..2d129f4ee1b 100644 --- a/docs/c-runtime-library/file-constants.md +++ b/docs/c-runtime-library/file-constants.md @@ -2,7 +2,7 @@ description: "Learn more about: File Constants" title: "File Constants" ms.date: "11/04/2016" -f1_keywords: ["_O_EXCL", "_O_RDWR", "_O_APPEND", "_O_RDONLY", "_O_TRUNC", "_O_CREAT", "_O_WRONLY"] +f1_keywords: ["_O_APPEND", "_O_CREAT", "_O_EXCL", "_O_RDONLY", "_O_RDWR", "_O_TRUNC", "_O_WRONLY", "FCNTL/_O_APPEND", "FCNTL/_O_CREAT", "FCNTL/_O_EXCL", "FCNTL/_O_RDONLY", "FCNTL/_O_RDWR", "FCNTL/_O_TRUNC", "FCNTL/_O_WRONLY"] helpviewer_keywords: ["_O_RDWR constant", "O_EXCL constant", "O_RDWR constant", "O_WRONLY constant", "O_APPEND constant", "O_CREAT constant", "_O_CREAT constant", "_O_APPEND constant", "_O_EXCL constant", "O_TRUNC constant", "_O_RDONLY constant", "_O_TRUNC constant", "O_RDONLY constant", "_O_WRONLY constant"] ms.assetid: c8fa5548-9ac2-4217-801d-eb45e86f2fa4 --- @@ -10,7 +10,7 @@ ms.assetid: c8fa5548-9ac2-4217-801d-eb45e86f2fa4 ## Syntax -``` +```C #include ``` @@ -20,15 +20,15 @@ The integer expression formed from one or more of these constants determines the The file constants are as follows: -|Constant|Description| -|-|-| -| `_O_APPEND` | Repositions the file pointer to the end of the file before every write operation. | -| `_O_CREAT` | Creates and opens a new file for writing; the constant has no effect if the file specified by *`filename`* exists. | -| `_O_EXCL` | Returns an error value if the file specified by *`filename`* exists. Only applies when used with `_O_CREAT`. | -| `_O_RDONLY` | Opens file for reading only; if this flag is given, `_O_RDWR` and `_O_WRONLY` can't be given. | -| `_O_RDWR` | Opens file for both reading and writing; if this flag is given, `_O_RDONLY` and `_O_WRONLY` can't be given. | -| `_O_TRUNC` | Opens and truncates an existing file to zero length; the file must have write permission. The contents of the file are destroyed. If this flag is given, you can't specify `_O_RDONLY`. | -| `_O_WRONLY` | Opens file for writing only; if this flag is given, `_O_RDONLY` and `_O_RDWR` can't be given. | +| Constant | Description | +|---|---| +| `_O_APPEND` | Repositions the file pointer to the end of the file before every write operation. | +| `_O_CREAT` | Creates and opens a new file for writing; the constant has no effect if the file specified by *`filename`* exists. | +| `_O_EXCL` | Returns an error value if the file specified by *`filename`* exists. Only applies when used with `_O_CREAT`. | +| `_O_RDONLY` | Opens file for reading only; if this flag is given, `_O_RDWR` and `_O_WRONLY` can't be given. | +| `_O_RDWR` | Opens file for both reading and writing; if this flag is given, `_O_RDONLY` and `_O_WRONLY` can't be given. | +| `_O_TRUNC` | Opens and truncates an existing file to zero length; the file must have write permission. The contents of the file are destroyed. If this flag is given, you can't specify `_O_RDONLY`. | +| `_O_WRONLY` | Opens file for writing only; if this flag is given, `_O_RDONLY` and `_O_RDWR` can't be given. | ## See also diff --git a/docs/c-runtime-library/file-handling.md b/docs/c-runtime-library/file-handling.md index 9377aad6c99..9ff1cf7924e 100644 --- a/docs/c-runtime-library/file-handling.md +++ b/docs/c-runtime-library/file-handling.md @@ -16,56 +16,56 @@ The C run-time libraries have a 512 limit for the number of files that can be op These routines operate on files designated by a file descriptor. -|Routine|Use| -|-------------|---------| -|[`_chsize`](./reference/chsize.md),[`_chsize_s`](./reference/chsize-s.md)|Change file size| -|[`_filelength`, `_filelengthi64`](./reference/filelength-filelengthi64.md)|Get file length| -|[`_fstat`, `_fstat32`, `_fstat64`, `_fstati64`, `_fstat32i64`, `_fstat64i32`](./reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md)|Get file-status information on descriptor| -|[`_get_osfhandle`](./reference/get-osfhandle.md)|Return operating-system file handle associated with existing C run-time file descriptor| -|[`_isatty`](./reference/isatty.md)|Check for character device| -|[`_locking`](./reference/locking.md)|Lock areas of file| -|[`_open_osfhandle`](./reference/open-osfhandle.md)|Associate C run-time file descriptor with existing operating-system file handle| -|[`_setmode`](./reference/setmode.md)|Set file-translation mode| +| Routine | Use | +|---|---| +| [`_chsize`](./reference/chsize.md),[`_chsize_s`](./reference/chsize-s.md) | Change file size | +| [`_filelength`, `_filelengthi64`](./reference/filelength-filelengthi64.md) | Get file length | +| [`_fstat`, `_fstat32`, `_fstat64`, `_fstati64`, `_fstat32i64`, `_fstat64i32`](./reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md) | Get file-status information on descriptor | +| [`_get_osfhandle`](./reference/get-osfhandle.md) | Return operating-system file handle associated with existing C run-time file descriptor | +| [`_isatty`](./reference/isatty.md) | Check for character device | +| [`_locking`](./reference/locking.md) | Lock areas of file | +| [`_open_osfhandle`](./reference/open-osfhandle.md) | Associate C run-time file descriptor with existing operating-system file handle | +| [`_setmode`](./reference/setmode.md) | Set file-translation mode | ## File-Handling Routines (Path or Filename) These routines operate on files specified by a path or filename. -|Routine|Use| -|-------------|---------| -|[`_access`, `_waccess`](./reference/access-waccess.md), [`_access_s`, `_waccess_s`](./reference/access-s-waccess-s.md)|Check file-permission setting| -|[`_chmod`, `_wchmod`](./reference/chmod-wchmod.md)|Change file-permission setting| -|[`_fullpath`, `_wfullpath`](./reference/fullpath-wfullpath.md)|Expand a relative path to its absolute path name| -|[`_makepath`, `_wmakepath`](./reference/makepath-wmakepath.md), [`_makepath_s`, `_wmakepath_s`](./reference/makepath-s-wmakepath-s.md)|Merge path components into single, full path| -|[`_mktemp`, `_wmktemp`](./reference/mktemp-wmktemp.md), [`_mktemp_s`, `_wmktemp_s`](./reference/mktemp-s-wmktemp-s.md)|Create unique filename| -|[`remove`, `_wremove`](./reference/remove-wremove.md)|Delete file| -|[`rename`, `_wrename`](./reference/rename-wrename.md)|Rename file| -|[`_splitpath`, `_wsplitpath`](./reference/splitpath-wsplitpath.md), [`_splitpath_s`, `_wsplitpath_s`](./reference/splitpath-s-wsplitpath-s.md)|Parse path into components| -|[`_stat`, `_stat64`, `_stati64`, `_wstat`, `_wstat64`, `_wstati64`](./reference/stat-functions.md)|Get file-status information on named file| -|[`_umask`](./reference/umask.md), [`_umask_s`](./reference/umask-s.md)|Set default permission mask for new files created by program| -|[`_unlink`, `_wunlink`](./reference/unlink-wunlink.md)|Delete file| +| Routine | Use | +|---|---| +| [`_access`, `_waccess`](./reference/access-waccess.md), [`_access_s`, `_waccess_s`](./reference/access-s-waccess-s.md) | Check file-permission setting | +| [`_chmod`, `_wchmod`](./reference/chmod-wchmod.md) | Change file-permission setting | +| [`_fullpath`, `_wfullpath`](./reference/fullpath-wfullpath.md) | Expand a relative path to its absolute path name | +| [`_makepath`, `_wmakepath`](./reference/makepath-wmakepath.md), [`_makepath_s`, `_wmakepath_s`](./reference/makepath-s-wmakepath-s.md) | Merge path components into single, full path | +| [`_mktemp`, `_wmktemp`](./reference/mktemp-wmktemp.md), [`_mktemp_s`, `_wmktemp_s`](./reference/mktemp-s-wmktemp-s.md) | Create unique filename | +| [`remove`, `_wremove`](./reference/remove-wremove.md) | Delete file | +| [`rename`, `_wrename`](./reference/rename-wrename.md) | Rename file | +| [`_splitpath`, `_wsplitpath`](./reference/splitpath-wsplitpath.md), [`_splitpath_s`, `_wsplitpath_s`](./reference/splitpath-s-wsplitpath-s.md) | Parse path into components | +| [`_stat`, `_stat64`, `_stati64`, `_wstat`, `_wstat64`, `_wstati64`](./reference/stat-functions.md) | Get file-status information on named file | +| [`_umask`](./reference/umask.md), [`_umask_s`](./reference/umask-s.md) | Set default permission mask for new files created by program | +| [`_unlink`, `_wunlink`](./reference/unlink-wunlink.md) | Delete file | ## File-Handling Routines (Open File) These routines open files. -|Routine|Use| -|-------------|---------| -|[`fopen`, `_wfopen`](./reference/fopen-wfopen.md), [`fopen_s`, `_wfopen_s`](./reference/fopen-s-wfopen-s.md)|Opens a file and returns a pointer to the open file.| -|[`_fsopen`, `_wfsopen`](./reference/fsopen-wfsopen.md)|Open a stream with file sharing and returns a pointer to the open file.| -|[`_open`, `_wopen`](./reference/open-wopen.md)|Opens a file and returns a file descriptor to the opened file.| -|[`_sopen`, `_wsopen`](./reference/sopen-wsopen.md), [`_sopen_s`, `_wsopen_s`](./reference/sopen-s-wsopen-s.md)|Open a file with file sharing and returns a file descriptor to the open file.| -|[`_pipe`](./reference/pipe.md)|Creates a pipe for reading and writing.| -|[`freopen`, `_wfreopen`](./reference/freopen-wfreopen.md), [`freopen_s`, `_wfreopen_s`](./reference/freopen-s-wfreopen-s.md)|Reassign a file pointer.| +| Routine | Use | +|---|---| +| [`fopen`, `_wfopen`](./reference/fopen-wfopen.md), [`fopen_s`, `_wfopen_s`](./reference/fopen-s-wfopen-s.md) | Opens a file and returns a pointer to the open file. | +| [`_fsopen`, `_wfsopen`](./reference/fsopen-wfsopen.md) | Open a stream with file sharing and returns a pointer to the open file. | +| [`_open`, `_wopen`](./reference/open-wopen.md) | Opens a file and returns a file descriptor to the opened file. | +| [`_sopen`, `_wsopen`](./reference/sopen-wsopen.md), [`_sopen_s`, `_wsopen_s`](./reference/sopen-s-wsopen-s.md) | Open a file with file sharing and returns a file descriptor to the open file. | +| [`_pipe`](./reference/pipe.md) | Creates a pipe for reading and writing. | +| [`freopen`, `_wfreopen`](./reference/freopen-wfreopen.md), [`freopen_s`, `_wfreopen_s`](./reference/freopen-s-wfreopen-s.md) | Reassign a file pointer. | These routines provide a way to change the representation of the file between a `FILE` structure, a file descriptor, and a Win32 file handle. -|Routine|Use| -|-------------|---------| -|[`_fdopen`, `_wfdopen`](./reference/fdopen-wfdopen.md)|Associates a stream with a file that was previously opened for low-level I/O and returns a pointer to the open stream.| -|[`_fileno`](./reference/fileno.md)|Gets the file descriptor associated with a stream.| -|[`_get_osfhandle`](./reference/get-osfhandle.md)|Return operating-system file handle associated with existing C run-time file descriptor| -|[`_open_osfhandle`](./reference/open-osfhandle.md)|Associates C run-time file descriptor with an existing operating-system file handle.| +| Routine | Use | +|---|---| +| [`_fdopen`, `_wfdopen`](./reference/fdopen-wfdopen.md) | Associates a stream with a file that was previously opened for low-level I/O and returns a pointer to the open stream. | +| [`_fileno`](./reference/fileno.md) | Gets the file descriptor associated with a stream. | +| [`_get_osfhandle`](./reference/get-osfhandle.md) | Return operating-system file handle associated with existing C run-time file descriptor | +| [`_open_osfhandle`](./reference/open-osfhandle.md) | Associates C run-time file descriptor with an existing operating-system file handle. | The following Win32 functions also open files and pipes: diff --git a/docs/c-runtime-library/file-permission-constants.md b/docs/c-runtime-library/file-permission-constants.md index 9b6c5bc78fe..cf520324849 100644 --- a/docs/c-runtime-library/file-permission-constants.md +++ b/docs/c-runtime-library/file-permission-constants.md @@ -9,7 +9,7 @@ ms.assetid: 593cad33-31d1-44d2-8941-8af7d210c88c ## Syntax -``` +```C #include ``` @@ -19,19 +19,19 @@ One of these constants is required when `_O_CREAT` (`_open`, `_sopen`) is specif The `pmode` argument specifies the file's permission settings as follows. -|Constant|Meaning| -|--------------|-------------| -|`_S_IREAD`|Reading permitted| -|`_S_IWRITE`|Writing permitted| -|`_S_IREAD | _S_IWRITE`|Reading and writing permitted| +| Constant | Meaning | +|---|---| +| `_S_IREAD` | Reading permitted | +| `_S_IWRITE` | Writing permitted | +| `_S_IREAD | _S_IWRITE` | Reading and writing permitted | When used as the `pmode` argument for `_umask`, the manifest constant sets the permission setting, as follows. -|Constant|Meaning| -|--------------|-------------| -|`_S_IREAD`|Writing not permitted (file is read-only)| -|`_S_IWRITE`|Reading not permitted (file is write-only)| -|`_S_IREAD | _S_IWRITE`|Both reading and writing not permitted| +| Constant | Meaning | +|---|---| +| `_S_IREAD` | Writing not permitted (file is read-only) | +| `_S_IWRITE` | Reading not permitted (file is write-only) | +| `_S_IREAD | _S_IWRITE` | Both reading and writing not permitted | ## See also diff --git a/docs/c-runtime-library/file-read-write-access-constants.md b/docs/c-runtime-library/file-read-write-access-constants.md index 5371e123470..ebb65e68dd4 100644 --- a/docs/c-runtime-library/file-read-write-access-constants.md +++ b/docs/c-runtime-library/file-read-write-access-constants.md @@ -9,7 +9,7 @@ ms.assetid: 56cd1d22-39a5-4fcf-bea2-7046d249e8ee ## Syntax -``` +```C #include ``` @@ -19,14 +19,14 @@ These constants specify the access type ("a", "r", or "w") requested for the fil The access types are described in this table: -|Access type|Description| -|----------|----------------| -|**"r"**|Opens for reading. If the file doesn't exist or can't be found, the call to open the file fails.| -|**"w"**|Opens an empty file for writing. If the given file exists, its contents are destroyed.| -|**"a"**|Opens for writing at the end of the file (appending); creates the file first if it doesn't exist. All write operations occur at the end of the file. Although the file pointer can be repositioned using `fseek` or `rewind`, it's always moved back to the end of the file before any write operation is carried out. | -|**"r+"**|Opens for both reading and writing. If the file doesn't exist or can't be found, the call to open the file fails.| -|**"w+"**|Opens an empty file for both reading and writing. If the given file exists, its contents are destroyed.| -|**"a+"**|The same as **"a"** but also allows reading.| +| Access type | Description | +|---|---| +| **"`r`"** | Opens for reading. If the file doesn't exist or can't be found, the call to open the file fails. | +| **"`w`"** | Opens an empty file for writing. If the given file exists, its contents are destroyed. | +| **"`a`"** | Opens for writing at the end of the file (appending); creates the file first if it doesn't exist. All write operations occur at the end of the file. Although the file pointer can be repositioned using `fseek` or `rewind`, it's always moved back to the end of the file before any write operation is carried out. | +| **"`r+`"** | Opens for both reading and writing. If the file doesn't exist or can't be found, the call to open the file fails. | +| **"`w+`"** | Opens an empty file for both reading and writing. If the given file exists, its contents are destroyed. | +| **"`a+`"** | The same as **"`a`"** but also allows reading. | When the "r+", "w+", or "a+" type is specified, both reading and writing are allowed (the file is said to be open for "update"). However, when you switch between reading and writing, there must be an intervening `fflush`, `fsetpos`, `fseek`, or `rewind` operation. The current position can be specified for the `fsetpos` or `fseek` operation. diff --git a/docs/c-runtime-library/file-translation-constants.md b/docs/c-runtime-library/file-translation-constants.md index ef2eb9e63a9..74ecd23f242 100644 --- a/docs/c-runtime-library/file-translation-constants.md +++ b/docs/c-runtime-library/file-translation-constants.md @@ -9,7 +9,7 @@ ms.assetid: 49b13bf3-442e-4d19-878b-bd1029fa666a ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/filename-max.md b/docs/c-runtime-library/filename-max.md index 79c397f9984..71cd7fb0a35 100644 --- a/docs/c-runtime-library/filename-max.md +++ b/docs/c-runtime-library/filename-max.md @@ -12,7 +12,7 @@ The maximum permissible length for a `filename` string buffer size. ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/filename-search-functions.md b/docs/c-runtime-library/filename-search-functions.md index fdc98ed11a3..b11a46b69ab 100644 --- a/docs/c-runtime-library/filename-search-functions.md +++ b/docs/c-runtime-library/filename-search-functions.md @@ -77,13 +77,13 @@ Functions `_findfirst32i64`, `_findnext32i64`, `_wfindfirst32i64`, and `_wfindne `_finddata_t` is actually a macro that evaluates to `_finddata64i32_t` (or `_finddata32_t` if `_USE_32BIT_TIME_T` is defined). The following table summarizes the variations on `_finddata_t`: -|Structure|Time type|File size type| -|---------------|---------------|--------------------| -|`_finddata_t`, `_wfinddata_t`|`__time64_t`|`_fsize_t`| -|`_finddata32_t`, `_wfinddata32_t`|`__time32_t`|`_fsize_t`| -|`__finddata64_t`, `__wfinddata64_t`|`__time64_t`|**`__int64`**| -|`_finddata32i64_t`, `_wfinddata32i64_t`|`__time32_t`|**`__int64`**| -|`_finddata64i32_t`, `_wfinddata64i32_t`|`__time64_t`|`_fsize_t`| +| Structure | Time type | File size type | +|---|---|---| +| `_finddata_t`, `_wfinddata_t` | `__time64_t` | `_fsize_t` | +| `_finddata32_t`, `_wfinddata32_t` | `__time32_t` | `_fsize_t` | +| `__finddata64_t`, `__wfinddata64_t` | `__time64_t` | **`__int64`** | +| `_finddata32i64_t`, `_wfinddata32i64_t` | `__time32_t` | **`__int64`** | +| `_finddata64i32_t`, `_wfinddata64i32_t` | `__time64_t` | `_fsize_t` | `_fsize_t` is a **`typedef`** for **`unsigned long`** (32 bits). diff --git a/docs/c-runtime-library/floating-point-support.md b/docs/c-runtime-library/floating-point-support.md index 2eac29ba5cb..69a51ce7ce6 100644 --- a/docs/c-runtime-library/floating-point-support.md +++ b/docs/c-runtime-library/floating-point-support.md @@ -17,115 +17,115 @@ Previous 16-bit versions of Microsoft C/C++ and Microsoft Visual C++ supported t ## Supported math and floating-point routines -|Routine|Use| -|-|-| -[`abs`, `labs`, `llabs`, `_abs64`](./reference/abs-labs-llabs-abs64.md)|Computes the absolute value of an integer type -[`acos`, `acosf`, `acosl`](./reference/acos-acosf-acosl.md)|Computes the arc cosine -[`acosh`, `acoshf`, `acoshl`](./reference/acosh-acoshf-acoshl.md)|Computes the hyperbolic arc cosine -[`asin`, `asinf`, `asinl`](./reference/asin-asinf-asinl.md)|Computes the arc sine -[`asinh`, `asinhf`, `asinhl`](./reference/asinh-asinhf-asinhl.md)|Computes the hyperbolic arc sine -[`atan`, `atanf`, `atanl`, `atan2`, `atan2f`, `atan2l`](./reference/atan-atanf-atanl-atan2-atan2f-atan2l.md)|Computes the arc tangent -[`atanh`, `atanhf`, `atanhl`](./reference/atanh-atanhf-atanhl.md)|Computes the hyperbolic arc tangent -[`_atodbl`, `_atodbl_l`](./reference/atodbl-atodbl-l-atoldbl-atoldbl-l-atoflt-atoflt-l.md)|Converts a locale-specific string to a **`double`** -[`atof`, `_atof_l`](./reference/atof-atof-l-wtof-wtof-l.md)|Converts a string to a **`double`** -[`_atoflt`, `_atoflt_l`, `_atoldbl`, `_atoldbl_l`](./reference/atodbl-atodbl-l-atoldbl-atoldbl-l-atoflt-atoflt-l.md)|Converts a locale-specific string to a **`float`** or **`long double`** -[`cbrt`, `cbrtf`, `cbrtl`](./reference/cbrt-cbrtf-cbrtl.md)|Computes the cube root -[`ceil`, `ceilf`, `ceill`](./reference/ceil-ceilf-ceill.md)|Computes the ceiling -[`_chgsign`, `_chgsignf`, `_chgsignl`](./reference/chgsign-chgsignf-chgsignl.md)|Computes the additive inverse -[`_clear87`, `_clearfp`](./reference/clear87-clearfp.md)|Gets and clears the floating-point status register -[`_control87`, `_controlfp`, `__control87_2`](./reference/control87-controlfp-control87-2.md)|Gets and sets the floating-point control word -[`_controlfp_s`](./reference/controlfp-s.md)|Secure version of **`_controlfp`** -[`copysign`, `copysignf`, `copysignl`, `_copysign`, `_copysignf`, `_copysignl`](./reference/copysign-copysignf-copysignl-copysign-copysignf-copysignl.md)|Returns a value that has the magnitude of one argument and the sign of another -[`cos`, `cosf`, `cosl`](./reference/cos-cosf-cosl.md)|Computes the sine -[`cosh`, `coshf`, `coshl`](./reference/cosh-coshf-coshl.md)|Computes the hyperbolic sine -[`div`, `ldiv`, `lldiv`](./reference/div.md)|Computes the quotient and the remainder of two integer values -[`_ecvt`](./reference/ecvt.md), [`ecvt`](./reference/posix-ecvt.md)|Converts a **`double`** to a string -[`_ecvt_s`](./reference/ecvt-s.md)|Secure version of **`_ecvt`** -[`erf`, `erff`, `erfl`](./reference/erf-erff-erfl-erfc-erfcf-erfcl.md)|Computes the error function -[`erfc`, `erfcf`, `erfcl`](./reference/erf-erff-erfl-erfc-erfcf-erfcl.md)|Computes the complementary error function -[`exp`, `expf`, `expl`](./reference/exp-expf.md)|Computes the exponential *e*x -[`exp2`, `exp2f`, `exp2l`](./reference/exp2-exp2f-exp2l.md)|Computes the exponential 2x -[`expm1`, `expm1f`, `expm1l`](./reference/expm1-expm1f-expm1l.md)|Computes *e*x-1 -[`fabs`, `fabsf`, `fabsl`](./reference/fabs-fabsf-fabsl.md)|Computes the absolute value of a floating-point type -[`_fcvt`](./reference/fcvt.md), [`fcvt`](./reference/posix-fcvt.md)|Converts a floating-point number to a string -[`_fcvt_s`](./reference/fcvt-s.md)|Secure version of **`_fcvt`** -[`fdim`, `fdimf`, `fdiml`](./reference/fdim-fdimf-fdiml.md)|Determines the positive difference between two values -[`feclearexcept`](./reference/feclearexcept1.md)|Clears specified floating-point exceptions -[`fegetenv`](./reference/fegetenv1.md)|Stores the current floating-point environment -[`fegetexceptflag`](./reference/fegetexceptflag2.md)|Gets the specified floating-point exception status -[`fegetround`](./reference/fegetround-fesetround2.md)|Gets the floating-point rounding mode -[`feholdexcept`](./reference/feholdexcept2.md)|Sets non-stop floating-point exception mode -[`feraiseexcept`](./reference/feraiseexcept.md)|Raises the specified floating-point exceptions -[`fesetenv`](./reference/fesetenv1.md)|Sets the current floating-point environment -[`fesetexceptflag`](./reference/fesetexceptflag2.md)|Sets the specified floating-point status flags -[`fesetround`](./reference/fegetround-fesetround2.md)|Sets the specified floating-point rounding mode -[`fetestexcept`](./reference/fetestexcept1.md)|Determines which floating-point exception status flags are set -[`feupdateenv`](./reference/feupdateenv.md)|Restores a floating-point environment then raises previous exceptions -[`floor`, `floorf`, `floorl`](./reference/floor-floorf-floorl.md)|Computes the floor -[`fma`, `fmaf`, `fmal`](./reference/fma-fmaf-fmal.md)|Computes a fused multiply-add -[`fmax`, `fmaxf`, `fmaxl`](./reference/fmax-fmaxf-fmaxl.md)|Computes the maximum of the arguments -[`fmin`, `fminf`, `fminl`](./reference/fmin-fminf-fminl.md)|Computes the minimum of the arguments -[`fmod`, `fmodf`, `fmodl`](./reference/fmod-fmodf.md)|Computes the floating-point remainder -[`_fpclass`, `_fpclassf`](./reference/fpclass-fpclassf.md)|Returns the classification of a floating-point value -[`fpclassify`](./reference/fpclassify.md)|Returns the classification of a floating-point value -[`_fpieee_flt`](./reference/fpieee-flt.md)|Sets a handler for floating-point exceptions -[`_fpreset`](./reference/fpreset.md)|Resets the floating-point environment -[`frexp`, `frexpf`, `frexpl`](./reference/frexp.md)|Gets the mantissa and exponent of a floating-point number -[`_gcvt`](./reference/gcvt.md), [`gcvt`](./reference/posix-gcvt.md)|Converts a floating-point number to a string -[`_gcvt_s`](./reference/gcvt-s.md)|Secure version of **`_gcvt`** -[`_get_FMA3_enable`, `_set_FMA3_enable`](./reference/get-fma3-enable-set-fma3-enable.md)|Gets or sets a flag for use of FMA3 instructions on x64 -[`hypot`, `hypotf`, `hypotl`, `_hypot`, `_hypotf`, `_hypotl`](./reference/hypot-hypotf-hypotl-hypot-hypotf-hypotl.md)|Computes the hypotenuse -[`ilogb`, `ilogbf`, `ilogbl`](./reference/ilogb-ilogbf-ilogbl2.md)|Computes the integer base-2 exponent -[`imaxabs`](./reference/imaxabs.md)|Computes the absolute value of an integer type -[`imaxdiv`](./reference/imaxdiv.md)|Computes the quotient and the remainder of two integer values -[`isfinite`, `_finite`, `_finitef`](./reference/finite-finitef.md)|Determines whether a value is finite -[`isgreater`, `isgreaterequal`, `isless`, `islessequal`, `islessgreater`, `isunordered`](./reference/floating-point-ordering.md)|Compare the order of two floating point values -[`isinf`](./reference/isinf.md)|Determines whether a floating-point value is infinite -[`isnan`, `_isnan`, `_isnanf`](./reference/isnan-isnan-isnanf.md)|Tests a floating-point value for NaN -[`isnormal`](./reference/isnormal.md)|Tests whether a floating-point value is both finite and not subnormal -[`_j0`, `_j1`, `_jn`](./reference/bessel-functions-j0-j1-jn-y0-y1-yn.md)|Computes the Bessel function -[`ldexp`, `ldexpf`, `ldexpl`](./reference/ldexp.md)|Computes x*2n -[`lgamma`, `lgammaf`, `lgammal`](./reference/lgamma-lgammaf-lgammal.md)|Computes the natural logarithm of the absolute value of the gamma function -[`llrint`, `llrintf`, `llrintl`](./reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md)|Rounds a floating-point value to the nearest **`long long`** value -[`llround`, `llroundf`, `llroundl`](./reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md)|Rounds a floating-point value to the nearest **`long long`** value -[`log`, `logf`, `logl`, `log10`, `log10f`, `log10l`](./reference/log-logf-log10-log10f.md)|Computes the natural or base-10 logarithm -[`log1p`, `log1pf`, `log1pl`](./reference/log1p-log1pf-log1pl2.md)|Computes the natural logarithm of 1+x -[`log2`, `log2f`, `log2l`](./reference/log2-log2f-log2l.md)|Computes the base-2 logarithm -[`logb`, `logbf`, `logbl`, `_logb`, `_logbf`](./reference/logb-logbf-logbl-logb-logbf.md)|Returns the exponent of a floating-point value -[`lrint`, `lrintf`, `lrintl`](./reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md)|Rounds a floating-point value to the nearest **`long`** value -[`_lrotl`, `_lrotr`](./reference/lrotl-lrotr.md)|Rotates an integer value left or right -[`lround`, `lroundf`, `lroundl`](./reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md)|Rounds a floating-point value to the nearest **`long`** value -[`_matherr`](./reference/matherr.md)|The default math error handler -[`__max`](./reference/max.md)|Macro that returns the larger of two values -[`__min`](./reference/min.md)|Macro that returns the smaller of two values -[`modf`, `modff`, `modfl`](./reference/modf-modff-modfl.md)|Splits a floating-point value into fractional and integer parts -[`nan`, `nanf`, `nanl`](./reference/nan-nanf-nanl.md)|Returns a quiet NaN value -[`nearbyint`, `nearbyintf`, `nearbyintl`](./reference/nearbyint-nearbyintf-nearbyintl1.md)|Returns the rounded value -[`nextafter`, `nextafterf`, `nextafterl`, `_nextafter`, `_nextafterf`](./reference/nextafter-functions.md)|Returns the next representable floating-point value -[`nexttoward`, `nexttowardf`, `nexttowardl`](./reference/nextafter-functions.md)|Returns the next representable floating-point value -[`pow`, `powf`, `powl`](./reference/pow-powf-powl.md)|Returns the value of *`x`**`y`* -[`remainder`, `remainderf`, `remainderl`](./reference/remainder-remainderf-remainderl.md)|Computes the remainder of the quotient of two floating-point values -[`remquo`, `remquof`, `remquol`](./reference/remquo-remquof-remquol.md)|Computes the remainder of two integer values -[`rint`, `rintf`, `rintl`](./reference/rint-rintf-rintl.md)|Rounds a floating-point value -[`_rotl`, `_rotl64`, `_rotr`, `_rotr64`](./reference/rotl-rotl64-rotr-rotr64.md)|Rotates bits in integer types -[`round`, `roundf`, `roundl`](./reference/round-roundf-roundl.md)|Rounds a floating-point value -[`_scalb`, `_scalbf`](./reference/scalb.md)|Scales argument by a power of 2 -[`scalbn`, `scalbnf`, `scalbnl`, `scalbln`, `scalblnf`, `scalblnl`](./reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md)|Multiplies a floating-point number by an integral power of `FLT_RADIX` -[`_set_controlfp`](./reference/set-controlfp.md)|Sets the floating-point control word -[`_set_SSE2_enable`](./reference/set-sse2-enable.md)|Enables or disables SSE2 instructions -[`signbit`](./reference/signbit.md)|Tests the sign bit of a floating-point value -[`sin`, `sinf`, `sinl`](./reference/sin-sinf-sinl.md)|Computes the sine -[`sinh`, `sinhf`, `sinhl`](./reference/sinh-sinhf-sinhl.md)|Computes the hyperbolic sine -[`sqrt`, `sqrtf`, `sqrtl`](./reference/sqrt-sqrtf-sqrtl.md)|Computes the square root -[`_status87`, `_statusfp`, `_statusfp2`](./reference/status87-statusfp-statusfp2.md)|Gets the floating-point status word -[`strtof`, `_strtof_l`](./reference/strtof-strtof-l-wcstof-wcstof-l.md)|Converts a string to a **`float`** -[`strtold`, `_strtold_l`](./reference/strtold-strtold-l-wcstold-wcstold-l.md)|Converts a string to a **`long double`** -[`tan`, `tanf`, `tanl`](./reference/tan-tanf-tanl.md)|Computes the tangent -[`tanh`, `tanhf`, `tanhl`](./reference/tanh-tanhf-tanhl.md)|Computes the hyperbolic tangent -[`tgamma`, `tgammaf`, `tgammal`](./reference/tgamma-tgammaf-tgammal.md)|Computes the gamma function -[`trunc`, `truncf`, `truncl`](./reference/trunc-truncf-truncl.md)|Truncates the fractional part -[`_wtof`, `_wtof_l`](./reference/atof-atof-l-wtof-wtof-l.md)|Converts a wide string to a **`double`** -[`_y0`, `_y1`, `_yn`](./reference/bessel-functions-j0-j1-jn-y0-y1-yn.md)|Computes the Bessel function +| Routine | Use | +|---|---| +| [`abs`, `labs`, `llabs`, `_abs64`](./reference/abs-labs-llabs-abs64.md) | Computes the absolute value of an integer type | +| [`acos`, `acosf`, `acosl`](./reference/acos-acosf-acosl.md) | Computes the arc cosine | +| [`acosh`, `acoshf`, `acoshl`](./reference/acosh-acoshf-acoshl.md) | Computes the hyperbolic arc cosine | +| [`asin`, `asinf`, `asinl`](./reference/asin-asinf-asinl.md) | Computes the arc sine | +| [`asinh`, `asinhf`, `asinhl`](./reference/asinh-asinhf-asinhl.md) | Computes the hyperbolic arc sine | +| [`atan`, `atanf`, `atanl`, `atan2`, `atan2f`, `atan2l`](./reference/atan-atanf-atanl-atan2-atan2f-atan2l.md) | Computes the arc tangent | +| [`atanh`, `atanhf`, `atanhl`](./reference/atanh-atanhf-atanhl.md) | Computes the hyperbolic arc tangent | +| [`_atodbl`, `_atodbl_l`](./reference/atodbl-atodbl-l-atoldbl-atoldbl-l-atoflt-atoflt-l.md) | Converts a locale-specific string to a **`double`** | +| [`atof`, `_atof_l`](./reference/atof-atof-l-wtof-wtof-l.md) | Converts a string to a **`double`** | +| [`_atoflt`, `_atoflt_l`, `_atoldbl`, `_atoldbl_l`](./reference/atodbl-atodbl-l-atoldbl-atoldbl-l-atoflt-atoflt-l.md) | Converts a locale-specific string to a **`float`** or **`long double`** | +| [`cbrt`, `cbrtf`, `cbrtl`](./reference/cbrt-cbrtf-cbrtl.md) | Computes the cube root | +| [`ceil`, `ceilf`, `ceill`](./reference/ceil-ceilf-ceill.md) | Computes the ceiling | +| [`_chgsign`, `_chgsignf`, `_chgsignl`](./reference/chgsign-chgsignf-chgsignl.md) | Computes the additive inverse | +| [`_clear87`, `_clearfp`](./reference/clear87-clearfp.md) | Gets and clears the floating-point status register | +| [`_control87`, `_controlfp`, `__control87_2`](./reference/control87-controlfp-control87-2.md) | Gets and sets the floating-point control word | +| [`_controlfp_s`](./reference/controlfp-s.md) | Secure version of **`_controlfp`** | +| [`copysign`, `copysignf`, `copysignl`, `_copysign`, `_copysignf`, `_copysignl`](./reference/copysign-copysignf-copysignl-copysign-copysignf-copysignl.md) | Returns a value that has the magnitude of one argument and the sign of another | +| [`cos`, `cosf`, `cosl`](./reference/cos-cosf-cosl.md) | Computes the sine | +| [`cosh`, `coshf`, `coshl`](./reference/cosh-coshf-coshl.md) | Computes the hyperbolic sine | +| [`div`, `ldiv`, `lldiv`](./reference/div.md) | Computes the quotient and the remainder of two integer values | +| [`_ecvt`](./reference/ecvt.md), [`ecvt`](./reference/posix-ecvt.md) | Converts a **`double`** to a string | +| [`_ecvt_s`](./reference/ecvt-s.md) | Secure version of **`_ecvt`** | +| [`erf`, `erff`, `erfl`](./reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | Computes the error function | +| [`erfc`, `erfcf`, `erfcl`](./reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | Computes the complementary error function | +| [`exp`, `expf`, `expl`](./reference/exp-expf.md) | Computes the exponential *e*x | +| [`exp2`, `exp2f`, `exp2l`](./reference/exp2-exp2f-exp2l.md) | Computes the exponential 2x | +| [`expm1`, `expm1f`, `expm1l`](./reference/expm1-expm1f-expm1l.md) | Computes *e*x-1 | +| [`fabs`, `fabsf`, `fabsl`](./reference/fabs-fabsf-fabsl.md) | Computes the absolute value of a floating-point type | +| [`_fcvt`](./reference/fcvt.md), [`fcvt`](./reference/posix-fcvt.md) | Converts a floating-point number to a string | +| [`_fcvt_s`](./reference/fcvt-s.md) | Secure version of **`_fcvt`** | +| [`fdim`, `fdimf`, `fdiml`](./reference/fdim-fdimf-fdiml.md) | Determines the positive difference between two values | +| [`feclearexcept`](./reference/feclearexcept1.md) | Clears specified floating-point exceptions | +| [`fegetenv`](./reference/fegetenv1.md) | Stores the current floating-point environment | +| [`fegetexceptflag`](./reference/fegetexceptflag2.md) | Gets the specified floating-point exception status | +| [`fegetround`](./reference/fegetround-fesetround2.md) | Gets the floating-point rounding mode | +| [`feholdexcept`](./reference/feholdexcept2.md) | Sets non-stop floating-point exception mode | +| [`feraiseexcept`](./reference/feraiseexcept.md) | Raises the specified floating-point exceptions | +| [`fesetenv`](./reference/fesetenv1.md) | Sets the current floating-point environment | +| [`fesetexceptflag`](./reference/fesetexceptflag2.md) | Sets the specified floating-point status flags | +| [`fesetround`](./reference/fegetround-fesetround2.md) | Sets the specified floating-point rounding mode | +| [`fetestexcept`](./reference/fetestexcept1.md) | Determines which floating-point exception status flags are set | +| [`feupdateenv`](./reference/feupdateenv.md) | Restores a floating-point environment then raises previous exceptions | +| [`floor`, `floorf`, `floorl`](./reference/floor-floorf-floorl.md) | Computes the floor | +| [`fma`, `fmaf`, `fmal`](./reference/fma-fmaf-fmal.md) | Computes a fused multiply-add | +| [`fmax`, `fmaxf`, `fmaxl`](./reference/fmax-fmaxf-fmaxl.md) | Computes the maximum of the arguments | +| [`fmin`, `fminf`, `fminl`](./reference/fmin-fminf-fminl.md) | Computes the minimum of the arguments | +| [`fmod`, `fmodf`, `fmodl`](./reference/fmod-fmodf.md) | Computes the floating-point remainder | +| [`_fpclass`, `_fpclassf`](./reference/fpclass-fpclassf.md) | Returns the classification of a floating-point value | +| [`fpclassify`](./reference/fpclassify.md) | Returns the classification of a floating-point value | +| [`_fpieee_flt`](./reference/fpieee-flt.md) | Sets a handler for floating-point exceptions | +| [`_fpreset`](./reference/fpreset.md) | Resets the floating-point environment | +| [`frexp`, `frexpf`, `frexpl`](./reference/frexp.md) | Gets the mantissa and exponent of a floating-point number | +| [`_gcvt`](./reference/gcvt.md), [`gcvt`](./reference/posix-gcvt.md) | Converts a floating-point number to a string | +| [`_gcvt_s`](./reference/gcvt-s.md) | Secure version of **`_gcvt`** | +| [`_get_FMA3_enable`, `_set_FMA3_enable`](./reference/get-fma3-enable-set-fma3-enable.md) | Gets or sets a flag for use of FMA3 instructions on x64 | +| [`hypot`, `hypotf`, `hypotl`, `_hypot`, `_hypotf`, `_hypotl`](./reference/hypot-hypotf-hypotl-hypot-hypotf-hypotl.md) | Computes the hypotenuse | +| [`ilogb`, `ilogbf`, `ilogbl`](./reference/ilogb-ilogbf-ilogbl2.md) | Computes the integer base-2 exponent | +| [`imaxabs`](./reference/imaxabs.md) | Computes the absolute value of an integer type | +| [`imaxdiv`](./reference/imaxdiv.md) | Computes the quotient and the remainder of two integer values | +| [`isfinite`, `_finite`, `_finitef`](./reference/finite-finitef.md) | Determines whether a value is finite | +| [`isgreater`, `isgreaterequal`, `isless`, `islessequal`, `islessgreater`, `isunordered`](./reference/floating-point-ordering.md) | Compare the order of two floating point values | +| [`isinf`](./reference/isinf.md) | Determines whether a floating-point value is infinite | +| [`isnan`, `_isnan`, `_isnanf`](./reference/isnan-isnan-isnanf.md) | Tests a floating-point value for NaN | +| [`isnormal`](./reference/isnormal.md) | Tests whether a floating-point value is both finite and not subnormal | +| [`_j0`, `_j1`, `_jn`](./reference/bessel-functions-j0-j1-jn-y0-y1-yn.md) | Computes the Bessel function | +| [`ldexp`, `ldexpf`, `ldexpl`](./reference/ldexp.md) | Computes x*2n | +| [`lgamma`, `lgammaf`, `lgammal`](./reference/lgamma-lgammaf-lgammal.md) | Computes the natural logarithm of the absolute value of the gamma function | +| [`llrint`, `llrintf`, `llrintl`](./reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | Rounds a floating-point value to the nearest **`long long`** value | +| [`llround`, `llroundf`, `llroundl`](./reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | Rounds a floating-point value to the nearest **`long long`** value | +| [`log`, `logf`, `logl`, `log10`, `log10f`, `log10l`](./reference/log-logf-log10-log10f.md) | Computes the natural or base-10 logarithm | +| [`log1p`, `log1pf`, `log1pl`](./reference/log1p-log1pf-log1pl2.md) | Computes the natural logarithm of 1+x | +| [`log2`, `log2f`, `log2l`](./reference/log2-log2f-log2l.md) | Computes the base-2 logarithm | +| [`logb`, `logbf`, `logbl`, `_logb`, `_logbf`](./reference/logb-logbf-logbl-logb-logbf.md) | Returns the exponent of a floating-point value | +| [`lrint`, `lrintf`, `lrintl`](./reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | Rounds a floating-point value to the nearest **`long`** value | +| [`_lrotl`, `_lrotr`](./reference/lrotl-lrotr.md) | Rotates an integer value left or right | +| [`lround`, `lroundf`, `lroundl`](./reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | Rounds a floating-point value to the nearest **`long`** value | +| [`_matherr`](./reference/matherr.md) | The default math error handler | +| [`__max`](./reference/max.md) | Macro that returns the larger of two values | +| [`__min`](./reference/min.md) | Macro that returns the smaller of two values | +| [`modf`, `modff`, `modfl`](./reference/modf-modff-modfl.md) | Splits a floating-point value into fractional and integer parts | +| [`nan`, `nanf`, `nanl`](./reference/nan-nanf-nanl.md) | Returns a quiet NaN value | +| [`nearbyint`, `nearbyintf`, `nearbyintl`](./reference/nearbyint-nearbyintf-nearbyintl1.md) | Returns the rounded value | +| [`nextafter`, `nextafterf`, `nextafterl`, `_nextafter`, `_nextafterf`](./reference/nextafter-functions.md) | Returns the next representable floating-point value | +| [`nexttoward`, `nexttowardf`, `nexttowardl`](./reference/nextafter-functions.md) | Returns the next representable floating-point value | +| [`pow`, `powf`, `powl`](./reference/pow-powf-powl.md) | Returns the value of *`x`**`y`* | +| [`remainder`, `remainderf`, `remainderl`](./reference/remainder-remainderf-remainderl.md) | Computes the remainder of the quotient of two floating-point values | +| [`remquo`, `remquof`, `remquol`](./reference/remquo-remquof-remquol.md) | Computes the remainder of two integer values | +| [`rint`, `rintf`, `rintl`](./reference/rint-rintf-rintl.md) | Rounds a floating-point value | +| [`_rotl`, `_rotl64`, `_rotr`, `_rotr64`](./reference/rotl-rotl64-rotr-rotr64.md) | Rotates bits in integer types | +| [`round`, `roundf`, `roundl`](./reference/round-roundf-roundl.md) | Rounds a floating-point value | +| [`_scalb`, `_scalbf`](./reference/scalb.md) | Scales argument by a power of 2 | +| [`scalbn`, `scalbnf`, `scalbnl`, `scalbln`, `scalblnf`, `scalblnl`](./reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md) | Multiplies a floating-point number by an integral power of `FLT_RADIX` | +| [`_set_controlfp`](./reference/set-controlfp.md) | Sets the floating-point control word | +| [`_set_SSE2_enable`](./reference/set-sse2-enable.md) | Enables or disables SSE2 instructions | +| [`signbit`](./reference/signbit.md) | Tests the sign bit of a floating-point value | +| [`sin`, `sinf`, `sinl`](./reference/sin-sinf-sinl.md) | Computes the sine | +| [`sinh`, `sinhf`, `sinhl`](./reference/sinh-sinhf-sinhl.md) | Computes the hyperbolic sine | +| [`sqrt`, `sqrtf`, `sqrtl`](./reference/sqrt-sqrtf-sqrtl.md) | Computes the square root | +| [`_status87`, `_statusfp`, `_statusfp2`](./reference/status87-statusfp-statusfp2.md) | Gets the floating-point status word | +| [`strtof`, `_strtof_l`](./reference/strtof-strtof-l-wcstof-wcstof-l.md) | Converts a string to a **`float`** | +| [`strtold`, `_strtold_l`](./reference/strtold-strtold-l-wcstold-wcstold-l.md) | Converts a string to a **`long double`** | +| [`tan`, `tanf`, `tanl`](./reference/tan-tanf-tanl.md) | Computes the tangent | +| [`tanh`, `tanhf`, `tanhl`](./reference/tanh-tanhf-tanhl.md) | Computes the hyperbolic tangent | +| [`tgamma`, `tgammaf`, `tgammal`](./reference/tgamma-tgammaf-tgammal.md) | Computes the gamma function | +| [`trunc`, `truncf`, `truncl`](./reference/trunc-truncf-truncl.md) | Truncates the fractional part | +| [`_wtof`, `_wtof_l`](./reference/atof-atof-l-wtof-wtof-l.md) | Converts a wide string to a **`double`** | +| [`_y0`, `_y1`, `_yn`](./reference/bessel-functions-j0-j1-jn-y0-y1-yn.md) | Computes the Bessel function | ## See also diff --git a/docs/c-runtime-library/fmode.md b/docs/c-runtime-library/fmode.md index 6640c4b9bfb..9bc5cb02e4a 100644 --- a/docs/c-runtime-library/fmode.md +++ b/docs/c-runtime-library/fmode.md @@ -2,8 +2,8 @@ description: "Learn more about: _fmode" title: "_fmode" ms.date: "11/04/2016" -f1_keywords: ["fmode", "_fmode"] -helpviewer_keywords: ["file translation [C++], default mode", "fmode function", "_fmode function"] +f1_keywords: ["_fmode", "STDLIB/_fmode"] +helpviewer_keywords: ["file translation [C++], default mode", "_fmode global variable"] ms.assetid: ac6df9eb-e5cc-4c54-aff3-373c21983118 --- # `_fmode` @@ -12,7 +12,7 @@ The `_fmode` variable sets the default file-translation mode for text or binary ## Syntax -``` +```C extern int _fmode; ``` diff --git a/docs/c-runtime-library/fopen-max-sys-open.md b/docs/c-runtime-library/fopen-max-sys-open.md index ae9f9edccdf..5fb01fb982d 100644 --- a/docs/c-runtime-library/fopen-max-sys-open.md +++ b/docs/c-runtime-library/fopen-max-sys-open.md @@ -10,7 +10,7 @@ ms.assetid: 39cf5196-250a-459d-ae90-ce3d99f79039 ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/format-specification-syntax-printf-and-wprintf-functions.md b/docs/c-runtime-library/format-specification-syntax-printf-and-wprintf-functions.md index 1cd06ec0b00..13df59084e6 100644 --- a/docs/c-runtime-library/format-specification-syntax-printf-and-wprintf-functions.md +++ b/docs/c-runtime-library/format-specification-syntax-printf-and-wprintf-functions.md @@ -43,49 +43,49 @@ Integer types such as `short`, `int`, `long`, `long long`, and their `unsigned` ### Type field characters -|Type character|Argument|Output format| -|--------------------|--------------|-------------------| -|**`c`**|Character|When used with `printf` functions, specifies a single-byte character; when used with `wprintf` functions, specifies a wide character.| -|**`C`**|Character|When used with `printf` functions, specifies a wide character; when used with `wprintf` functions, specifies a single-byte character.| -|**`d`**|Integer|Signed decimal integer.| -|**`i`**|Integer|Signed decimal integer.| -|**`o`**|Integer|Unsigned octal integer.| -|**`u`**|Integer|Unsigned decimal integer.| -|**`x`**|Integer|Unsigned hexadecimal integer; uses "`abcdef`".| -|**`X`**|Integer|Unsigned hexadecimal integer; uses "`ABCDEF`".| -|**`e`**|Floating-point|Signed value that has the form [`-`]*d.dddd*`e`\[`+`\|`-`]*dd*\[*d*], where *d* is one decimal digit, *dddd* is one or more decimal digits depending on the specified precision, or six by default, and *dd*\[*d*] is two or three decimal digits depending on the [output format](./set-output-format.md) and size of the exponent.| -|**`E`**|Floating-point|Identical to the **`e`** format except that **`E`** rather than **`e`** introduces the exponent.| -|**`f`**|Floating-point|Signed value that has the form [`-`]*dddd*`.`*dddd*, where *dddd* is one or more decimal digits. The number of digits before the decimal point depends on the magnitude of the number, and the number of digits after the decimal point depends on the requested precision, or six by default.| -|**`F`**|Floating-point|Identical to the **`f`** format except that infinity and NaN output is capitalized.| -|**`g`**|Floating-point|Signed values are displayed in **`f`** or **`e`** format, whichever is more compact for the given value and precision. The **`e`** format is used only when the exponent of the value is less than -4 or greater than or equal to the *precision* argument. Trailing zeros are truncated, and the decimal point appears only if one or more digits follow it.| -|**`G`**|Floating-point|Identical to the **`g`** format, except that **`E`**, rather than **`e`**, introduces the exponent (where appropriate).| -|**`a`**|Floating-point|Signed hexadecimal double-precision floating-point value that has the form [`-`]`0x`*h.hhhh*`p`\[`+`\|`-`]*dd*, where *h.hhhh* are the hex digits (using lower case letters) of the mantissa, and *dd* are one or more digits for the exponent. The precision specifies the number of digits after the point.| -|**`A`**|Floating-point|Signed hexadecimal double-precision floating-point value that has the form \[`-`]`0X`*h.hhhh*`P`\[`+`\|`-`]*dd*, where *h.hhhh* are the hex digits (using capital letters) of the mantissa, and *dd* are one or more digits for the exponent. The precision specifies the number of digits after the point.| -|**`n`**|Pointer to integer|Number of characters that are successfully written so far to the stream or buffer. This value is stored in the integer whose address is given as the argument. The size of the integer pointed at can be controlled by an argument size specification prefix. The **`n`** specifier is disabled by default; for information see the important security note.| -|**`p`**|Pointer type|Display the argument as an address in hexadecimal digits.| -|**`s`**|String|When used with `printf` functions, specifies a single-byte or multi-byte character string; when used with `wprintf` functions, specifies a wide-character string. Characters are displayed up to the first null character or until the *precision* value is reached.| -|**`S`**|String|When used with `printf` functions, specifies a wide-character string; when used with `wprintf` functions, specifies a single-byte or multi-byte character string. Characters are displayed up to the first null character or until the *precision* value is reached.| -|**`Z`**|`ANSI_STRING` or `UNICODE_STRING` structure|When the address of an [`ANSI_STRING`](/windows/win32/api/ntdef/ns-ntdef-string) or [`UNICODE_STRING`](/windows/win32/api/ntdef/ns-ntdef-_unicode_string) structure is passed as the argument, display the string contained in the buffer pointed to by the `Buffer` field of the structure. Use a *size* modifier prefix of **`w`** to specify a `UNICODE_STRING` argument—for example, `%wZ`. The `Length` field of the structure must be set to the length, in bytes, of the string. The `MaximumLength` field of the structure must be set to the length, in bytes, of the buffer.

Typically, the **`Z`** type character is used only in driver debugging functions that use a conversion specification, such as `dbgPrint` and `kdPrint`.| +| Type character | Argument | Output format | +|---|---|---| +| **`c`** | Character | When used with `printf` functions, specifies a single-byte character; when used with `wprintf` functions, specifies a wide character. | +| **`C`** | Character | When used with `printf` functions, specifies a wide character; when used with `wprintf` functions, specifies a single-byte character. | +| **`d`** | Integer | Signed decimal integer. | +| **`i`** | Integer | Signed decimal integer. | +| **`o`** | Integer | Unsigned octal integer. | +| **`u`** | Integer | Unsigned decimal integer. | +| **`x`** | Integer | Unsigned hexadecimal integer; uses "`abcdef`". | +| **`X`** | Integer | Unsigned hexadecimal integer; uses "`ABCDEF`". | +| **`e`** | Floating-point | Signed value that has the form [`-`]*d.dddd*`e`\[`+`\|`-`]*dd*\[*d*], where *d* is one decimal digit, *dddd* is one or more decimal digits depending on the specified precision, or six by default, and *dd*\[*d*] is two or three decimal digits depending on the [output format](./set-output-format.md) and size of the exponent. | +| **`E`** | Floating-point | Identical to the **`e`** format except that **`E`** rather than **`e`** introduces the exponent. | +| **`f`** | Floating-point | Signed value that has the form [`-`]*dddd*`.`*dddd*, where *dddd* is one or more decimal digits. The number of digits before the decimal point depends on the magnitude of the number, and the number of digits after the decimal point depends on the requested precision, or six by default. | +| **`F`** | Floating-point | Identical to the **`f`** format except that infinity and NaN output is capitalized. | +| **`g`** | Floating-point | Signed values are displayed in **`f`** or **`e`** format, whichever is more compact for the given value and precision. The **`e`** format is used only when the exponent of the value is less than -4 or greater than or equal to the *precision* argument. Trailing zeros are truncated, and the decimal point appears only if one or more digits follow it. | +| **`G`** | Floating-point | Identical to the **`g`** format, except that **`E`**, rather than **`e`**, introduces the exponent (where appropriate). | +| **`a`** | Floating-point | Signed hexadecimal double-precision floating-point value that has the form [`-`]`0x`*h.hhhh*`p`\[`+`\|`-`]*dd*, where *h.hhhh* are the hex digits (using lower case letters) of the mantissa, and *dd* are one or more digits for the exponent. The precision specifies the number of digits after the point. | +| **`A`** | Floating-point | Signed hexadecimal double-precision floating-point value that has the form \[`-`]`0X`*h.hhhh*`P`\[`+`\|`-`]*dd*, where *h.hhhh* are the hex digits (using capital letters) of the mantissa, and *dd* are one or more digits for the exponent. The precision specifies the number of digits after the point. | +| **`n`** | Pointer to integer | Number of characters that are successfully written so far to the stream or buffer. This value is stored in the integer whose address is given as the argument. The size of the integer pointed at can be controlled by an argument size specification prefix. The **`n`** specifier is disabled by default; for information see the important security note. | +| **`p`** | Pointer type | Display the argument as an address in hexadecimal digits. | +| **`s`** | String | When used with `printf` functions, specifies a single-byte or multi-byte character string; when used with `wprintf` functions, specifies a wide-character string. Characters are displayed up to the first null character or until the *precision* value is reached. | +| **`S`** | String | When used with `printf` functions, specifies a wide-character string; when used with `wprintf` functions, specifies a single-byte or multi-byte character string. Characters are displayed up to the first null character or until the *precision* value is reached. | +| **`Z`** | `ANSI_STRING` or `UNICODE_STRING` structure | When the address of an [`ANSI_STRING`](/windows/win32/api/ntdef/ns-ntdef-string) or [`UNICODE_STRING`](/windows/win32/api/ntdef/ns-ntdef-_unicode_string) structure is passed as the argument, display the string contained in the buffer pointed to by the `Buffer` field of the structure. Use a *size* modifier prefix of **`w`** to specify a `UNICODE_STRING` argument—for example, `%wZ`. The `Length` field of the structure must be set to the length, in bytes, of the string. The `MaximumLength` field of the structure must be set to the length, in bytes, of the buffer.

Typically, the **`Z`** type character is used only in driver debugging functions that use a conversion specification, such as `dbgPrint` and `kdPrint`. | In Visual Studio 2015 and later versions, if the argument that corresponds to a floating-point conversion specifier (**`a`**, **`A`**, **`e`**, **`E`**, **`f`**, **`F`**, **`g`**, **`G`**) is infinite, indefinite, or NaN, the formatted output conforms to the C99 standard. This table lists the formatted output: -|Value|Output| -|-----------|------------| -|infinity|`inf`| -|Quiet NaN|`nan`| -|Signaling NaN|`nan(snan)`| -|Indefinite NaN|`nan(ind)`| +| Value | Output | +|---|---| +| Infinity | `inf` | +| Quiet NaN | `nan` | +| Signaling NaN | `nan(snan)` | +| Indefinite NaN | `nan(ind)` | Any of these strings may be prefixed by a sign. If a floating-point *type* conversion specifier character is a capital letter, then the output is also formatted in capital letters. For example, if the format specifier is `%F` instead of `%f`, an infinity is formatted as `INF` instead of `inf`. The `scanf` functions can also parse these strings, so these values can make a round trip through `printf` and `scanf` functions. Before Visual Studio 2015, the CRT used a different, non-standard format for output of infinite, indefinite, and NaN values: -|Value|Output| -|-----------|------------| -|+ infinity|`1.#INF` *random-digits*| -|- infinity|`-1.#INF` *random-digits*| -|Indefinite (same as quiet NaN)|*digit* `.#IND` *random-digits*| -|NaN|*digit* `.#NAN` *random-digits*| +| Value | Output | +|---|---| +| + Infinity | `1.#INF` *random-digits* | +| - Infinity | `-1.#INF` *random-digits* | +| Indefinite (same as quiet NaN) | *digit* `.#IND` *random-digits* | +| NaN | *digit* `.#NAN` *random-digits* | Any of these strings may have been prefixed by a sign, and may have been formatted differently depending on field width and precision, sometimes with unusual effects. For example, `printf("%.2f\n", INFINITY)` prints `1.#J` because the *#INF* would be "rounded" to two digits of precision. @@ -104,15 +104,15 @@ The first optional field in a conversion specification contains *flag directives ### Flag characters -|Flag|Meaning|Default| -|----------|-------------|-------------| -|**`-`**|Left align the result within the given field width.|Right align.| -|**`+`**|Use a sign (+ or -) to prefix the output value if it's of a signed type.|Sign appears only for negative signed values (-).| -|**`0`**|If *width* is prefixed by **`0`**, leading zeros are added until the minimum width is reached. If both **`0`** and **`-`** appear, the **`0`** is ignored. If **`0`** is specified for an integer format (**`i`**, **`u`**, **`x`**, **`X`**, **`o`**, **`d`**) and a precision specification is also present—for example, `%04.d`—the **`0`** is ignored. If **`0`** is specified for the **`a`** or **`A`** floating-point format, leading zeros are prepended to the mantissa, after the `0x` or `0X` prefix.|No padding.| -|**blank (' ')**|Use a blank to prefix the output value if it's signed and positive. The blank is ignored if both the blank and + flags appear.|No blank appears.| -|**`#`**|When it's used with the **`o`**, **`x`**, or **`X`** format, the **`#`** flag uses `0`, `0x`, or `0X`, respectively, to prefix any nonzero output value.|No prefix appears.| -||When it's used with the **`e`**, **`E`**, **`f`**, **`F`**, **`a`**, or **`A`** format, the **`#`** flag forces the output value to contain a decimal point.|Decimal point appears only if digits follow it.| -||When it's used with the **`g`** or **`G`** format, the **`#`** flag forces the output value to contain a decimal point and prevents the truncation of trailing zeros.

Ignored when used with **`c`**, **`d`**, **`i`**, **`u`**, or **`s`**.|Decimal point appears only if digits follow it. Trailing zeros are truncated.| +| Flag | Meaning | Default | +|---|---|---| +| **`-`** | Left align the result within the given field width. | Right align. | +| **`+`** | Use a sign (+ or -) to prefix the output value if it's of a signed type. | Sign appears only for negative signed values (-). | +| **`0`** | If *width* is prefixed by **`0`**, leading zeros are added until the minimum width is reached. If both **`0`** and **`-`** appear, the **`0`** is ignored. If **`0`** is specified for an integer format (**`i`**, **`u`**, **`x`**, **`X`**, **`o`**, **`d`**) and a precision specification is also present—for example, `%04.d`—the **`0`** is ignored. If **`0`** is specified for the **`a`** or **`A`** floating-point format, leading zeros are prepended to the mantissa, after the `0x` or `0X` prefix. | No padding. | +| **blank (' ')** | Use a blank to prefix the output value if it's signed and positive. The blank is ignored if both the blank and + flags appear. | No blank appears. | +| **`#`** | When it's used with the **`o`**, **`x`**, or **`X`** format, the **`#`** flag uses `0`, `0x`, or `0X`, respectively, to prefix any nonzero output value. | No prefix appears. | +| | When it's used with the **`e`**, **`E`**, **`f`**, **`F`**, **`a`**, or **`A`** format, the **`#`** flag forces the output value to contain a decimal point. | Decimal point appears only if digits follow it. | +| | When it's used with the **`g`** or **`G`** format, the **`#`** flag forces the output value to contain a decimal point and prevents the truncation of trailing zeros.

Ignored when used with **`c`**, **`d`**, **`i`**, **`u`**, or **`s`**. | Decimal point appears only if digits follow it. Trailing zeros are truncated. | ## Width specification @@ -142,15 +142,15 @@ The *`type`* character determines either the interpretation of *`precision`* or ### How precision values affect type -|Type|Meaning|Default| -|----------|-------------|-------------| -|**`a`**, **`A`**|The precision specifies the number of digits after the point.|Default precision is 13. If precision is 0, no decimal point is printed unless the **`#`** flag is used.| -|**`c`**, **`C`**|The precision has no effect.|Character is printed.| -|**`d`**, **`i`**, **`o`**, **`u`**, **`x`**, **`X`**|The precision specifies the minimum number of digits to be printed. If the number of digits in the argument is less than *precision*, the output value is padded on the left with zeros. The value isn't truncated when the number of digits exceeds *precision*.|Default precision is 1.| -|**`e`**, **`E`**|The precision specifies the number of digits to be printed after the decimal point. The last printed digit is rounded.|Default precision is 6. If *precision* is 0 or the period (`.`) appears without a number following it, no decimal point is printed.| -|**`f`**, **`F`**|The precision value specifies the number of digits after the decimal point. If a decimal point appears, at least one digit appears before it. The value is rounded to the appropriate number of digits.|Default precision is 6. If *precision* is 0, or if the period (`.`) appears without a number following it, no decimal point is printed.| -|**`g`**, **`G`**|The precision specifies the maximum number of significant digits printed.|Six significant digits are printed, and any trailing zeros are truncated.| -|**`s`**, **`S`**|The precision specifies the maximum number of characters to be printed. Characters in excess of *precision* aren't printed.|Characters are printed until a null character is found.| +| Type | Meaning | Default | +|---|---|---| +| **`a`**, **`A`** | The precision specifies the number of digits after the point. | Default precision is 13. If precision is 0, no decimal point is printed unless the **`#`** flag is used. | +| **`c`**, **`C`** | The precision has no effect. | Character is printed. | +| **`d`**, **`i`**, **`o`**, **`u`**, **`x`**, **`X`** | The precision specifies the minimum number of digits to be printed. If the number of digits in the argument is less than *precision*, the output value is padded on the left with zeros. The value isn't truncated when the number of digits exceeds *precision*. | Default precision is 1. | +| **`e`**, **`E`** | The precision specifies the number of digits to be printed after the decimal point. The last printed digit is rounded. | Default precision is 6. If *precision* is 0 or the period (`.`) appears without a number following it, no decimal point is printed. | +| **`f`**, **`F`** | The precision value specifies the number of digits after the decimal point. If a decimal point appears, at least one digit appears before it. The value is rounded to the appropriate number of digits. | Default precision is 6. If *precision* is 0, or if the period (`.`) appears without a number following it, no decimal point is printed. | +| **`g`**, **`G`** | The precision specifies the maximum number of significant digits printed. | Six significant digits are printed, and any trailing zeros are truncated. | +| **`s`**, **`S`** | The precision specifies the maximum number of characters to be printed. Characters in excess of *precision* aren't printed. | Characters are printed until a null character is found. | ## Argument size specification @@ -160,22 +160,22 @@ Some types are different sizes in 32-bit and 64-bit code. For example, `size_t` ### Size prefixes for printf and wprintf format-type specifiers -|To specify|Use prefix|With type specifier| -|----------------|----------------|-------------------------| -|`char`
`unsigned char`|**`hh`**|**`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`**| -|`short int`
`short unsigned int`|**`h`**|**`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`**| -|`__int32`
`unsigned __int32`|**`I32`**|**`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`**| -|`__int64`
`unsigned __int64`|**`I64`**|**`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`**| -|`intmax_t`
`uintmax_t`|**`j`** or **`I64`**|**`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`**| -|`long double`|**`l`** (lowercase L) or **`L`**|**`a`**, **`A`**, **`e`**, **`E`**, **`f`**, **`F`**, **`g`**, or **`G`**| -|`long int`
`long unsigned int`|**`l`** (lowercase L) |**`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`** | -|`long long int`
`unsigned long long int`|**`ll`** (lowercase LL)|**`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`**| -|`ptrdiff_t`|**`t`** or **`I`** (uppercase i)|**`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`**| -|`size_t`|**`z`** or **`I`** (uppercase i)|**`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`**| -|Single-byte character|**`h`**|**`c`** or **`C`**| -|Wide character|**`l`** (lowercase L) or **`w`**|**`c`** or **`C`**| -|Single-byte character string|**`h`**|**`s`**, **`S`**, or **`Z`**| -|Wide-character string|**`l`** (lowercase L) or **`w`**|**`s`**, **`S`**, or **`Z`**| +| To specify | Use prefix | With type specifier | +|---|---|---| +| `char`
`unsigned char` | **`hh`** | **`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`** | +| `short int`
`short unsigned int` | **`h`** | **`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`** | +| `__int32`
`unsigned __int32` | **`I32`** | **`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`** | +| `__int64`
`unsigned __int64` | **`I64`** | **`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`** | +| `intmax_t`
`uintmax_t` | **`j`** or **`I64`** | **`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`** | +| `long double` | **`l`** (lowercase L) or **`L`** | **`a`**, **`A`**, **`e`**, **`E`**, **`f`**, **`F`**, **`g`**, or **`G`** | +| `long int`
`long unsigned int` | **`l`** (lowercase L) | **`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`** | +| `long long int`
`unsigned long long int` | **`ll`** (lowercase LL) | **`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`** | +| `ptrdiff_t` | **`t`** or **`I`** (uppercase i) | **`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`** | +| `size_t` | **`z`** or **`I`** (uppercase i) | **`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`** | +| Single-byte character | **`h`** | **`c`** or **`C`** | +| Wide character | **`l`** (lowercase L) or **`w`** | **`c`** or **`C`** | +| Single-byte character string | **`h`** | **`s`**, **`S`**, or **`Z`** | +| Wide-character string | **`l`** (lowercase L) or **`w`** | **`s`**, **`S`**, or **`Z`** | The `ptrdiff_t` and `size_t` types are `__int32` or `unsigned __int32` on 32-bit platforms, and `__int64` or `unsigned __int64` on 64-bit platforms. The **`I`** (uppercase i), **`j`**, **`t`**, and **`z`** size prefixes take the correct argument width for the platform. diff --git a/docs/c-runtime-library/freeentry-usedentry.md b/docs/c-runtime-library/freeentry-usedentry.md index 7559a0c75f1..c516f182efe 100644 --- a/docs/c-runtime-library/freeentry-usedentry.md +++ b/docs/c-runtime-library/freeentry-usedentry.md @@ -10,7 +10,7 @@ ms.assetid: 26f658e6-6846-4a4e-9984-262cfe392770 ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/fseek-lseek-constants.md b/docs/c-runtime-library/fseek-lseek-constants.md index 75d2385a9c9..bcde2121b5a 100644 --- a/docs/c-runtime-library/fseek-lseek-constants.md +++ b/docs/c-runtime-library/fseek-lseek-constants.md @@ -10,7 +10,7 @@ ms.assetid: 9deeb13e-5aa3-4c33-80d8-721c80a4de9d ## Syntax -``` +```C #include ``` @@ -18,11 +18,11 @@ ms.assetid: 9deeb13e-5aa3-4c33-80d8-721c80a4de9d The *`origin`* argument specifies the initial position and can be one of the following manifest constants: -|Constant|Meaning| -|--------------|-------------| -|`SEEK_END`|End of file| -|`SEEK_CUR`|Current position of file pointer| -|`SEEK_SET`|Beginning of file| +| Constant | Meaning | +|---|---| +| `SEEK_END` | End of file | +| `SEEK_CUR` | Current position of file pointer | +| `SEEK_SET` | Beginning of file | ## See also diff --git a/docs/c-runtime-library/get-output-format.md b/docs/c-runtime-library/get-output-format.md index d5eaad01611..ae1ddd46672 100644 --- a/docs/c-runtime-library/get-output-format.md +++ b/docs/c-runtime-library/get-output-format.md @@ -19,7 +19,7 @@ Gets the current value of the output format flag. ## Syntax -``` +```C unsigned int _get_output_format(); ``` @@ -33,9 +33,9 @@ The output format flag controls features of formatted I/O. The flag has two poss ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`_get_output_format`|\| +| Routine | Required header | +|---|---| +| **`_get_output_format`** | \ | For more compatibility information, see [Compatibility](./compatibility.md) in the Introduction. diff --git a/docs/c-runtime-library/getmainargs-wgetmainargs.md b/docs/c-runtime-library/getmainargs-wgetmainargs.md index c271c58c4ef..a5a8f967352 100644 --- a/docs/c-runtime-library/getmainargs-wgetmainargs.md +++ b/docs/c-runtime-library/getmainargs-wgetmainargs.md @@ -55,11 +55,11 @@ Other information to be passed to the CRT DLL. ## Remarks -Use `__getmainargs` on non-wide character platforms, and `__wgetmainargs` on wide-character (Unicode) platforms. +Use **`__getmainargs`** on non-wide character platforms, and **`__wgetmainargs`** on wide-character (Unicode) platforms. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|__getmainargs|internal.h| -|__wgetmainargs|internal.h| +| Routine | Required header | +|---|---| +| **`__getmainargs`** | `internal.h` | +| **`__wgetmainargs`** | `internal.h` | diff --git a/docs/c-runtime-library/gets-getws.md b/docs/c-runtime-library/gets-getws.md index a561ff2a59e..c3291411fa5 100644 --- a/docs/c-runtime-library/gets-getws.md +++ b/docs/c-runtime-library/gets-getws.md @@ -11,7 +11,7 @@ helpviewer_keywords: ["getws function", "getts function", "_getws function", "li --- # `gets`, `_getws` -Gets a line from the `stdin` stream. More secure versions of these functions are available; see [`gets_s`, `_getws_s`](./reference/gets-s-getws-s.md). +Gets a line from the **`stdin`** stream. More secure versions of these functions are available; see [`gets_s`, `_getws_s`](./reference/gets-s-getws-s.md). > [!IMPORTANT] > 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`](./reference/gets-s-getws-s.md). @@ -21,7 +21,7 @@ Gets a line from the `stdin` stream. More secure versions of these functions are ## Syntax -``` +```C char *gets( char *buffer ); @@ -38,21 +38,21 @@ wchar_t *_getws( ); // C++ only ``` -#### Parameters +### Parameters *`buffer`*\ Storage location for input string. ## Return value -Returns its argument if successful. A `NULL` pointer indicates an error or end-of-file condition. Use [`ferror`](./reference/ferror.md) or [`feof`](./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](./parameter-validation.md). If execution is allowed to continue, these functions return `NULL` and set `errno` to `EINVAL`. +Returns its argument if successful. A `NULL` pointer indicates an error or end-of-file condition. Use [`ferror`](./reference/ferror.md) or [`feof`](./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](./parameter-validation.md). If execution is allowed to continue, these functions return `NULL` and set `errno` to `EINVAL`. ## Remarks -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. +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. > [!IMPORTANT] -> Because there is no way to limit the number of characters read by `gets`, untrusted input can easily cause buffer overruns. Use `fgets` instead. +> Because there is no way to limit the number of characters read by **`gets`**, untrusted input can easily cause buffer overruns. Use `fgets` instead. In C++, these functions have template overloads that invoke the newer, secure counterparts of these functions. For more information, see [Secure template overloads](./secure-template-overloads.md). @@ -60,16 +60,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_getts`|`gets`|`gets`|`_getws`| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_getts` | **`gets`** | **`gets`** | **`_getws`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`gets`|``| -|`_getws`|`` or ``| +| Routine | Required header | +|---|---| +| **`gets`** | `` | +| **`_getws`** | `` or `` | For more compatibility information, see [Compatibility](./compatibility.md). diff --git a/docs/c-runtime-library/global-variables.md b/docs/c-runtime-library/global-variables.md index 7eb11315dd8..495831f814e 100644 --- a/docs/c-runtime-library/global-variables.md +++ b/docs/c-runtime-library/global-variables.md @@ -10,16 +10,16 @@ ms.assetid: 01d1551c-2f0c-4f72-935c-6442caccf84f The Microsoft C run-time library provides the following global variables or macros. Several of these global variables or macros have been deprecated in favor of more-secure functional versions, which we recommend you use instead of the global variables. -|Variable|Description| -|--------------|-----------------| -|[`__argc`, `__argv`, `__wargv`](./argc-argv-wargv.md)|Contains the command-line arguments.| -|[`_daylight`, `_dstbias`, `_timezone`, and `_tzname`](./daylight-dstbias-timezone-and-tzname.md)|Deprecated. Instead, use `_get_daylight`, `_get_dstbias`, `_get_timezone`, and `_get_tzname`.

Adjusts for local time; used in some date and time functions.| -|[`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](./errno-doserrno-sys-errlist-and-sys-nerr.md)|Deprecated. Instead, use `_get_errno`, `_set_errno`, `_get_doserrno`, `_set_doserrno`, `perror` and `strerror`.

Stores error codes and related information.| -|[`_environ`, `_wenviron`](./environ-wenviron.md)|Deprecated. Instead, use `getenv_s`, `_wgetenv_s`, `_dupenv_s`, `_wdupenv_s`, `_putenv_s`, and `_wputenv_s`.

Pointers to arrays of pointers to the process environment strings; initialized at startup.| -|[`_fmode`](./fmode.md)|Deprecated. Instead, use `_get_fmode` or `_set_fmode`.

Sets default file-translation mode.| -|[`_iob`](./iob.md)|Array of I/O control structures for the console, files, and devices.| -|[`_pctype`, `_pwctype`, `_wctype`, `_mbctype`, `_mbcasemap`](./pctype-pwctype-wctype-mbctype-mbcasemap.md)|Contains information used by the character-classification functions.| -|[`_pgmptr`, `_wpgmptr`](./pgmptr-wpgmptr.md)|Deprecated. Instead, use `_get_pgmptr` or `_get_wpgmptr`.

Based on how the program is invoked, the runtime initializes these values at program startup: either to the fully qualified or relative path of the program, the full program name, or the program name without its file name extension.| +| Variable | Description | +|---|---| +| [`__argc`, `__argv`, `__wargv`](./argc-argv-wargv.md) | Contains the command-line arguments. | +| [`_daylight`, `_dstbias`, `_timezone`, and `_tzname`](./daylight-dstbias-timezone-and-tzname.md) | Deprecated. Instead, use `_get_daylight`, `_get_dstbias`, `_get_timezone`, and `_get_tzname`.

Adjusts for local time; used in some date and time functions. | +| [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](./errno-doserrno-sys-errlist-and-sys-nerr.md) | Deprecated. Instead, use `_get_errno`, `_set_errno`, `_get_doserrno`, `_set_doserrno`, `perror` and `strerror`.

Stores error codes and related information. | +| [`_environ`, `_wenviron`](./environ-wenviron.md) | Deprecated. Instead, use `getenv_s`, `_wgetenv_s`, `_dupenv_s`, `_wdupenv_s`, `_putenv_s`, and `_wputenv_s`.

Pointers to arrays of pointers to the process environment strings; initialized at startup. | +| [`_fmode`](./fmode.md) | Deprecated. Instead, use `_get_fmode` or `_set_fmode`.

Sets default file-translation mode. | +| [`_iob`](./iob.md) | Array of I/O control structures for the console, files, and devices. | +| [`_pctype`, `_pwctype`, `_wctype`, `_mbctype`, `_mbcasemap`](./pctype-pwctype-wctype-mbctype-mbcasemap.md) | Contains information used by the character-classification functions. | +| [`_pgmptr`, `_wpgmptr`](./pgmptr-wpgmptr.md) | Deprecated. Instead, use `_get_pgmptr` or `_get_wpgmptr`.

Based on how the program is invoked, the runtime initializes these values at program startup: either to the fully qualified or relative path of the program, the full program name, or the program name without its file name extension. | ## See also diff --git a/docs/c-runtime-library/heap-constants.md b/docs/c-runtime-library/heap-constants.md index 25d20136c76..efe43199496 100644 --- a/docs/c-runtime-library/heap-constants.md +++ b/docs/c-runtime-library/heap-constants.md @@ -10,7 +10,7 @@ ms.assetid: 3f751bb9-2dc4-486f-b5f5-9061c96d3754 ## Syntax -``` +```C #include ``` @@ -18,14 +18,14 @@ ms.assetid: 3f751bb9-2dc4-486f-b5f5-9061c96d3754 These constants give the return value indicating status of the heap. -|Constant|Meaning| -|--------------|-------------| -|`_HEAPBADBEGIN`|Initial header information wasn't found or was invalid.| -|`_HEAPBADNODE`|Bad node was found, or heap is damaged.| -|`_HEAPBADPTR`|`_pentry` field of `_HEAPINFO` structure doesn't contain valid pointer into heap (`_heapwalk` routine only).| -|`_HEAPEMPTY`|Heap hasn't been initialized.| -|`_HEAPEND`|End of heap was reached successfully (`_heapwalk` routine only).| -|`_HEAPOK`|Heap is consistent (`_heapset` and `_heapchk` routines only). No errors so far; `_HEAPINFO` structure contains information about next entry (`_heapwalk` routine only).| +| Constant | Meaning | +|---|---| +| `_HEAPBADBEGIN` | Initial header information wasn't found or was invalid. | +| `_HEAPBADNODE` | Bad node was found, or heap is damaged. | +| `_HEAPBADPTR` | `_pentry` field of `_HEAPINFO` structure doesn't contain valid pointer into heap (`_heapwalk` routine only). | +| `_HEAPEMPTY` | Heap hasn't been initialized. | +| `_HEAPEND` | End of heap was reached successfully (`_heapwalk` routine only). | +| `_HEAPOK` | Heap is consistent (`_heapset` and `_heapchk` routines only). No errors so far; `_HEAPINFO` structure contains information about next entry (`_heapwalk` routine only). | ## See also diff --git a/docs/c-runtime-library/heap-maxreq.md b/docs/c-runtime-library/heap-maxreq.md index e5245c6c331..168783f8415 100644 --- a/docs/c-runtime-library/heap-maxreq.md +++ b/docs/c-runtime-library/heap-maxreq.md @@ -10,7 +10,7 @@ ms.assetid: c2dbc2ea-35ad-45d8-b459-d76ba0089ff7 ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/heapadd.md b/docs/c-runtime-library/heapadd.md index e4e8174509a..737e7991fe3 100644 --- a/docs/c-runtime-library/heapadd.md +++ b/docs/c-runtime-library/heapadd.md @@ -19,14 +19,14 @@ Adds memory to the heap. ## Syntax -``` +```C int _heapadd( void *memblock, size_t size ); ``` -#### Parameters +### Parameters *`memblock`*\ Pointer to the heap memory. @@ -36,19 +36,19 @@ Size of memory to add, in bytes. ## Return value -If successful, `_heapadd` returns 0; otherwise, the function returns -1 and sets `errno` to `ENOSYS`. +If successful, **`_heapadd`** returns 0; otherwise, the function returns -1 and sets `errno` to `ENOSYS`. For more information about this and other return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](./errno-doserrno-sys-errlist-and-sys-nerr.md). ## Remarks -Beginning with Visual C++ version 4.0, the underlying heap structure was moved to the C run-time libraries to support the new debugging features. As a result, `_heapadd` is no longer supported on any platform that is based on the Win32 API. +Beginning with Visual C++ version 4.0, the underlying heap structure was moved to the C run-time libraries to support the new debugging features. As a result, **`_heapadd`** is no longer supported on any platform that is based on the Win32 API. ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|`_heapadd`|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_heapadd`** | \ | \ | For more compatibility information, see [Compatibility](./compatibility.md) in the Introduction. diff --git a/docs/c-runtime-library/heapset.md b/docs/c-runtime-library/heapset.md index 103ca0a22b1..98b435fbb4d 100644 --- a/docs/c-runtime-library/heapset.md +++ b/docs/c-runtime-library/heapset.md @@ -19,7 +19,7 @@ Checks heaps for minimal consistency and sets the free entries to a specified va ## Syntax -``` +```C int _heapset( unsigned int fill ); @@ -32,28 +32,28 @@ Fill character. ## Return value -`_heapset` returns one of the following integer manifest constants defined in Malloc.h. +**`_heapset`** returns one of the following integer manifest constants defined in Malloc.h. -|Value|Description| -|-|-| -| `_HEAPBADBEGIN` | Initial header information invalid or not found. | -| `_HEAPBADNODE` | Heap damaged or bad node found. | -| `_HEAPEMPTY` | Heap not initialized. | -| `_HEAPOK` | Heap appears to be consistent. | +| Value | Description | +|---|---| +| `_HEAPBADBEGIN` | Initial header information invalid or not found. | +| `_HEAPBADNODE` | Heap damaged or bad node found. | +| `_HEAPEMPTY` | Heap not initialized. | +| `_HEAPOK` | Heap appears to be consistent. | -In addition, if an error occurs, `_heapset` sets `errno` to `ENOSYS`. +In addition, if an error occurs, **`_heapset`** sets `errno` to `ENOSYS`. ## Remarks -The `_heapset` function shows free memory locations or nodes that have been unintentionally overwritten. +The **`_heapset`** function shows free memory locations or nodes that have been unintentionally overwritten. -`_heapset` checks for minimal consistency on the heap and then sets each byte of the heap's free entries to the `fill` value. This known value shows which memory locations of the heap contain free nodes and which contain data that were unintentionally written to freed memory. If the operating system doesn't support `_heapset`(for example, Windows 98), the function returns `_HEAPOK` and sets `errno` to `ENOSYS`. +**`_heapset`** checks for minimal consistency on the heap and then sets each byte of the heap's free entries to the `fill` value. This known value shows which memory locations of the heap contain free nodes and which contain data that were unintentionally written to freed memory. If the operating system doesn't support **`_heapset`**(for example, Windows 98), the function returns `_HEAPOK` and sets `errno` to `ENOSYS`. ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|`_heapset`|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_heapset`** | \ | \ | For more compatibility information, see [Compatibility](./compatibility.md) in the Introduction. diff --git a/docs/c-runtime-library/huge-val-huge.md b/docs/c-runtime-library/huge-val-huge.md index 41c16c265f2..26ee64947d0 100644 --- a/docs/c-runtime-library/huge-val-huge.md +++ b/docs/c-runtime-library/huge-val-huge.md @@ -14,7 +14,7 @@ ms.assetid: 3f044b45-02cd-46b2-b1de-87fd0441dd6a ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/inp-inpw-inpd.md b/docs/c-runtime-library/inp-inpw-inpd.md index 6846b10f020..3e98fc33a2c 100644 --- a/docs/c-runtime-library/inp-inpw-inpd.md +++ b/docs/c-runtime-library/inp-inpw-inpd.md @@ -12,7 +12,7 @@ ms.assetid: 5d9c2e38-fc85-4294-86d5-7282cc02d1b3 --- # `inp`, `_inp`, `inpw`, `_inpw`, `_inpd` -Inputs, from a port, a byte (`inp`, `_inp`), a word (`inpw`, `_inpw`), or a double word (`_inpd`). +Inputs, from a port, a byte (**`inp`**, **`_inp`**), a word (**`inpw`**, **`_inpw`**), or a double word (**`_inpd`**). > [!IMPORTANT] > These functions are obsolete. Beginning in Visual Studio 2015, they are not available in the CRT.\ @@ -43,19 +43,19 @@ The functions return the byte, word, or double word read from *`port`*. There's ## Remarks -The `_inp`, `_inpw`, and `_inpd` functions read a byte, a word, and a double word, respectively, from the specified input port. The input value can be any unsigned short integer in the range 0 - 65,535. +The **`_inp`**, **`_inpw`**, and **`_inpd`** functions read a byte, a word, and a double word, respectively, from the specified input port. The input value can be any unsigned short integer in the range 0 - 65,535. Because these functions read directly from an I/O port, they can't be used in user code. -The `inp` and `inpw` names are older, deprecated names for the `_inp` and `_inpw` functions. For more information, see [POSIX function names](../error-messages/compiler-warnings/compiler-warning-level-3-c4996.md#posix-function-names). +The **`inp`** and **`inpw`** names are older, deprecated names for the **`_inp`** and **`_inpw`** functions. For more information, see [POSIX function names](../error-messages/compiler-warnings/compiler-warning-level-3-c4996.md#posix-function-names). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`_inp`|\| -|`_inpw`|\| -|`_inpd`|\| +| Routine | Required header | +|---|---| +| **`_inp`** | \ | +| **`_inpw`** | \ | +| **`_inpd`** | \ | For more compatibility information, see [Compatibility](./compatibility.md). diff --git a/docs/c-runtime-library/internal-crt-globals-and-functions.md b/docs/c-runtime-library/internal-crt-globals-and-functions.md index 77abd7513a5..c67212055a8 100644 --- a/docs/c-runtime-library/internal-crt-globals-and-functions.md +++ b/docs/c-runtime-library/internal-crt-globals-and-functions.md @@ -17,332 +17,332 @@ The C runtime (CRT) library contains functions and global variables that are use These global variables and macro definitions are used to implement the CRT. -|Name| -|----------| -|`__badioinfo`| -|[`_acmdln`](./acmdln-tcmdln-wcmdln.md)| -|`_commode`| -|`_crtAssertBusy`| -|`_crtBreakAlloc`| -|`__initenv`| -|`__lconv`| -|[`__mb_cur_max`](./mb-cur-max-func-mb-cur-max-l-func-p-mb-cur-max-mb-cur-max.md)| -|`__pioinfo`| -|`__unguarded_readlc_active`| -|[`_wcmdln`](./acmdln-tcmdln-wcmdln.md)| -|`__winitenv`| +| Name | +|---| +| `__badioinfo` | +| [`_acmdln`](./acmdln-tcmdln-wcmdln.md) | +| `_commode` | +| `_crtAssertBusy` | +| `_crtBreakAlloc` | +| `__initenv` | +| `__lconv` | +| [`__mb_cur_max`](./mb-cur-max-func-mb-cur-max-l-func-p-mb-cur-max-mb-cur-max.md) | +| `__pioinfo` | +| `__unguarded_readlc_active` | +| [`_wcmdln`](./acmdln-tcmdln-wcmdln.md) | +| `__winitenv` | ## Internal CRT functions and function macros These functions and function macros are used to implement the CRT and the C++ Standard Library. -|Name| -|----------| -|`__acrt_iob_func`| -|`__AdjustPointer`| -|`_assert`| -|`__BuildCatchObject`| -|`__BuildCatchObjectHelper`| -|`__C_specific_handler`| -|`_calloc_base`| -|`_chkesp`| -|`__chkstk`| -|`_chkstk`| -|`_chvalidator`| -|`_chvalidator_l`| -|`_CIacos`| -|`_CIasin`| -|[`_CIatan`](./ciatan.md)| -|[`_CIatan2`](./ciatan2.md)| -|[`_CIcos`](./cicos.md)| -|`_CIcosh`| -|[`_CIexp`](./ciexp.md)| -|[`_CIfmod`](./cifmod.md)| -|[`_CIlog`](./cilog.md)| -|[`_CIlog10`](./cilog10.md)| -|[`_CIpow`](./cipow.md)| -|[`_CIsin`](./cisin.md)| -|`_CIsinh`| -|[`_CIsqrt`](./cisqrt.md)| -|[`_CItan`](./citan.md)| -|`_CItanh`| -|`__clean_type_info_names_internal`| -|`_configure_narrow_argv`| -|`_configure_wide_argv`| -|`__conio_common_vcprintf`| -|`__conio_common_vcprintf_p`| -|`__conio_common_vcprintf_s`| -|`__conio_common_vcscanf`| -|`__conio_common_vcwprintf`| -|`__conio_common_vcwprintf_p`| -|`__conio_common_vcwprintf_s`| -|`__conio_common_vcwscanf`| -|`__CppXcptFilter`| -|`__create_locale`| -|`_crt_atexit`| -|`_crt_at_quick_exit`| -|`__crtCompareStringA`| -|`__crtCompareStringEx`| -|`__crtCompareStringW`| -|`__crtCreateEventExW`| -|`__crtCreateSemaphoreExW`| -|`__crtCreateSymbolicLinkW`| -|`_crt_debugger_hook`| -|`__crtEnumSystemLocalesEx`| -|`__crtFlsAlloc`| -|`__crtFlsFree`| -|`__crtFlsGetValue`| -|`__crtFlsSetValue`| -|`_CrtGetCheckCount`| -|`__crtGetDateFormatEx`| -|`__crtGetFileInformationByHandleEx`| -|`__crtGetLocaleInfoEx`| -|`__crtGetShowWindowMode`| -|`__crtGetTickCount64`| -|`__crtGetTimeFormatEx`| -|`__crtGetUserDefaultLocaleName`| -|`__crtInitializeCriticalSectionEx`| -|`__crtIsPackagedApp`| -|`__crtIsValidLocaleName`| -|`__crtLCMapStringA`| -|`__crtLCMapStringEx`| -|[`__crtLCMapStringW`](./crtlcmapstringw.md)| -|`_CrtSetCheckCount`| -|`_CrtSetDbgBlockType`| -|`__crtSetFileInformationByHandle`| -|`__crtSetThreadStackGuarantee`| -|`__crtSetUnhandledExceptionFilter`| -|`__crtSleep`| -|`__crtTerminateProcess`| -|`__crtUnhandledException`| -|`__CxxDetectRethrow`| -|`__CxxExceptionFilter`| -|[`__CxxFrameHandler`](./cxxframehandler.md)| -|`__CxxFrameHandler2`| -|`__CxxFrameHandler3`| -|`__CxxLongjmpUnwind`| -|`__CxxQueryExceptionSize`| -|`__CxxRegisterExceptionObject`| -|`_CxxThrowException`| -|`__CxxUnregisterExceptionObject`| -|`__daylight`| -|`_dclass`| -|`__DestructExceptionObject`| -|[`__dllonexit`](./dllonexit.md)| -|`__doserrno`| -|`_dosmaperr`| -|`_dpcomp`| -|`_dsign`| -|`__dstbias`| -|`_dtest`| -|`_EH_prolog`| -|`_errno`| -|`_except_handler2`| -|[`_except_handler3`](./except-handler3.md)| -|`_except_handler4_common`| -|`_except1`| -|[`_execute_onexit_table`](./execute-onexit-table-initialize-onexit-table-register-onexit-function.md)| -|`_fdclass`| -|`_fdpcomp`| -|`_fdsign`| -|`_fdtest`| -|`_filbuf`| -|`_FindAndUnlinkFrame`| -|`_flsbuf`| -|`__fpe_flt_rounds`| -|`_FPE_Raise`| -|`__fpecode`| -|`__FrameUnwindFilter`| -|`_fread_nolock_s`| -|`_free_base`| -|`__free_locale`| -|`_freea_s`| -|`_freefls`| -|`_ftol`| -|`__get_current_locale`| -|`__get_flsindex`| -|`_get_initial_narrow_environment`| -|`_get_initial_wide_environment`| -|`_get_narrow_winmain_command_line`| -|`_get_stream_buffer_pointers`| -|`__get_tlsindex`| -|`_get_wide_winmain_command_line`| -|`_Getdays`| -|[`__getmainargs`](./getmainargs-wgetmainargs.md)| -|`_Getmonths`| -|`__GetPlatformExceptionInfo`| -|`_getptd`| -|`_Gettnames`| -|`_global_unwind2`| -|`_inconsistency`| -|`_initialize_lconv_for_unsigned_char`| -|`_initialize_narrow_environment`| -|[`_initialize_onexit_table`](./execute-onexit-table-initialize-onexit-table-register-onexit-function.md)| -|`_initialize_wide_environment`| -|`_initptd`| -|`_invalid_parameter`| -|`_invoke_watson`| -|`__iob_func`| -|`_IsExceptionObjectToBeDestroyed`| -|[`___lc_codepage_func`](./lc-codepage-func.md)| -|[`___lc_collate_cp_func`](./lc-collate-cp-func.md)| -|[`___lc_locale_name_func`](./lc-locale-name-func.md)| -|`__lconv_init`| -|`_ldclass`| -|`_ldpcomp`| -|`_ldsign`| -|`_ldtest`| -|`__libm_sse2_acos`| -|`_libm_sse2_acos_precise`| -|`__libm_sse2_acosf`| -|`__libm_sse2_asin`| -|`_libm_sse2_asin_precise`| -|`__libm_sse2_asinf`| -|`__libm_sse2_atan`| -|`_libm_sse2_atan_precise`| -|`__libm_sse2_atan2`| -|`__libm_sse2_atanf`| -|`__libm_sse2_cos`| -|`_libm_sse2_cos_precise`| -|`__libm_sse2_cosf`| -|`__libm_sse2_exp`| -|`_libm_sse2_exp_precise`| -|`__libm_sse2_expf`| -|`__libm_sse2_log`| -|`_libm_sse2_log_precise`| -|`__libm_sse2_log10`| -|`_libm_sse2_log10_precise`| -|`__libm_sse2_log10f`| -|`__libm_sse2_logf`| -|`__libm_sse2_pow`| -|`_libm_sse2_pow_precise`| -|`__libm_sse2_powf`| -|`__libm_sse2_sin`| -|`_libm_sse2_sin_precise`| -|`__libm_sse2_sinf`| -|`_libm_sse2_sqrt_precise`| -|`__libm_sse2_tan`| -|`_libm_sse2_tan_precise`| -|`__libm_sse2_tanf`| -|[`_local_unwind2`](./local-unwind2.md)| -|`_local_unwind4`| -|`_lock_locales`| -|`_longjmpex`| -|`_malloc_base`| -|[`___mb_cur_max_func`](./mb-cur-max-func-mb-cur-max-l-func-p-mb-cur-max-mb-cur-max.md)| -|[`___mb_cur_max_l_func`](./mb-cur-max-func-mb-cur-max-l-func-p-mb-cur-max-mb-cur-max.md)| -|`_mbctype`| -|`_NLG_Dispatch2`| -|`_NLG_Return`| -|`_NLG_Return2`| -|`__p___argc`| -|`__p___argv`| -|`__p___initenv`| -|[`__p___mb_cur_max`](./mb-cur-max-func-mb-cur-max-l-func-p-mb-cur-max-mb-cur-max.md)| -|`__p___wargv`| -|`__p___winitenv`| -|`__p__acmdln`| -|[`__p__commode`](./p-commode.md)| -|`__p__crtAssertBusy`| -|`__p__crtBreakAlloc`| -|`__p__crtDbgFlag`| -|`__p__daylight`| -|`__p__dstbias`| -|`__p__environ`| -|[`__p__fmode`](./p-fmode.md)| -|`__p__iob`| -|`__p__mbcasemap`| -|`__p__mbctype`| -|`__p__pctype`| -|`__p__pgmptr`| -|`__p__pwctype`| -|`__p__timezone`| -|`__p__tzname`| -|`__p__wcmdln`| -|`__p__wenviron`| -|`__p__wpgmptr`| -|`_pctype`| -|[`__pctype_func`](./pctype-func.md)| -|`_pwctype`| -|`__pwctype_func`| -|`__pxcptinfoptrs`| -|`_query_app_type`| -|`_realloc_base`| -|[`_register_onexit_function`](./execute-onexit-table-initialize-onexit-table-register-onexit-function.md)| -|`_register_thread_local_exe_atexit_callback`| -|`__report_gsfailure`| -|`__RTCastToVoid`| -|[`__RTDynamicCast`](./rtdynamiccast.md)| -|`__RTtypeid`| -|`_seh_filter_dll`| -|`_seh_filter_exe`| -|`_seh_longjmp_unwind`| -|`_seh_longjmp_unwind4`| -|[`__set_app_type`](./internal-set-app-type.md)| -|`_set_malloc_crt_max_wait`| -|[`_setjmp3`](./setjmp3.md)| -|`__setlc_active`| -|[`___setlc_active_func`](./setlc-active-func-unguarded-readlc-active-add-func.md)| -|[`__setusermatherr`](./setusermatherr.md)| -|`_SetWinRTOutOfMemoryExceptionCallback`| -|`_sopen_dispatch`| -|`__std_exception_copy`| -|`__std_exception_destroy`| -|`__std_type_info_destroy_list`| -|`__std_type_info_name`| -|`__stdio_common_vfprintf`| -|`__stdio_common_vfprintf_p`| -|`__stdio_common_vfprintf_s`| -|`__stdio_common_vfscanf`| -|`__stdio_common_vfwprintf`| -|`__stdio_common_vfwprintf_p`| -|`__stdio_common_vfwprintf_s`| -|`__stdio_common_vfwscanf`| -|`__stdio_common_vsnprintf_s`| -|`__stdio_common_vsnwprintf_s`| -|`__stdio_common_vsprintf`| -|`__stdio_common_vsprintf_p`| -|`__stdio_common_vsprintf_s`| -|`__stdio_common_vsscanf`| -|`__stdio_common_vswprintf`| -|`__stdio_common_vswprintf_p`| -|`__stdio_common_vswprintf_s`| -|`__stdio_common_vswscanf`| -|`_Strftime`| -|`__STRINGTOLD`| -|`__STRINGTOLD_L`| -|`__strncnt`| -|`__sys_errlist`| -|`__sys_nerr`| -|`__threadhandle`| -|`__threadid`| -|`__timezone`| -|`__TypeMatch`| -|`__tzname`| -|`__unDName`| -|`__unDNameEx`| -|`__unDNameHelper`| -|`__unguarded_readlc_active`| -|[`___unguarded_readlc_active_add_func`](./setlc-active-func-unguarded-readlc-active-add-func.md)| -|`_unloaddll`| -|`_unlock_locales`| -|`_vacopy`| -|`_ValidateExecute`| -|`_ValidateRead`| -|`_ValidateWrite`| -|`_VCrtDbgReportA`| -|`_VCrtDbgReportW`| -|`_W_Getdays`| -|`_W_Getmonths`| -|`_W_Getnames`| -|`_W_Gettnames`| -|`_wassert`| -|`_Wcsftime`| -|`__wcsncnt`| -|[`__wgetmainargs`](./getmainargs-wgetmainargs.md)| -|`_wsopen_dispatch`| -|`_Xbad_alloc`| -|`_Xlength_error`| +| Name | +|---| +| `__acrt_iob_func` | +| `__AdjustPointer` | +| `_assert` | +| `__BuildCatchObject` | +| `__BuildCatchObjectHelper` | +| `__C_specific_handler` | +| `_calloc_base` | +| `_chkesp` | +| `__chkstk` | +| `_chkstk` | +| `_chvalidator` | +| `_chvalidator_l` | +| `_CIacos` | +| `_CIasin` | +| [`_CIatan`](./ciatan.md) | +| [`_CIatan2`](./ciatan2.md) | +| [`_CIcos`](./cicos.md) | +| `_CIcosh` | +| [`_CIexp`](./ciexp.md) | +| [`_CIfmod`](./cifmod.md) | +| [`_CIlog`](./cilog.md) | +| [`_CIlog10`](./cilog10.md) | +| [`_CIpow`](./cipow.md) | +| [`_CIsin`](./cisin.md) | +| `_CIsinh` | +| [`_CIsqrt`](./cisqrt.md) | +| [`_CItan`](./citan.md) | +| `_CItanh` | +| `__clean_type_info_names_internal` | +| `_configure_narrow_argv` | +| `_configure_wide_argv` | +| `__conio_common_vcprintf` | +| `__conio_common_vcprintf_p` | +| `__conio_common_vcprintf_s` | +| `__conio_common_vcscanf` | +| `__conio_common_vcwprintf` | +| `__conio_common_vcwprintf_p` | +| `__conio_common_vcwprintf_s` | +| `__conio_common_vcwscanf` | +| `__CppXcptFilter` | +| `__create_locale` | +| `_crt_atexit` | +| `_crt_at_quick_exit` | +| `__crtCompareStringA` | +| `__crtCompareStringEx` | +| `__crtCompareStringW` | +| `__crtCreateEventExW` | +| `__crtCreateSemaphoreExW` | +| `__crtCreateSymbolicLinkW` | +| `_crt_debugger_hook` | +| `__crtEnumSystemLocalesEx` | +| `__crtFlsAlloc` | +| `__crtFlsFree` | +| `__crtFlsGetValue` | +| `__crtFlsSetValue` | +| `_CrtGetCheckCount` | +| `__crtGetDateFormatEx` | +| `__crtGetFileInformationByHandleEx` | +| `__crtGetLocaleInfoEx` | +| `__crtGetShowWindowMode` | +| `__crtGetTickCount64` | +| `__crtGetTimeFormatEx` | +| `__crtGetUserDefaultLocaleName` | +| `__crtInitializeCriticalSectionEx` | +| `__crtIsPackagedApp` | +| `__crtIsValidLocaleName` | +| `__crtLCMapStringA` | +| `__crtLCMapStringEx` | +| [`__crtLCMapStringW`](./crtlcmapstringw.md) | +| `_CrtSetCheckCount` | +| `_CrtSetDbgBlockType` | +| `__crtSetFileInformationByHandle` | +| `__crtSetThreadStackGuarantee` | +| `__crtSetUnhandledExceptionFilter` | +| `__crtSleep` | +| `__crtTerminateProcess` | +| `__crtUnhandledException` | +| `__CxxDetectRethrow` | +| `__CxxExceptionFilter` | +| [`__CxxFrameHandler`](./cxxframehandler.md) | +| `__CxxFrameHandler2` | +| `__CxxFrameHandler3` | +| `__CxxLongjmpUnwind` | +| `__CxxQueryExceptionSize` | +| `__CxxRegisterExceptionObject` | +| `_CxxThrowException` | +| `__CxxUnregisterExceptionObject` | +| `__daylight` | +| `_dclass` | +| `__DestructExceptionObject` | +| [`__dllonexit`](./dllonexit.md) | +| `__doserrno` | +| `_dosmaperr` | +| `_dpcomp` | +| `_dsign` | +| `__dstbias` | +| `_dtest` | +| `_EH_prolog` | +| `_errno` | +| `_except_handler2` | +| [`_except_handler3`](./except-handler3.md) | +| `_except_handler4_common` | +| `_except1` | +| [`_execute_onexit_table`](./execute-onexit-table-initialize-onexit-table-register-onexit-function.md) | +| `_fdclass` | +| `_fdpcomp` | +| `_fdsign` | +| `_fdtest` | +| `_filbuf` | +| `_FindAndUnlinkFrame` | +| `_flsbuf` | +| `__fpe_flt_rounds` | +| `_FPE_Raise` | +| `__fpecode` | +| `__FrameUnwindFilter` | +| `_fread_nolock_s` | +| `_free_base` | +| `__free_locale` | +| `_freea_s` | +| `_freefls` | +| `_ftol` | +| `__get_current_locale` | +| `__get_flsindex` | +| `_get_initial_narrow_environment` | +| `_get_initial_wide_environment` | +| `_get_narrow_winmain_command_line` | +| `_get_stream_buffer_pointers` | +| `__get_tlsindex` | +| `_get_wide_winmain_command_line` | +| `_Getdays` | +| [`__getmainargs`](./getmainargs-wgetmainargs.md) | +| `_Getmonths` | +| `__GetPlatformExceptionInfo` | +| `_getptd` | +| `_Gettnames` | +| `_global_unwind2` | +| `_inconsistency` | +| `_initialize_lconv_for_unsigned_char` | +| `_initialize_narrow_environment` | +| [`_initialize_onexit_table`](./execute-onexit-table-initialize-onexit-table-register-onexit-function.md) | +| `_initialize_wide_environment` | +| `_initptd` | +| `_invalid_parameter` | +| `_invoke_watson` | +| `__iob_func` | +| `_IsExceptionObjectToBeDestroyed` | +| [`___lc_codepage_func`](./lc-codepage-func.md) | +| [`___lc_collate_cp_func`](./lc-collate-cp-func.md) | +| [`___lc_locale_name_func`](./lc-locale-name-func.md) | +| `__lconv_init` | +| `_ldclass` | +| `_ldpcomp` | +| `_ldsign` | +| `_ldtest` | +| `__libm_sse2_acos` | +| `_libm_sse2_acos_precise` | +| `__libm_sse2_acosf` | +| `__libm_sse2_asin` | +| `_libm_sse2_asin_precise` | +| `__libm_sse2_asinf` | +| `__libm_sse2_atan` | +| `_libm_sse2_atan_precise` | +| `__libm_sse2_atan2` | +| `__libm_sse2_atanf` | +| `__libm_sse2_cos` | +| `_libm_sse2_cos_precise` | +| `__libm_sse2_cosf` | +| `__libm_sse2_exp` | +| `_libm_sse2_exp_precise` | +| `__libm_sse2_expf` | +| `__libm_sse2_log` | +| `_libm_sse2_log_precise` | +| `__libm_sse2_log10` | +| `_libm_sse2_log10_precise` | +| `__libm_sse2_log10f` | +| `__libm_sse2_logf` | +| `__libm_sse2_pow` | +| `_libm_sse2_pow_precise` | +| `__libm_sse2_powf` | +| `__libm_sse2_sin` | +| `_libm_sse2_sin_precise` | +| `__libm_sse2_sinf` | +| `_libm_sse2_sqrt_precise` | +| `__libm_sse2_tan` | +| `_libm_sse2_tan_precise` | +| `__libm_sse2_tanf` | +| [`_local_unwind2`](./local-unwind2.md) | +| `_local_unwind4` | +| `_lock_locales` | +| `_longjmpex` | +| `_malloc_base` | +| [`___mb_cur_max_func`](./mb-cur-max-func-mb-cur-max-l-func-p-mb-cur-max-mb-cur-max.md) | +| [`___mb_cur_max_l_func`](./mb-cur-max-func-mb-cur-max-l-func-p-mb-cur-max-mb-cur-max.md) | +| `_mbctype` | +| `_NLG_Dispatch2` | +| `_NLG_Return` | +| `_NLG_Return2` | +| `__p___argc` | +| `__p___argv` | +| `__p___initenv` | +| [`__p___mb_cur_max`](./mb-cur-max-func-mb-cur-max-l-func-p-mb-cur-max-mb-cur-max.md) | +| `__p___wargv` | +| `__p___winitenv` | +| `__p__acmdln` | +| [`__p__commode`](./p-commode.md) | +| `__p__crtAssertBusy` | +| `__p__crtBreakAlloc` | +| `__p__crtDbgFlag` | +| `__p__daylight` | +| `__p__dstbias` | +| `__p__environ` | +| [`__p__fmode`](./p-fmode.md) | +| `__p__iob` | +| `__p__mbcasemap` | +| `__p__mbctype` | +| `__p__pctype` | +| `__p__pgmptr` | +| `__p__pwctype` | +| `__p__timezone` | +| `__p__tzname` | +| `__p__wcmdln` | +| `__p__wenviron` | +| `__p__wpgmptr` | +| `_pctype` | +| [`__pctype_func`](./pctype-func.md) | +| `_pwctype` | +| `__pwctype_func` | +| `__pxcptinfoptrs` | +| `_query_app_type` | +| `_realloc_base` | +| [`_register_onexit_function`](./execute-onexit-table-initialize-onexit-table-register-onexit-function.md) | +| `_register_thread_local_exe_atexit_callback` | +| `__report_gsfailure` | +| `__RTCastToVoid` | +| [`__RTDynamicCast`](./rtdynamiccast.md) | +| `__RTtypeid` | +| `_seh_filter_dll` | +| `_seh_filter_exe` | +| `_seh_longjmp_unwind` | +| `_seh_longjmp_unwind4` | +| [`__set_app_type`](./internal-set-app-type.md) | +| `_set_malloc_crt_max_wait` | +| [`_setjmp3`](./setjmp3.md) | +| `__setlc_active` | +| [`___setlc_active_func`](./setlc-active-func-unguarded-readlc-active-add-func.md) | +| [`__setusermatherr`](./setusermatherr.md) | +| `_SetWinRTOutOfMemoryExceptionCallback` | +| `_sopen_dispatch` | +| `__std_exception_copy` | +| `__std_exception_destroy` | +| `__std_type_info_destroy_list` | +| `__std_type_info_name` | +| `__stdio_common_vfprintf` | +| `__stdio_common_vfprintf_p` | +| `__stdio_common_vfprintf_s` | +| `__stdio_common_vfscanf` | +| `__stdio_common_vfwprintf` | +| `__stdio_common_vfwprintf_p` | +| `__stdio_common_vfwprintf_s` | +| `__stdio_common_vfwscanf` | +| `__stdio_common_vsnprintf_s` | +| `__stdio_common_vsnwprintf_s` | +| `__stdio_common_vsprintf` | +| `__stdio_common_vsprintf_p` | +| `__stdio_common_vsprintf_s` | +| `__stdio_common_vsscanf` | +| `__stdio_common_vswprintf` | +| `__stdio_common_vswprintf_p` | +| `__stdio_common_vswprintf_s` | +| `__stdio_common_vswscanf` | +| `_Strftime` | +| `__STRINGTOLD` | +| `__STRINGTOLD_L` | +| `__strncnt` | +| `__sys_errlist` | +| `__sys_nerr` | +| `__threadhandle` | +| `__threadid` | +| `__timezone` | +| `__TypeMatch` | +| `__tzname` | +| `__unDName` | +| `__unDNameEx` | +| `__unDNameHelper` | +| `__unguarded_readlc_active` | +| [`___unguarded_readlc_active_add_func`](./setlc-active-func-unguarded-readlc-active-add-func.md) | +| `_unloaddll` | +| `_unlock_locales` | +| `_vacopy` | +| `_ValidateExecute` | +| `_ValidateRead` | +| `_ValidateWrite` | +| `_VCrtDbgReportA` | +| `_VCrtDbgReportW` | +| `_W_Getdays` | +| `_W_Getmonths` | +| `_W_Getnames` | +| `_W_Gettnames` | +| `_wassert` | +| `_Wcsftime` | +| `__wcsncnt` | +| [`__wgetmainargs`](./getmainargs-wgetmainargs.md) | +| `_wsopen_dispatch` | +| `_Xbad_alloc` | +| `_Xlength_error` | ## See also diff --git a/docs/c-runtime-library/internal-set-app-type.md b/docs/c-runtime-library/internal-set-app-type.md index 9383eac9ba1..6f3526048d2 100644 --- a/docs/c-runtime-library/internal-set-app-type.md +++ b/docs/c-runtime-library/internal-set-app-type.md @@ -22,21 +22,21 @@ void __set_app_type ( ) ``` -#### Parameters +### Parameters *`at`*\ A value that indicates the application type. The possible values are: -|Value|Description| -|-----------|-----------------| -|_UNKNOWN_APP|Unknown application type.| -|_CONSOLE_APP|Console (command-line) application.| -|_GUI_APP|GUI (Windows) application.| +| Value | Description | +|---|---| +| `_UNKNOWN_APP` | Unknown application type. | +| `_CONSOLE_APP` | Console (command-line) application. | +| `_GUI_APP` | GUI (Windows) application. | ## Remarks ## Requirements -|Routine|Required header| -|-------------|---------------------| -|__set_app_type|internal.h| +| Routine | Required header | +|---|---| +| **`__set_app_type`** | `internal.h` | diff --git a/docs/c-runtime-library/interpretation-of-multibyte-character-sequences.md b/docs/c-runtime-library/interpretation-of-multibyte-character-sequences.md index e5d8c9d54db..63a877ee60b 100644 --- a/docs/c-runtime-library/interpretation-of-multibyte-character-sequences.md +++ b/docs/c-runtime-library/interpretation-of-multibyte-character-sequences.md @@ -12,21 +12,21 @@ Most multibyte-character routines in the Microsoft run-time library recognize mu ## Locale-dependent multibyte routines -|Routine|Use| -|-------------|---------| -|[`_mbclen`, `mblen`, `_mblen_l`](./reference/mbclen-mblen-mblen-l.md)|Validate and return number of bytes in multibyte character| -|[`strlen`, `wcslen`, `_mbslen`, `_mbslen_l`, `_mbstrlen`, `_mbstrlen_l`](./reference/strlen-wcslen-mbslen-mbslen-l-mbstrlen-mbstrlen-l.md)|For multibyte character strings: validate each character in string; return string length. For wide character strings: return string length.| -|[`mbstowcs`, `_mbstowcs_l`](./reference/mbstowcs-mbstowcs-l.md), [`mbstowcs_s`, `_mbstowcs_s_l`](./reference/mbstowcs-s-mbstowcs-s-l.md)|Convert sequence of multibyte characters to corresponding sequence of wide characters| -|[`mbtowc`, `_mbtowc_l`](./reference/mbtowc-mbtowc-l.md)|Convert multibyte character to corresponding wide character| -|[`wcstombs`, `_wcstombs_l`](./reference/wcstombs-wcstombs-l.md), [`wcstombs_s`, `_wcstombs_s_l`](./reference/wcstombs-s-wcstombs-s-l.md)|Convert sequence of wide characters to corresponding sequence of multibyte characters| -|[`wctomb`, `_wctomb_l`](./reference/wctomb-wctomb-l.md), [`wctomb_s`, `_wctomb_s_l`](./reference/wctomb-s-wctomb-s-l.md)|Convert wide character to corresponding multibyte character| +| Routine | Use | +|---|---| +| [`_mbclen`, `mblen`, `_mblen_l`](./reference/mbclen-mblen-mblen-l.md) | Validate and return number of bytes in multibyte character | +| [`strlen`, `wcslen`, `_mbslen`, `_mbslen_l`, `_mbstrlen`, `_mbstrlen_l`](./reference/strlen-wcslen-mbslen-mbslen-l-mbstrlen-mbstrlen-l.md) | For multibyte character strings: validate each character in string; return string length. For wide character strings: return string length. | +| [`mbstowcs`, `_mbstowcs_l`](./reference/mbstowcs-mbstowcs-l.md), [`mbstowcs_s`, `_mbstowcs_s_l`](./reference/mbstowcs-s-mbstowcs-s-l.md) | Convert sequence of multibyte characters to corresponding sequence of wide characters | +| [`mbtowc`, `_mbtowc_l`](./reference/mbtowc-mbtowc-l.md) | Convert multibyte character to corresponding wide character | +| [`wcstombs`, `_wcstombs_l`](./reference/wcstombs-wcstombs-l.md), [`wcstombs_s`, `_wcstombs_s_l`](./reference/wcstombs-s-wcstombs-s-l.md) | Convert sequence of wide characters to corresponding sequence of multibyte characters | +| [`wctomb`, `_wctomb_l`](./reference/wctomb-wctomb-l.md), [`wctomb_s`, `_wctomb_s_l`](./reference/wctomb-s-wctomb-s-l.md) | Convert wide character to corresponding multibyte character | ## Locale-independent multibyte routines -|Routine|Use| -|-------------|---------| -|[`mbrtoc16`, `mbrtoc32`](./reference/mbrtoc16-mbrtoc323.md)|Convert multibyte UTF-8 character to equivalent UTF-16 or UTF-32 character| -|[`c16rtomb`, `c32rtomb`](./reference/c16rtomb-c32rtomb1.md)|Convert UTF-16 or UTF-32 character to equivalent UTF-8 multibyte character| +| Routine | Use | +|---|---| +| [`mbrtoc16`, `mbrtoc32`](./reference/mbrtoc16-mbrtoc323.md) | Convert multibyte UTF-8 character to equivalent UTF-16 or UTF-32 character | +| [`c16rtomb`, `c32rtomb`](./reference/c16rtomb-c32rtomb1.md) | Convert UTF-16 or UTF-32 character to equivalent UTF-8 multibyte character | ## See also diff --git a/docs/c-runtime-library/iob.md b/docs/c-runtime-library/iob.md index 8d6d2b34cca..6029c1d1f82 100644 --- a/docs/c-runtime-library/iob.md +++ b/docs/c-runtime-library/iob.md @@ -6,7 +6,7 @@ api_name: ["_iob"] api_location: ["msvcrt.dll"] api_type: ["DLLExport"] topic_type: ["apiref"] -f1_keywords: ["_iob", "iob"] +f1_keywords: ["_iob", "_IOB_ENTRIES", "STDIO/_IOB_ENTRIES"] helpviewer_keywords: ["_iob global variable", "iob global variable"] ms.assetid: 008ed376-8078-4bbd-bc6c-0677c63d0ff1 --- @@ -16,13 +16,13 @@ The array of `stdio` control structures. ## Syntax -``` +```C FILE _iob[_IOB_ENTRIES]; ``` ## Remarks -`IOB_ENTRIES` is defined as 20 in `stdio.h`. +`_IOB_ENTRIES` is defined as 3 in `stdio.h`. ## See also diff --git a/docs/c-runtime-library/ismbc-routines.md b/docs/c-runtime-library/ismbc-routines.md index 1b479219fe2..6de251be772 100644 --- a/docs/c-runtime-library/ismbc-routines.md +++ b/docs/c-runtime-library/ismbc-routines.md @@ -13,16 +13,12 @@ ms.assetid: b8995391-7857-4ac3-9a1e-de946eb4464d Each `_ismbc` routine tests a given multibyte character `c` for a particular condition. -:::row::: - :::column span=""::: - [`_ismbcalnum`, `_ismbcalnum_l`, `_ismbcalpha`, `_ismbcalpha_l`, `_ismbcdigit`, `_ismbcdigit_l`](./reference/ismbcalnum-functions.md)\ - [`_ismbcl0`, `_ismbcl0_l`, `_ismbcl1`, `_ismbcl1_l`, `_ismbcl2`, `_ismbcl2_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md)\ - [`_ismbcgraph`, `_ismbcgraph_l`, `_ismbcprint`, `_ismbcprint_l`, `_ismbcpunct`, `_ismbcpunct_l`, `_ismbcblank`, `_ismbcblank_l`, `_ismbcspace`, `_ismbcspace_l`](./reference/ismbcgraph-functions.md)\ - [`_ismbclegal`, `_ismbclegal_l`, `_ismbcsymbol`, `_ismbcsymbol_l`](./reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md)\ - [`_ismbchira`, `_ismbchira_l`, `_ismbckata`, `_ismbckata_l`](./reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md)\ - [`_ismbclower`, `_ismbclower_l`, `_ismbcupper`, `_ismbcupper_l`](./reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md) - :::column-end::: -:::row-end::: +- [`_ismbcalnum`, `_ismbcalnum_l`, `_ismbcalpha`, `_ismbcalpha_l`, `_ismbcdigit`, `_ismbcdigit_l`](./reference/ismbcalnum-functions.md)\ +- [`_ismbcl0`, `_ismbcl0_l`, `_ismbcl1`, `_ismbcl1_l`, `_ismbcl2`, `_ismbcl2_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md)\ +- [`_ismbcgraph`, `_ismbcgraph_l`, `_ismbcprint`, `_ismbcprint_l`, `_ismbcpunct`, `_ismbcpunct_l`, `_ismbcblank`, `_ismbcblank_l`, `_ismbcspace`, `_ismbcspace_l`](./reference/ismbcgraph-functions.md)\ +- [`_ismbclegal`, `_ismbclegal_l`, `_ismbcsymbol`, `_ismbcsymbol_l`](./reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md)\ +- [`_ismbchira`, `_ismbchira_l`, `_ismbckata`, `_ismbckata_l`](./reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md)\ +- [`_ismbclower`, `_ismbclower_l`, `_ismbcupper`, `_ismbcupper_l`](./reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md) ## Remarks @@ -30,32 +26,32 @@ The test result of each `_ismbc` routine depends on the multibyte code page in e The output value is affected by the `LC_CTYPE` category setting of the locale. For more information, see [`setlocale`](./reference/setlocale-wsetlocale.md). The versions of these functions without the `_l` suffix use the current locale for this locale-dependent behavior; the versions with the `_l` suffix are identical except that they use the locale parameter passed in instead. -|Routine|Test condition|Code page 932 example| -|-------------|--------------------|---------------------------| -|[`_ismbcalnum`, `_ismbcalnum_l`](./reference/ismbcalnum-functions.md)|Alphanumeric|Returns nonzero if and only if `c` is a single-byte representation of an ASCII English letter: See examples for `_ismbcdigit` and `_ismbcalpha`.| -|[`_ismbcalpha`, `_ismbcalpha_l`](./reference/ismbcalnum-functions.md)|Alphabetic|Returns nonzero if and only if `c` is a single-byte representation of an ASCII English letter: See examples for `_ismbcupper` and `_ismbclower`; or a katakana letter: 0xA6<=`c`<=0xDF.| -|[`_ismbcdigit`, `_ismbcdigit_l`](./reference/ismbcalnum-functions.md)|Digit|Returns nonzero if and only if `c` is a single-byte representation of an ASCII digit: 0x30<=`c`<=0x39.| -|[`_ismbcgraph`, `_ismbcgraph_l`](./reference/ismbcgraph-functions.md)|Graphic|Returns nonzero if and only if `c` is a single-byte representation of any ASCII or katakana printable character except a white space ( ). See examples for `_ismbcdigit`, `_ismbcalpha`, and `_ismbcpunct`.| -|[`_ismbclegal`, `_ismbclegal_l`](./reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md)|Valid multibyte character|Returns nonzero if and only if the first byte of `c` is within ranges 0x81 - 0x9F or 0xE0 - 0xFC, while the second byte is within ranges 0x40 - 0x7E or 0x80 - FC.| -|[`_ismbclower`, `_ismbclower_l`](./reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md)|Lowercase alphabetic|Returns nonzero if and only if `c` is a single-byte representation of an ASCII lowercase English letter: 0x61<=`c`<=0x7A.| -|[`_ismbcprint`, `_ismbcprint_l`](./reference/ismbcgraph-functions.md)|Printable|Returns nonzero if and only if `c` is a single-byte representation of any ASCII or katakana printable character including a white space ( ): See examples for `_ismbcspace`, `_ismbcdigit`, `_ismbcalpha`, and `_ismbcpunct`.| -|[`_ismbcpunct`, `_ismbcpunct_l`](./reference/ismbcgraph-functions.md)|Punctuation|Returns nonzero if and only if `c` is a single-byte representation of any ASCII or katakana punctuation character.| -|[`_ismbcblank`, `_ismbcblank_l`](./reference/ismbcgraph-functions.md)|Space or horizontal tab|Returns nonzero if and only if `c` is a single-byte representation of a space character or a horizontal tab character: `c`=0x20 or `c`=0x09.| -|[`_ismbcspace`, `_ismbcspace_l`](./reference/ismbcgraph-functions.md)|Whitespace|Returns nonzero if and only if `c` is a white space character: `c`=0x20 or 0x09<=`c`<=0x0D.| -|[`_ismbcsymbol`, `_ismbcsymbol_l`](./reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md)|Multibyte symbol|Returns nonzero if and only if 0x8141<=`c`<=0x81AC.| -|[`_ismbcupper`, `_ismbcupper_l`](./reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md)|Uppercase alphabetic|Returns nonzero if and only if `c` is a single-byte representation of an ASCII uppercase English letter: 0x41<=`c`<=0x5A.| +| Routine | Test condition | Code page 932 example | +|---|---|---| +| [`_ismbcalnum`, `_ismbcalnum_l`](./reference/ismbcalnum-functions.md) | Alphanumeric | Returns nonzero if and only if `c` is a single-byte representation of an ASCII English letter: See examples for `_ismbcdigit` and `_ismbcalpha`. | +| [`_ismbcalpha`, `_ismbcalpha_l`](./reference/ismbcalnum-functions.md) | Alphabetic | Returns nonzero if and only if `c` is a single-byte representation of an ASCII English letter: See examples for `_ismbcupper` and `_ismbclower`; or a katakana letter: 0xA6<=`c`<=0xDF. | +| [`_ismbcdigit`, `_ismbcdigit_l`](./reference/ismbcalnum-functions.md) | Digit | Returns nonzero if and only if `c` is a single-byte representation of an ASCII digit: 0x30<=`c`<=0x39. | +| [`_ismbcgraph`, `_ismbcgraph_l`](./reference/ismbcgraph-functions.md) | Graphic | Returns nonzero if and only if `c` is a single-byte representation of any ASCII or katakana printable character except a white space ( ). See examples for `_ismbcdigit`, `_ismbcalpha`, and `_ismbcpunct`. | +| [`_ismbclegal`, `_ismbclegal_l`](./reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md) | Valid multibyte character | Returns nonzero if and only if the first byte of `c` is within ranges 0x81 - 0x9F or 0xE0 - 0xFC, while the second byte is within ranges 0x40 - 0x7E or 0x80 - FC. | +| [`_ismbclower`, `_ismbclower_l`](./reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md) | Lowercase alphabetic | Returns nonzero if and only if `c` is a single-byte representation of an ASCII lowercase English letter: 0x61<=`c`<=0x7A. | +| [`_ismbcprint`, `_ismbcprint_l`](./reference/ismbcgraph-functions.md) | Printable | Returns nonzero if and only if `c` is a single-byte representation of any ASCII or katakana printable character including a white space ( ): See examples for `_ismbcspace`, `_ismbcdigit`, `_ismbcalpha`, and `_ismbcpunct`. | +| [`_ismbcpunct`, `_ismbcpunct_l`](./reference/ismbcgraph-functions.md) | Punctuation | Returns nonzero if and only if `c` is a single-byte representation of any ASCII or katakana punctuation character. | +| [`_ismbcblank`, `_ismbcblank_l`](./reference/ismbcgraph-functions.md) | Space or horizontal tab | Returns nonzero if and only if `c` is a single-byte representation of a space character or a horizontal tab character: `c`=0x20 or `c`=0x09. | +| [`_ismbcspace`, `_ismbcspace_l`](./reference/ismbcgraph-functions.md) | Whitespace | Returns nonzero if and only if `c` is a white space character: `c`=0x20 or 0x09<=`c`<=0x0D. | +| [`_ismbcsymbol`, `_ismbcsymbol_l`](./reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md) | Multibyte symbol | Returns nonzero if and only if 0x8141<=`c`<=0x81AC. | +| [`_ismbcupper`, `_ismbcupper_l`](./reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md) | Uppercase alphabetic | Returns nonzero if and only if `c` is a single-byte representation of an ASCII uppercase English letter: 0x41<=`c`<=0x5A. | **Code Page 932 Specific** The following routines are specific to code page 932. -|Routine|Test condition (code page 932 only)| -|-------------|-------------------------------------------| -|[`_ismbchira`, `_ismbchira_l`](./reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md)|Double-byte Hiragana: 0x829F<=`c`<=0x82F1.| -|[`_ismbckata`, `_ismbckata_l`](./reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md)|Double-byte katakana: 0x8340<=`c`<=0x8396.| -|[`_ismbcl0`, `_ismbcl0_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md)|JIS non-Kanji: 0x8140<=`c`<=0x889E.| -|[`_ismbcl1`, `_ismbcl1_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md)|JIS level-1: 0x889F<=`c`<=0x9872.| -|[`_ismbcl2`, `_ismbcl2_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md)|JIS level-2: 0x989F<=`c`<=0xEA9E.| +| Routine | Test condition (code page 932 only) | +|---|---| +| [`_ismbchira`, `_ismbchira_l`](./reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md) | Double-byte Hiragana: 0x829F<=`c`<=0x82F1. | +| [`_ismbckata`, `_ismbckata_l`](./reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md) | Double-byte katakana: 0x8340<=`c`<=0x8396. | +| [`_ismbcl0`, `_ismbcl0_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md) | JIS non-Kanji: 0x8140<=`c`<=0x889E. | +| [`_ismbcl1`, `_ismbcl1_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md) | JIS level-1: 0x889F<=`c`<=0x9872. | +| [`_ismbcl2`, `_ismbcl2_l`](./reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md) | JIS level-2: 0x989F<=`c`<=0xEA9E. | `_ismbcl0`, `_ismbcl1`, and `_ismbcl2` check that the specified value `c` matches the test conditions described in the preceding table, but don't check that `c` is a valid multibyte character. If the lower byte is in the ranges 0x00 - 0x3F, 0x7F, or 0xFD - 0xFF, these functions return a nonzero value, indicating that the character satisfies the test condition. Use [`_ismbbtrail`, `_ismbbtrail_l`](./reference/ismbbtrail-ismbbtrail-l.md) to test whether the multibyte character is defined. diff --git a/docs/c-runtime-library/language-strings.md b/docs/c-runtime-library/language-strings.md index 9e4d1c6115d..c68c721c29e 100644 --- a/docs/c-runtime-library/language-strings.md +++ b/docs/c-runtime-library/language-strings.md @@ -12,73 +12,73 @@ The [`setlocale`](./reference/setlocale-wsetlocale.md) and [`_create_locale`](./ The Microsoft C run-time library implementation also supports these language strings: -|Language string|Equivalent Locale Name| -|---------------------|----------------------------| -|`american`|`en-US`| -|`american english`|`en-US`| -|`american-english`|`en-US`| -|`australian`|`en-AU`| -|`belgian`|`nl-BE`| -|`canadian`|`en-CA`| -|`chh`|`zh-HK`| -|`chi`|`zh-SG`| -|`chinese`|`zh`| -|`chinese-hongkong`|`zh-HK`| -|`chinese-simplified`|`zh-CN`| -|`chinese-singapore`|`zh-SG`| -|`chinese-traditional`|`zh-TW`| -|`dutch-belgian`|`nl-BE`| -|`english-american`|`en-US`| -|`english-aus`|`en-AU`| -|`english-belize`|`en-BZ`| -|`english-can`|`en-CA`| -|`english-caribbean`|`en-029`| -|`english-ire`|`en-IE`| -|`english-jamaica`|`en-JM`| -|`english-nz`|`en-NZ`| -|`english-south africa`|`en-ZA`| -|`english-trinidad y tobago`|`en-TT`| -|`english-uk`|`en-GB`| -|`english-us`|`en-US`| -|`english-usa`|`en-US`| -|`french-belgian`|`fr-BE`| -|`french-canadian`|`fr-CA`| -|`french-luxembourg`|`fr-LU`| -|`french-swiss`|`fr-CH`| -|`german-austrian`|`de-AT`| -|`german-lichtenstein`|`de-LI`| -|`german-luxembourg`|`de-LU`| -|`german-swiss`|`de-CH`| -|`irish-english`|`en-IE`| -|`italian-swiss`|`it-CH`| -|`norwegian`|`no`| -|`norwegian-bokmal`|`nb-NO`| -|`norwegian-nynorsk`|`nn-NO`| -|`portuguese-brazilian`|`pt-BR`| -|`spanish-argentina`|`es-AR`| -|`spanish-bolivia`|`es-BO`| -|`spanish-chile`|`es-CL`| -|`spanish-colombia`|`es-CO`| -|`spanish-costa rica`|`es-CR`| -|`spanish-dominican republic`|`es-DO`| -|`spanish-ecuador`|`es-EC`| -|`spanish-el salvador`|`es-SV`| -|`spanish-guatemala`|`es-GT`| -|`spanish-honduras`|`es-HN`| -|`spanish-mexican`|`es-MX`| -|`spanish-modern`|`es-ES`| -|`spanish-nicaragua`|`es-NI`| -|`spanish-panama`|`es-PA`| -|`spanish-paraguay`|`es-PY`| -|`spanish-peru`|`es-PE`| -|`spanish-puerto rico`|`es-PR`| -|`spanish-uruguay`|`es-UY`| -|`spanish-venezuela`|`es-VE`| -|`swedish-finland`|`sv-FI`| -|`swiss`|`de-CH`| -|`uk`|`en-GB`| -|`us`|`en-US`| -|`usa`|`en-US`| +| Language string | Equivalent Locale Name | +|---|---| +| `american` | `en-US` | +| `american english` | `en-US` | +| `american-english` | `en-US` | +| `australian` | `en-AU` | +| `belgian` | `nl-BE` | +| `canadian` | `en-CA` | +| `chh` | `zh-HK` | +| `chi` | `zh-SG` | +| `chinese` | `zh` | +| `chinese-hongkong` | `zh-HK` | +| `chinese-simplified` | `zh-CN` | +| `chinese-singapore` | `zh-SG` | +| `chinese-traditional` | `zh-TW` | +| `dutch-belgian` | `nl-BE` | +| `english-american` | `en-US` | +| `english-aus` | `en-AU` | +| `english-belize` | `en-BZ` | +| `english-can` | `en-CA` | +| `english-caribbean` | `en-029` | +| `english-ire` | `en-IE` | +| `english-jamaica` | `en-JM` | +| `english-nz` | `en-NZ` | +| `english-south africa` | `en-ZA` | +| `english-trinidad y tobago` | `en-TT` | +| `english-uk` | `en-GB` | +| `english-us` | `en-US` | +| `english-usa` | `en-US` | +| `french-belgian` | `fr-BE` | +| `french-canadian` | `fr-CA` | +| `french-luxembourg` | `fr-LU` | +| `french-swiss` | `fr-CH` | +| `german-austrian` | `de-AT` | +| `german-lichtenstein` | `de-LI` | +| `german-luxembourg` | `de-LU` | +| `german-swiss` | `de-CH` | +| `irish-english` | `en-IE` | +| `italian-swiss` | `it-CH` | +| `norwegian` | `no` | +| `norwegian-bokmal` | `nb-NO` | +| `norwegian-nynorsk` | `nn-NO` | +| `portuguese-brazilian` | `pt-BR` | +| `spanish-argentina` | `es-AR` | +| `spanish-bolivia` | `es-BO` | +| `spanish-chile` | `es-CL` | +| `spanish-colombia` | `es-CO` | +| `spanish-costa rica` | `es-CR` | +| `spanish-dominican republic` | `es-DO` | +| `spanish-ecuador` | `es-EC` | +| `spanish-el salvador` | `es-SV` | +| `spanish-guatemala` | `es-GT` | +| `spanish-honduras` | `es-HN` | +| `spanish-mexican` | `es-MX` | +| `spanish-modern` | `es-ES` | +| `spanish-nicaragua` | `es-NI` | +| `spanish-panama` | `es-PA` | +| `spanish-paraguay` | `es-PY` | +| `spanish-peru` | `es-PE` | +| `spanish-puerto rico` | `es-PR` | +| `spanish-uruguay` | `es-UY` | +| `spanish-venezuela` | `es-VE` | +| `swedish-finland` | `sv-FI` | +| `swiss` | `de-CH` | +| `uk` | `en-GB` | +| `us` | `en-US` | +| `usa` | `en-US` | ## See also diff --git a/docs/c-runtime-library/lc-codepage-func.md b/docs/c-runtime-library/lc-codepage-func.md index 04caa3171c0..bd8002e5313 100644 --- a/docs/c-runtime-library/lc-codepage-func.md +++ b/docs/c-runtime-library/lc-codepage-func.md @@ -26,7 +26,7 @@ The current code page of the thread. ## Remarks -`___lc_codepage_func` is an internal CRT function that is used by other CRT functions to get the current code page from the thread local storage for CRT data. This information is also available by using the [`_get_current_locale`](./reference/get-current-locale.md) function. +**`___lc_codepage_func`** is an internal CRT function that is used by other CRT functions to get the current code page from the thread local storage for CRT data. This information is also available by using the [`_get_current_locale`](./reference/get-current-locale.md) function. A *code page* is a mapping of single-byte or double-byte codes to individual characters. Different code pages include different special characters, typically customized for a language or a group of languages. For more information about code pages, see [Code pages](./code-pages.md). @@ -36,9 +36,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`___lc_codepage_func`|crt\src\setlocal.h| +| Routine | Required header | +|---|---| +| **`___lc_codepage_func`** | `crt\src\setlocal.h` | ## See also diff --git a/docs/c-runtime-library/lc-collate-cp-func.md b/docs/c-runtime-library/lc-collate-cp-func.md index f6383e43a73..df355eb8e89 100644 --- a/docs/c-runtime-library/lc-collate-cp-func.md +++ b/docs/c-runtime-library/lc-collate-cp-func.md @@ -26,7 +26,7 @@ The current collation code page of the thread. ## Remarks -`___lc_collate_cp_func` is an internal CRT function that is used by other CRT functions to get the current collation code page from the thread local storage for CRT data. This information is also available by using the [`_get_current_locale`](./reference/get-current-locale.md) function. +**`___lc_collate_cp_func`** is an internal CRT function that is used by other CRT functions to get the current collation code page from the thread local storage for CRT data. This information is also available by using the [`_get_current_locale`](./reference/get-current-locale.md) function. Internal CRT functions are implementation-specific and subject to change with each release. We don't recommend their use in your code. @@ -34,9 +34,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`___lc_collate_cp_func`|crt\src\setlocal.h| +| Routine | Required header | +|---|---| +| **`___lc_collate_cp_func`** | crt\src\setlocal.h | ## See also diff --git a/docs/c-runtime-library/lc-locale-name-func.md b/docs/c-runtime-library/lc-locale-name-func.md index e6281428060..a2cd146168c 100644 --- a/docs/c-runtime-library/lc-locale-name-func.md +++ b/docs/c-runtime-library/lc-locale-name-func.md @@ -26,7 +26,7 @@ A pointer to a string that contains the current locale name of the thread. ## Remarks -`___lc_locale_name_func` is an internal CRT function that is used by other CRT functions to get the current locale name from the thread local storage for CRT data. This information is also available by using the [`_get_current_locale`](./reference/get-current-locale.md) function or the [`setlocale`, `_wsetlocale`](./reference/setlocale-wsetlocale.md) functions. +**`___lc_locale_name_func`** is an internal CRT function that is used by other CRT functions to get the current locale name from the thread local storage for CRT data. This information is also available by using the [`_get_current_locale`](./reference/get-current-locale.md) function or the [`setlocale`, `_wsetlocale`](./reference/setlocale-wsetlocale.md) functions. Internal CRT functions are implementation-specific and subject to change with each release. We don't recommend their use in your code. @@ -34,9 +34,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`___lc_locale_name_func`|crt\src\setlocal.h| +| Routine | Required header | +|---|---| +| **`___lc_locale_name_func`** | `crt\src\setlocal.h` | ## See also diff --git a/docs/c-runtime-library/link-options.md b/docs/c-runtime-library/link-options.md index f6dea668654..33a73b92deb 100644 --- a/docs/c-runtime-library/link-options.md +++ b/docs/c-runtime-library/link-options.md @@ -11,24 +11,24 @@ The CRT lib directory includes several small object files that enable specific C CLR pure mode versions of these objects are deprecated in Visual Studio 2015 and unsupported in Visual Studio 2017. Use the regular versions for native and /clr code. -|Native and /clr|Pure mode|Description| -|----------------------|---------------|-----------------| -|binmode.obj|pbinmode.obj|Sets the default file-translation mode to binary. See [`_fmode`](./fmode.md).| -|chkstk.obj|n/a|Provides stack-checking and alloca support when not using the CRT.| -|commode.obj|pcommode.obj|Sets the global commit flag to "commit". See [`fopen`, `_wfopen`](./reference/fopen-wfopen.md) and [`fopen_s`, `_wfopen_s`](./reference/fopen-s-wfopen-s.md).| -|exe_initialize_mta.lib|n/a|Initializes the MTA apartment during EXE startup, which allows the use of COM objects in global smart pointers. Because this option leaks an MTA apartment reference during shutdown, don't use it for DLLs. Linking to this file is equivalent to including `combase.h` and defining `_EXE_INITIALIZE_MTA`. Using this link option adds [onecore.lib](/windows/win32/apiindex/windows-umbrella-libraries) to the default library list. If this effect is undesirable (such as using onecore_apiset.lib or other umbrella library), use [/NODEFAULTLIB](../build/reference/nodefaultlib-ignore-libraries.md) to override this behavior and provide an alternative. | -|fp10.obj|n/a|Changes the default precision control to 64 bits. See [Math and floating-point support](./floating-point-support.md).| -|invalidcontinue.obj|pinvalidcontinue.obj|Sets a default invalid parameter handler that does nothing, meaning that invalid parameters passed to CRT functions will just set errno and return an error result.| -|legacy_stdio_float_rounding.obj|n/a|The printing of floating-point values (for example, when using [`printf`](./reference/printf-printf-l-wprintf-wprintf-l.md)) with the Windows 10 19041 Universal C Runtime has been fixed. It now properly rounds exactly representable floating-point numbers, and respects the floating-point rounding requested by [`fesetround`](./reference/fegetround-fesetround2.md). This behavior update is available in Visual Studio 2019 version 16.2 and later. Legacy behavior is used in earlier versions of Visual Studio, or by providing this link option.| -|loosefpmath.obj|n/a|Ensures that floating point code tolerates denormal values.| -|newmode.obj|pnewmode.obj|Causes [`malloc`](./reference/malloc.md) to call the new handler on failure. See [`_set_new_mode`](./reference/set-new-mode.md), [`_set_new_handler`](./reference/set-new-handler.md), [`calloc`](./reference/calloc.md), and [`realloc`](./reference/realloc.md).| -|noarg.obj|pnoarg.obj|Disables all processing of argc and argv.| -|nochkclr.obj|n/a|Does nothing. Remove from your project.| -|noenv.obj|pnoenv.obj|Disables the creation of a cached environment for the CRT.| -|nothrownew.obj|pnothrownew.obj|Enables the non-throwing version of new in the CRT. See [new and delete Operators](../cpp/new-and-delete-operators.md).| -|setargv.obj|psetargv.obj|Enables command-line argument wildcard expansion. See [Expanding wildcard arguments](../c-language/expanding-wildcard-arguments.md).| -|threadlocale.obj|pthreadlocale.obj|Enables per-thread locale for all new threads by default.| -|wsetargv.obj|pwsetargv.obj|Enables command-line argument wildcard expansion. See [Expanding wildcard arguments](../c-language/expanding-wildcard-arguments.md).| +| Native and /clr | Pure mode | Description | +|---|---|---| +| `binmode.obj` | `pbinmode.obj` | Sets the default file-translation mode to binary. See [`_fmode`](./fmode.md). | +| `chkstk.obj` | n/a | Provides stack-checking and alloca support when not using the CRT. | +| `commode.obj` | `pcommode.obj` | Sets the global commit flag to "commit". See [`fopen`, `_wfopen`](./reference/fopen-wfopen.md) and [`fopen_s`, `_wfopen_s`](./reference/fopen-s-wfopen-s.md). | +| exe_initialize_mta.lib | n/a | Initializes the MTA apartment during EXE startup, which allows the use of COM objects in global smart pointers. Because this option leaks an MTA apartment reference during shutdown, don't use it for DLLs. Linking to this file is equivalent to including `combase.h` and defining `_EXE_INITIALIZE_MTA`. Using this link option adds [onecore.lib](/windows/win32/apiindex/windows-umbrella-libraries) to the default library list. If this effect is undesirable (such as using onecore_apiset.lib or other umbrella library), use [/NODEFAULTLIB](../build/reference/nodefaultlib-ignore-libraries.md) to override this behavior and provide an alternative. | +| `fp10.obj` | n/a | Changes the default precision control to 64 bits. See [Math and floating-point support](./floating-point-support.md). | +| `invalidcontinue.obj` | `pinvalidcontinue.obj` | Sets a default invalid parameter handler that does nothing, meaning that invalid parameters passed to CRT functions will just set errno and return an error result. | +| `legacy_stdio_float_rounding.obj` | n/a | The printing of floating-point values (for example, when using [`printf`](./reference/printf-printf-l-wprintf-wprintf-l.md)) with the Windows 10 19041 Universal C Runtime has been fixed. It now properly rounds exactly representable floating-point numbers, and respects the floating-point rounding requested by [`fesetround`](./reference/fegetround-fesetround2.md). This behavior update is available in Visual Studio 2019 version 16.2 and later. Legacy behavior is used in earlier versions of Visual Studio, or by providing this link option. | +| `loosefpmath.obj` | n/a | Ensures that floating point code tolerates denormal values. | +| `newmode.obj` | `pnewmode.obj` | Causes [`malloc`](./reference/malloc.md) to call the new handler on failure. See [`_set_new_mode`](./reference/set-new-mode.md), [`_set_new_handler`](./reference/set-new-handler.md), [`calloc`](./reference/calloc.md), and [`realloc`](./reference/realloc.md). | +| `noarg.obj` | `pnoarg.obj` | Disables all processing of argc and argv. | +| `nochkclr.obj` | n/a | Does nothing. Remove from your project. | +| `noenv.obj` | `pnoenv.obj` | Disables the creation of a cached environment for the CRT. | +| `nothrownew.obj` | `pnothrownew.obj` | Enables the non-throwing version of new in the CRT. See [new and delete Operators](../cpp/new-and-delete-operators.md). | +| `setargv.obj` | `psetargv.obj` | Enables command-line argument wildcard expansion. See [Expanding wildcard arguments](../c-language/expanding-wildcard-arguments.md). | +| `threadlocale.obj` | `pthreadlocale.obj` | Enables per-thread locale for all new threads by default. | +| `wsetargv.obj` | `pwsetargv.obj` | Enables command-line argument wildcard expansion. See [Expanding wildcard arguments](../c-language/expanding-wildcard-arguments.md). | ## See also diff --git a/docs/c-runtime-library/locale-categories.md b/docs/c-runtime-library/locale-categories.md index 46793a12d40..dde72bbca3c 100644 --- a/docs/c-runtime-library/locale-categories.md +++ b/docs/c-runtime-library/locale-categories.md @@ -10,7 +10,7 @@ ms.assetid: 868f1493-fe5d-4722-acab-bfcd374a063a ## Syntax -``` +```C #include ``` @@ -18,16 +18,16 @@ ms.assetid: 868f1493-fe5d-4722-acab-bfcd374a063a Locale categories are manifest constants used by the localization routines to specify which portion of a program's locale information will be used. The locale refers to the locality (or Country/Region) for which certain aspects of your program can be customized. Locale-dependent areas include, for example, the formatting of dates or the display format for monetary values. -|Locale category|Parts of program affected| -|---------------------|-------------------------------| -|`LC_ALL`|All locale-specific behavior (all categories)| -|`LC_COLLATE`|Behavior of `strcoll` and `strxfrm` functions| -|`LC_CTYPE`|Behavior of character-handling functions (except `isdigit`, `isxdigit`, `mbstowcs`, and `mbtowc`, which are unaffected)| -|`LC_MAX`|Same as `LC_TIME`| -|`LC_MIN`|Same as `LC_ALL`| -|`LC_MONETARY`|Monetary formatting information returned by the `localeconv` function| -|`LC_NUMERIC`|Decimal-point character for formatted output routines (for example, `printf`), data conversion routines, and nonmonetary formatting information returned by `localeconv` function| -|`LC_TIME`|Behavior of `strftime` function| +| Locale category | Parts of program affected | +|---|---| +| `LC_ALL` | All locale-specific behavior (all categories) | +| `LC_COLLATE` | Behavior of `strcoll` and `strxfrm` functions | +| `LC_CTYPE` | Behavior of character-handling functions (except `isdigit`, `isxdigit`, `mbstowcs`, and `mbtowc`, which are unaffected) | +| `LC_MAX` | Same as `LC_TIME` | +| `LC_MIN` | Same as `LC_ALL` | +| `LC_MONETARY` | Monetary formatting information returned by the `localeconv` function | +| `LC_NUMERIC` | Decimal-point character for formatted output routines (for example, `printf`), data conversion routines, and nonmonetary formatting information returned by `localeconv` function | +| `LC_TIME` | Behavior of `strftime` function | See [`setlocale`, `_wsetlocale`](./reference/setlocale-wsetlocale.md) for an example. diff --git a/docs/c-runtime-library/locale.md b/docs/c-runtime-library/locale.md index bdb8539ff77..b5fedfce2d0 100644 --- a/docs/c-runtime-library/locale.md +++ b/docs/c-runtime-library/locale.md @@ -17,42 +17,42 @@ More secure versions of the functions in the following table are available, indi ## Locale-dependent routines -|Routine|Use|**`setlocale`** category setting dependence| -|-------------|---------|---------------------------------------------| -|[`atof`, `_atof_l`, `_wtof`, `_wtof_l`](./reference/atof-atof-l-wtof-wtof-l.md)|Convert character to floating-point value|`LC_NUMERIC`| -|[`atoi`, `_atoi_l`, `_wtoi`, `_wtoi_l`](./reference/atoi-atoi-l-wtoi-wtoi-l.md)|Convert character to integer value|`LC_NUMERIC`| -|[`_atoi64`, `_atoi64_l`, `_wtoi64`, `_wtoi64_l`](./reference/atoi64-atoi64-l-wtoi64-wtoi64-l.md)|Convert character to 64-bit integer value|`LC_NUMERIC`| -|[`atol`, `_atol_l`, `_wtol`, `_wtol_l`](./reference/atol-atol-l-wtol-wtol-l.md)|Convert character to long value|`LC_NUMERIC`| -|[`_atodbl`, `_atodbl_l`, `_atoldbl`, `_atoldbl_l`, `_atoflt`, `_atoflt_l`](./reference/atodbl-atodbl-l-atoldbl-atoldbl-l-atoflt-atoflt-l.md)|Convert character to double-long value|`LC_NUMERIC`| -|[`is`, `isw` routines](./is-isw-routines.md)|Test given integer for particular condition.|`LC_CTYPE`| -|[`isleadbyte`, `_isleadbyte_l`](./reference/isleadbyte-isleadbyte-l.md)|Test for lead byte|`LC_CTYPE`| -|[`localeconv`](./reference/localeconv.md)|Read appropriate values for formatting numeric quantities|`LC_MONETARY, LC_NUMERIC`| -|[`MB_CUR_MAX`](./mb-cur-max.md)|Maximum length in bytes of any multibyte character in current locale (macro defined in `STDLIB.H`)|`LC_CTYPE`| -|[`_mbccpy`, `_mbccpy_l`](./reference/mbccpy-mbccpy-l.md),[`_mbccpy_s`, `_mbccpy_s_l`](./reference/mbccpy-s-mbccpy-s-l.md)|Copy one multibyte character|`LC_CTYPE`| -|[`_mbclen`, `mblen`, `_mblen_l`](./reference/mbclen-mblen-mblen-l.md)|Validate and return number of bytes in multibyte character|`LC_CTYPE`| -|[`strlen`, `wcslen`, `_mbslen`, `_mbslen_l`, `_mbstrlen`, `_mbstrlen_l`](./reference/strlen-wcslen-mbslen-mbslen-l-mbstrlen-mbstrlen-l.md)|For multibyte-character strings: validate each character in string; return string length|`LC_CTYPE`| -|[`mbstowcs`, `_mbstowcs_l`](./reference/mbstowcs-mbstowcs-l.md),[`mbstowcs_s`, `_mbstowcs_s_l`](./reference/mbstowcs-s-mbstowcs-s-l.md)|Convert sequence of multibyte characters to corresponding sequence of wide characters|`LC_CTYPE`| -|[`mbtowc`, `_mbtowc_l`](./reference/mbtowc-mbtowc-l.md)|Convert multibyte character to corresponding wide character|`LC_CTYPE`| -|[`printf`](./reference/printf-printf-l-wprintf-wprintf-l.md) functions|Write formatted output|`LC_NUMERIC` (determines radix character output)| -|[`scanf`](./reference/scanf-scanf-l-wscanf-wscanf-l.md) functions|Read formatted input|`LC_NUMERIC` (determines radix character recognition)| -|[`setlocale`, `_wsetlocale`](./reference/setlocale-wsetlocale.md)|Select locale for program|Not applicable| -|[`strcoll`, `wcscoll`, `_mbscoll`, `_strcoll_l`, `_wcscoll_l`, `_mbscoll_l`](./reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md)|Compare characters of two strings|`LC_COLLATE`| -|[`_stricmp`, `_wcsicmp`, `_mbsicmp`, `_stricmp_l`, `_wcsicmp_l`, `_mbsicmp_l`](./reference/stricmp-wcsicmp-mbsicmp-stricmp-l-wcsicmp-l-mbsicmp-l.md)|Compare two strings without regard to case|`LC_CTYPE`| -|[`_stricoll`, `_wcsicoll`, `_mbsicoll`, `_stricoll_l`, `_wcsicoll_l`, `_mbsicoll_l`](./reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md)|Compare characters of two strings (case insensitive)|`LC_COLLATE`| -|[`_strncoll`, `_wcsncoll`, `_mbsncoll`, `_strncoll_l`, `_wcsncoll_l`, `_mbsncoll_l`](./reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md)|Compare first **`n`** characters of two strings|`LC_COLLATE`| -|[`_strnicmp`, `_wcsnicmp`, `_mbsnicmp`, `_strnicmp_l`, `_wcsnicmp_l`, `_mbsnicmp_l`](./reference/strnicmp-wcsnicmp-mbsnicmp-strnicmp-l-wcsnicmp-l-mbsnicmp-l.md)|Compare characters of two strings without regard to case.|`LC_CTYPE`| -|[`_strnicoll`, `_wcsnicoll`, `_mbsnicoll`, `_strnicoll_l`, `_wcsnicoll_l`, `_mbsnicoll_l`](./reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md)|Compare first **`n`** characters of two strings (case insensitive)|`LC_COLLATE`| -|[`strftime`, `wcsftime`, `_strftime_l`, `_wcsftime_l`](./reference/strftime-wcsftime-strftime-l-wcsftime-l.md)|Format date and time value according to supplied **`format`** argument|`LC_TIME`| -|[`_strlwr`, `_wcslwr`, `_mbslwr`, `_strlwr_l`, `_wcslwr_l`, `_mbslwr_l`](./reference/strlwr-wcslwr-mbslwr-strlwr-l-wcslwr-l-mbslwr-l.md),[`_strlwr_s`, `_strlwr_s_l`, `_mbslwr_s`, `_mbslwr_s_l`, `_wcslwr_s`, `_wcslwr_s_l`](./reference/strlwr-s-strlwr-s-l-mbslwr-s-mbslwr-s-l-wcslwr-s-wcslwr-s-l.md)|Convert, in place, each uppercase letter in given string to lowercase|`LC_CTYPE`| -|[`strtod`, `_strtod_l`, `wcstod`, `_wcstod_l`](./reference/strtod-strtod-l-wcstod-wcstod-l.md)|Convert character string to **`double`** value|`LC_NUMERIC` (determines radix character recognition)| -|[`strtol`, `wcstol`, `_strtol_l`, `_wcstol_l`](./reference/strtol-wcstol-strtol-l-wcstol-l.md)|Convert character string to **`long`** value|`LC_NUMERIC` (determines radix character recognition)| -|[`strtoul`, `_strtoul_l`, `wcstoul`, `_wcstoul_l`](./reference/strtoul-strtoul-l-wcstoul-wcstoul-l.md)|Convert character string to unsigned long value|`LC_NUMERIC` (determines radix character recognition)| -|[`_strupr`, `_strupr_l`, `_mbsupr`, `_mbsupr_l`, `_wcsupr_l`, `_wcsupr`](./reference/strupr-strupr-l-mbsupr-mbsupr-l-wcsupr-l-wcsupr.md),[`_strupr_s`, `_strupr_s_l`, `_mbsupr_s`, `_mbsupr_s_l`, `_wcsupr_s`, `_wcsupr_s_l`](./reference/strupr-s-strupr-s-l-mbsupr-s-mbsupr-s-l-wcsupr-s-wcsupr-s-l.md)|Convert, in place, each lowercase letter in string to uppercase|`LC_CTYPE`| -|[`strxfrm`, `wcsxfrm`, `_strxfrm_l`, `_wcsxfrm_l`](./reference/strxfrm-wcsxfrm-strxfrm-l-wcsxfrm-l.md)|Transform string into collated form according to locale|`LC_COLLATE`| -|[`tolower`, `_tolower`, `towlower`, `_tolower_l`, `_towlower_l`](./reference/tolower-tolower-towlower-tolower-l-towlower-l.md),[`_mbctolower`, `_mbctolower_l`, `_mbctoupper`, `_mbctoupper_l`](./reference/mbctolower-mbctolower-l-mbctoupper-mbctoupper-l.md)|Convert given character to corresponding lowercase character|`LC_CTYPE`| -|[`toupper`, `_toupper`, `towupper`, `_toupper_l`, `_towupper_l`](./reference/toupper-toupper-towupper-toupper-l-towupper-l.md),[`_mbctolower`, `_mbctolower_l`, `_mbctoupper`, `_mbctoupper_l`](./reference/mbctolower-mbctolower-l-mbctoupper-mbctoupper-l.md)|Convert given character to corresponding uppercase letter|`LC_CTYPE`| -|[`wcstombs`, `_wcstombs_l`](./reference/wcstombs-wcstombs-l.md),[`wcstombs_s`, `_wcstombs_s_l`](./reference/wcstombs-s-wcstombs-s-l.md)|Convert sequence of wide characters to corresponding sequence of multibyte characters|`LC_CTYPE`| -|[`wctomb`, `_wctomb_l`](./reference/wctomb-wctomb-l.md),[`wctomb_s`, `_wctomb_s_l`](./reference/wctomb-s-wctomb-s-l.md)|Convert wide character to corresponding multibyte character|`LC_CTYPE`| +| Routine | Use | **`setlocale`** category setting dependence | +|---|---|---| +| [`atof`, `_atof_l`, `_wtof`, `_wtof_l`](./reference/atof-atof-l-wtof-wtof-l.md) | Convert character to floating-point value | `LC_NUMERIC` | +| [`atoi`, `_atoi_l`, `_wtoi`, `_wtoi_l`](./reference/atoi-atoi-l-wtoi-wtoi-l.md) | Convert character to integer value | `LC_NUMERIC` | +| [`_atoi64`, `_atoi64_l`, `_wtoi64`, `_wtoi64_l`](./reference/atoi64-atoi64-l-wtoi64-wtoi64-l.md) | Convert character to 64-bit integer value | `LC_NUMERIC` | +| [`atol`, `_atol_l`, `_wtol`, `_wtol_l`](./reference/atol-atol-l-wtol-wtol-l.md) | Convert character to long value | `LC_NUMERIC` | +| [`_atodbl`, `_atodbl_l`, `_atoldbl`, `_atoldbl_l`, `_atoflt`, `_atoflt_l`](./reference/atodbl-atodbl-l-atoldbl-atoldbl-l-atoflt-atoflt-l.md) | Convert character to double-long value | `LC_NUMERIC` | +| [`is`, `isw` routines](./is-isw-routines.md) | Test given integer for particular condition. | `LC_CTYPE` | +| [`isleadbyte`, `_isleadbyte_l`](./reference/isleadbyte-isleadbyte-l.md) | Test for lead byte | `LC_CTYPE` | +| [`localeconv`](./reference/localeconv.md) | Read appropriate values for formatting numeric quantities | `LC_MONETARY, LC_NUMERIC` | +| [`MB_CUR_MAX`](./mb-cur-max.md) | Maximum length in bytes of any multibyte character in current locale (macro defined in `STDLIB.H`) | `LC_CTYPE` | +| [`_mbccpy`, `_mbccpy_l`](./reference/mbccpy-mbccpy-l.md),[`_mbccpy_s`, `_mbccpy_s_l`](./reference/mbccpy-s-mbccpy-s-l.md) | Copy one multibyte character | `LC_CTYPE` | +| [`_mbclen`, `mblen`, `_mblen_l`](./reference/mbclen-mblen-mblen-l.md) | Validate and return number of bytes in multibyte character | `LC_CTYPE` | +| [`strlen`, `wcslen`, `_mbslen`, `_mbslen_l`, `_mbstrlen`, `_mbstrlen_l`](./reference/strlen-wcslen-mbslen-mbslen-l-mbstrlen-mbstrlen-l.md) | For multibyte-character strings: validate each character in string; return string length | `LC_CTYPE` | +| [`mbstowcs`, `_mbstowcs_l`](./reference/mbstowcs-mbstowcs-l.md),[`mbstowcs_s`, `_mbstowcs_s_l`](./reference/mbstowcs-s-mbstowcs-s-l.md) | Convert sequence of multibyte characters to corresponding sequence of wide characters | `LC_CTYPE` | +| [`mbtowc`, `_mbtowc_l`](./reference/mbtowc-mbtowc-l.md) | Convert multibyte character to corresponding wide character | `LC_CTYPE` | +| [`printf`](./reference/printf-printf-l-wprintf-wprintf-l.md) functions | Write formatted output | `LC_NUMERIC` (determines radix character output) | +| [`scanf`](./reference/scanf-scanf-l-wscanf-wscanf-l.md) functions | Read formatted input | `LC_NUMERIC` (determines radix character recognition) | +| [`setlocale`, `_wsetlocale`](./reference/setlocale-wsetlocale.md) | Select locale for program | Not applicable | +| [`strcoll`, `wcscoll`, `_mbscoll`, `_strcoll_l`, `_wcscoll_l`, `_mbscoll_l`](./reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md) | Compare characters of two strings | `LC_COLLATE` | +| [`_stricmp`, `_wcsicmp`, `_mbsicmp`, `_stricmp_l`, `_wcsicmp_l`, `_mbsicmp_l`](./reference/stricmp-wcsicmp-mbsicmp-stricmp-l-wcsicmp-l-mbsicmp-l.md) | Compare two strings without regard to case | `LC_CTYPE` | +| [`_stricoll`, `_wcsicoll`, `_mbsicoll`, `_stricoll_l`, `_wcsicoll_l`, `_mbsicoll_l`](./reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md) | Compare characters of two strings (case insensitive) | `LC_COLLATE` | +| [`_strncoll`, `_wcsncoll`, `_mbsncoll`, `_strncoll_l`, `_wcsncoll_l`, `_mbsncoll_l`](./reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md) | Compare first **`n`** characters of two strings | `LC_COLLATE` | +| [`_strnicmp`, `_wcsnicmp`, `_mbsnicmp`, `_strnicmp_l`, `_wcsnicmp_l`, `_mbsnicmp_l`](./reference/strnicmp-wcsnicmp-mbsnicmp-strnicmp-l-wcsnicmp-l-mbsnicmp-l.md) | Compare characters of two strings without regard to case. | `LC_CTYPE` | +| [`_strnicoll`, `_wcsnicoll`, `_mbsnicoll`, `_strnicoll_l`, `_wcsnicoll_l`, `_mbsnicoll_l`](./reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md) | Compare first **`n`** characters of two strings (case insensitive) | `LC_COLLATE` | +| [`strftime`, `wcsftime`, `_strftime_l`, `_wcsftime_l`](./reference/strftime-wcsftime-strftime-l-wcsftime-l.md) | Format date and time value according to supplied **`format`** argument | `LC_TIME` | +| [`_strlwr`, `_wcslwr`, `_mbslwr`, `_strlwr_l`, `_wcslwr_l`, `_mbslwr_l`](./reference/strlwr-wcslwr-mbslwr-strlwr-l-wcslwr-l-mbslwr-l.md),[`_strlwr_s`, `_strlwr_s_l`, `_mbslwr_s`, `_mbslwr_s_l`, `_wcslwr_s`, `_wcslwr_s_l`](./reference/strlwr-s-strlwr-s-l-mbslwr-s-mbslwr-s-l-wcslwr-s-wcslwr-s-l.md) | Convert, in place, each uppercase letter in given string to lowercase | `LC_CTYPE` | +| [`strtod`, `_strtod_l`, `wcstod`, `_wcstod_l`](./reference/strtod-strtod-l-wcstod-wcstod-l.md) | Convert character string to **`double`** value | `LC_NUMERIC` (determines radix character recognition) | +| [`strtol`, `wcstol`, `_strtol_l`, `_wcstol_l`](./reference/strtol-wcstol-strtol-l-wcstol-l.md) | Convert character string to **`long`** value | `LC_NUMERIC` (determines radix character recognition) | +| [`strtoul`, `_strtoul_l`, `wcstoul`, `_wcstoul_l`](./reference/strtoul-strtoul-l-wcstoul-wcstoul-l.md) | Convert character string to unsigned long value | `LC_NUMERIC` (determines radix character recognition) | +| [`_strupr`, `_strupr_l`, `_mbsupr`, `_mbsupr_l`, `_wcsupr_l`, `_wcsupr`](./reference/strupr-strupr-l-mbsupr-mbsupr-l-wcsupr-l-wcsupr.md),[`_strupr_s`, `_strupr_s_l`, `_mbsupr_s`, `_mbsupr_s_l`, `_wcsupr_s`, `_wcsupr_s_l`](./reference/strupr-s-strupr-s-l-mbsupr-s-mbsupr-s-l-wcsupr-s-wcsupr-s-l.md) | Convert, in place, each lowercase letter in string to uppercase | `LC_CTYPE` | +| [`strxfrm`, `wcsxfrm`, `_strxfrm_l`, `_wcsxfrm_l`](./reference/strxfrm-wcsxfrm-strxfrm-l-wcsxfrm-l.md) | Transform string into collated form according to locale | `LC_COLLATE` | +| [`tolower`, `_tolower`, `towlower`, `_tolower_l`, `_towlower_l`](./reference/tolower-tolower-towlower-tolower-l-towlower-l.md),[`_mbctolower`, `_mbctolower_l`, `_mbctoupper`, `_mbctoupper_l`](./reference/mbctolower-mbctolower-l-mbctoupper-mbctoupper-l.md) | Convert given character to corresponding lowercase character | `LC_CTYPE` | +| [`toupper`, `_toupper`, `towupper`, `_toupper_l`, `_towupper_l`](./reference/toupper-toupper-towupper-toupper-l-towupper-l.md),[`_mbctolower`, `_mbctolower_l`, `_mbctoupper`, `_mbctoupper_l`](./reference/mbctolower-mbctolower-l-mbctoupper-mbctoupper-l.md) | Convert given character to corresponding uppercase letter | `LC_CTYPE` | +| [`wcstombs`, `_wcstombs_l`](./reference/wcstombs-wcstombs-l.md),[`wcstombs_s`, `_wcstombs_s_l`](./reference/wcstombs-s-wcstombs-s-l.md) | Convert sequence of wide characters to corresponding sequence of multibyte characters | `LC_CTYPE` | +| [`wctomb`, `_wctomb_l`](./reference/wctomb-wctomb-l.md),[`wctomb_s`, `_wctomb_s_l`](./reference/wctomb-s-wctomb-s-l.md) | Convert wide character to corresponding multibyte character | `LC_CTYPE` | > [!NOTE] > For multibyte routines, the multibyte code page must be equivalent to the locale set with [`setlocale`](./reference/setlocale-wsetlocale.md). [`_setmbcp`](./reference/setmbcp.md), with an argument of `_MB_CP_LOCALE` makes the multibyte code page the same as the **`setlocale`** code page. diff --git a/docs/c-runtime-library/locking-constants.md b/docs/c-runtime-library/locking-constants.md index 3aaf0a5f271..b6ccc86e45f 100644 --- a/docs/c-runtime-library/locking-constants.md +++ b/docs/c-runtime-library/locking-constants.md @@ -10,7 +10,7 @@ ms.assetid: c3dc92c8-60e3-4d29-9f50-5d217627c8ad ## Syntax -``` +```C #include ``` @@ -20,13 +20,13 @@ The *`mode`* argument in the call to the `_locking` function specifies the locki The *`mode`* argument must be one of the following manifest constants. -|Value|Description| -|-|-| -| `_LK_LOCK` | Locks the specified bytes. If the bytes can't be locked, the function tries again after 1 second. If the bytes can't be locked after 10 attempts, the function returns an error. | -| `_LK_RLCK` | Same as `_LK_LOCK`. | -|`_LK_NBLCK` | Locks the specified bytes. If bytes can't be locked, the function returns an error. | -| `_LK_NBRLCK` | Same as `_LK_NBLCK`. | -| `_LK_UNLCK` | Unlocks the specified bytes. (The bytes must have been previously locked.) | +| Value | Description | +|---|---| +| `_LK_LOCK` | Locks the specified bytes. If the bytes can't be locked, the function tries again after 1 second. If the bytes can't be locked after 10 attempts, the function returns an error. | +| `_LK_RLCK` | Same as `_LK_LOCK`. | +| `_LK_NBLCK` | Locks the specified bytes. If bytes can't be locked, the function returns an error. | +| `_LK_NBRLCK` | Same as `_LK_NBLCK`. | +| `_LK_UNLCK` | Unlocks the specified bytes. (The bytes must have been previously locked.) | ## See also diff --git a/docs/c-runtime-library/low-level-i-o.md b/docs/c-runtime-library/low-level-i-o.md index 27470ca9d2c..b08223be75f 100644 --- a/docs/c-runtime-library/low-level-i-o.md +++ b/docs/c-runtime-library/low-level-i-o.md @@ -10,33 +10,33 @@ These functions invoke the operating system directly for lower-level operation t Low-level routines can access the standard streams opened at program startup using the following predefined file descriptors. -|Stream|File Descriptor| -|------------|---------------------| -|**`stdin`**|0| -|**`stdout`**|1| -|**`stderr`**|2| +| Stream | File Descriptor | +|---|---| +| **`stdin`** | 0 | +| **`stdout`** | 1 | +| **`stderr`** | 2 | Low-level I/O routines set the [`errno`](./errno-doserrno-sys-errlist-and-sys-nerr.md) global variable when an error occurs. You must include `STDIO.H` when you use low-level functions only if your program requires a constant that is defined in `STDIO.H`, such as the end-of-file indicator (`EOF`). ## Low-level I/O functions -|Function|Use| -|--------------|---------| -|[`_close`](./reference/close.md)|Close file| -|[`_commit`](./reference/commit.md)|Flush file to disk| -|[`_creat`, `_wcreat`](./reference/creat-wcreat.md)|Create file| -|[`_dup`](./reference/dup-dup2.md)|Return next available file descriptor for given file| -|[`_dup2`](./reference/dup-dup2.md)|Create second descriptor for given file| -|[`_eof`](./reference/eof.md)|Test for end of file| -|[`_lseek`, `_lseeki64`](./reference/lseek-lseeki64.md)|Reposition file pointer to given location| -|[`_open`, `_wopen`](./reference/open-wopen.md)|Open file| -|[`_read`](./reference/read.md)|Read data from file| -|[`_sopen`, `_wsopen`](./reference/sopen-wsopen.md), [`_sopen_s`, `_wsopen_s`](./reference/sopen-s-wsopen-s.md)|Open file for file sharing| -|[`_tell`, `_telli64`](./reference/tell-telli64.md)|Get current file-pointer position| -|[`_umask`](./reference/umask.md), [`_umask_s`](./reference/umask-s.md)|Set file-permission mask| -|[`_write`](./reference/write.md)|Write data to file| - -**`_dup`** and **`_dup2`** are typically used to associate the predefined file descriptors with different files. +| Function | Use | +|---|---| +| [`_close`](./reference/close.md) | Close file | +| [`_commit`](./reference/commit.md) | Flush file to disk | +| [`_creat`, `_wcreat`](./reference/creat-wcreat.md) | Create file | +| [`_dup`](./reference/dup-dup2.md) | Return next available file descriptor for given file | +| [`_dup2`](./reference/dup-dup2.md) | Create second descriptor for given file | +| [`_eof`](./reference/eof.md) | Test for end of file | +| [`_lseek`, `_lseeki64`](./reference/lseek-lseeki64.md) | Reposition file pointer to given location | +| [`_open`, `_wopen`](./reference/open-wopen.md) | Open file | +| [`_read`](./reference/read.md) | Read data from file | +| [`_sopen`, `_wsopen`](./reference/sopen-wsopen.md), [`_sopen_s`, `_wsopen_s`](./reference/sopen-s-wsopen-s.md) | Open file for file sharing | +| [`_tell`, `_telli64`](./reference/tell-telli64.md) | Get current file-pointer position | +| [`_umask`](./reference/umask.md), [`_umask_s`](./reference/umask-s.md) | Set file-permission mask | +| [`_write`](./reference/write.md) | Write data to file | + +`_dup` and `_dup2` are typically used to associate the predefined file descriptors with different files. ## See also diff --git a/docs/c-runtime-library/math-constants.md b/docs/c-runtime-library/math-constants.md index 0aa3a54dadf..cd7110f0189 100644 --- a/docs/c-runtime-library/math-constants.md +++ b/docs/c-runtime-library/math-constants.md @@ -24,21 +24,21 @@ Microsoft provides several predefined preprocessor macros for common math consta The following symbols are defined for the values of their indicated expressions: -|Symbol|Expression|Value| -|------------|----------------|-----------| -|`M_E`|e|2.71828182845904523536| -|`M_LOG2E`|log2(e)|1.44269504088896340736| -|`M_LOG10E`|log10(e)|0.434294481903251827651| -|`M_LN2`|ln(2)|0.693147180559945309417| -|`M_LN10`|ln(10)|2.30258509299404568402| -|`M_PI`|pi|3.14159265358979323846| -|`M_PI_2`|pi/2|1.57079632679489661923| -|`M_PI_4`|pi/4|0.785398163397448309616| -|`M_1_PI`|1/pi|0.318309886183790671538| -|`M_2_PI`|2/pi|0.636619772367581343076| -|`M_2_SQRTPI`|2/sqrt(pi)|1.12837916709551257390| -|`M_SQRT2`|sqrt(2)|1.41421356237309504880| -|`M_SQRT1_2`|1/sqrt(2)|0.707106781186547524401| +| Symbol | Expression | Value | +|---|---|---| +| `M_E` | e | 2.71828182845904523536 | +| `M_LOG2E` | log2(e) | 1.44269504088896340736 | +| `M_LOG10E` | log10(e) | 0.434294481903251827651 | +| `M_LN2` | ln(2) | 0.693147180559945309417 | +| `M_LN10` | ln(10) | 2.30258509299404568402 | +| `M_PI` | pi | 3.14159265358979323846 | +| `M_PI_2` | pi/2 | 1.57079632679489661923 | +| `M_PI_4` | pi/4 | 0.785398163397448309616 | +| `M_1_PI` | 1/pi | 0.318309886183790671538 | +| `M_2_PI` | 2/pi | 0.636619772367581343076 | +| `M_2_SQRTPI` | 2/sqrt(pi) | 1.12837916709551257390 | +| `M_SQRT2` | sqrt(2) | 1.41421356237309504880 | +| `M_SQRT1_2` | 1/sqrt(2) | 0.707106781186547524401 | The math constants aren't defined in Standard C/C++. To use them, you must first define `_USE_MATH_DEFINES`, and then include `` or ``. diff --git a/docs/c-runtime-library/math-error-constants.md b/docs/c-runtime-library/math-error-constants.md index d33fc5070cc..6b598ed3885 100644 --- a/docs/c-runtime-library/math-error-constants.md +++ b/docs/c-runtime-library/math-error-constants.md @@ -10,7 +10,7 @@ ms.assetid: 4be933a6-674e-45a5-8ac9-090023542f5b ## Syntax -``` +```C #include ``` @@ -20,14 +20,14 @@ The math routines of the run-time library can generate math error constants. These errors, described as follows, correspond to the exception types defined in MATH.H and are returned by the `_matherr` function when a math error occurs. -|Constant|Meaning| -|--------------|-------------| -|`_DOMAIN`|Argument to function is outside domain of function.| -|`_OVERFLOW`|Result is too large to be represented in function's return type.| -|`_PLOSS`|Partial loss of significance occurred.| -|`_SING`|Argument singularity: argument to function has illegal value. (For example, value 0 is passed to function that requires nonzero value.)| -|`_TLOSS`|Total loss of significance occurred.| -|`_UNDERFLOW`|Result is too small to be represented.| +| Constant | Meaning | +|---|---| +| `_DOMAIN` | Argument to function is outside domain of function. | +| `_OVERFLOW` | Result is too large to be represented in function's return type. | +| `_PLOSS` | Partial loss of significance occurred. | +| `_SING` | Argument singularity: argument to function has illegal value. (For example, value 0 is passed to function that requires nonzero value.) | +| `_TLOSS` | Total loss of significance occurred. | +| `_UNDERFLOW` | Result is too small to be represented. | ## See also diff --git a/docs/c-runtime-library/max-env.md b/docs/c-runtime-library/max-env.md index 1fc81dad80d..8c4c735c43b 100644 --- a/docs/c-runtime-library/max-env.md +++ b/docs/c-runtime-library/max-env.md @@ -2,8 +2,8 @@ description: "Learn more about: _MAX_ENV" title: "_MAX_ENV" ms.date: "11/04/2016" -f1_keywords: ["_MAX_ENV", "MAX_ENV"] -helpviewer_keywords: ["MAX_ENV constant", "_MAX_ENV constant"] +f1_keywords: ["_MAX_ENV", "STDLIB/_MAX_ENV"] +helpviewer_keywords: ["_MAX_ENV constant"] ms.assetid: 66f0683e-6132-4297-b99b-6940534898b5 --- # `_MAX_ENV` @@ -12,7 +12,7 @@ The maximum permissible string length of an environmental variable. ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/mb-cur-max-func-mb-cur-max-l-func-p-mb-cur-max-mb-cur-max.md b/docs/c-runtime-library/mb-cur-max-func-mb-cur-max-l-func-p-mb-cur-max-mb-cur-max.md index e4cd10b26db..e9202fbb0fb 100644 --- a/docs/c-runtime-library/mb-cur-max-func-mb-cur-max-l-func-p-mb-cur-max-mb-cur-max.md +++ b/docs/c-runtime-library/mb-cur-max-func-mb-cur-max-l-func-p-mb-cur-max-mb-cur-max.md @@ -34,9 +34,9 @@ The maximum number of bytes in a multibyte character for the current thread loca ## Remarks -`___mb_cur_max_func` is an internal function that the CRT uses to retrieve the current value of the [`MB_CUR_MAX`](./mb-cur-max.md) macro from thread local storage. We recommend that you use the `MB_CUR_MAX` macro in your code for portability. +**`___mb_cur_max_func`** is an internal function that the CRT uses to retrieve the current value of the [`MB_CUR_MAX`](./mb-cur-max.md) macro from thread local storage. We recommend that you use the `MB_CUR_MAX` macro in your code for portability. -The `__mb_cur_max` macro is a convenient way to call the `___mb_cur_max_func()` function. The `__p___mb_cur_max` function is defined for compatibility with Visual C++ 5.0 and earlier versions. +The **`__mb_cur_max`** macro is a convenient way to call the **`___mb_cur_max_func`** function. The **`__p___mb_cur_max`** function is defined for compatibility with Visual C++ 5.0 and earlier versions. Internal CRT functions are implementation-specific and subject to change with each release. We don't recommend their use in your code. @@ -44,9 +44,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`___mb_cur_max_func`, `___mb_cur_max_l_func`, `__p___mb_cur_max`|\, \| +| Routine | Required header | +|---|---| +| **`___mb_cur_max_func`**, **`___mb_cur_max_l_func`**, **`__p___mb_cur_max`** | \, \ | ## See also diff --git a/docs/c-runtime-library/mb-cur-max.md b/docs/c-runtime-library/mb-cur-max.md index e468e93bf90..28e22034bae 100644 --- a/docs/c-runtime-library/mb-cur-max.md +++ b/docs/c-runtime-library/mb-cur-max.md @@ -2,7 +2,7 @@ description: "Learn more about: MB_CUR_MAX" title: "MB_CUR_MAX" ms.date: "10/18/2017" -f1_keywords: ["MB_CUR_MAX"] +f1_keywords: ["MB_CUR_MAX", "CTYPE/MB_CUR_MAX"] helpviewer_keywords: ["MB_CUR_MAX constant"] ms.assetid: fab22609-c14d-4c19-991c-bd09ff30e604 --- diff --git a/docs/c-runtime-library/memory-allocation.md b/docs/c-runtime-library/memory-allocation.md index 264fdecac67..605cf305cb0 100644 --- a/docs/c-runtime-library/memory-allocation.md +++ b/docs/c-runtime-library/memory-allocation.md @@ -11,34 +11,34 @@ These routines allocate, free, and reallocate memory. ## Memory-allocation routines -|Routine|Use| -|-------------|---------| -|[`_alloca`](./reference/alloca.md), [`_malloca`](./reference/malloca.md)|Allocate memory from the stack| -|[`calloc`](./reference/calloc.md)|Allocate an array and initialize its elements to 0 (zero)| -|[`_calloc_dbg`](./reference/calloc-dbg.md)|Debug version of **`calloc`**. Only available in the debug versions of the run-time libraries| -|[`operator delete`, `operator delete[]`](./delete-operator-crt.md)|Free memory allocated on the heap | -|[`_expand`](./reference/expand.md)|Expand or shrink a block of memory without moving it| -|[`_expand_dbg`](./reference/expand-dbg.md)|Debug version of **`_expand`**. Only available in the debug versions of the run-time libraries| -|[`free`](./reference/free.md)|Free memory allocated on the heap| -|[`_free_dbg`](./reference/free-dbg.md)|Debug version of **`free`**. Only available in the debug versions of the run-time libraries| -|[`_freea`](./reference/freea.md)|Free memory allocated on the stack| -|[`_get_heap_handle`](./reference/get-heap-handle.md)|Get a Win32 `HANDLE` to the C runtime (CRT) heap.| -|[`_heapadd`](./heapadd.md)|Add memory to the heap| -|[`_heapchk`](./reference/heapchk.md)|Check the heap for consistency| -|[`_heapmin`](./reference/heapmin.md)|Release unused memory in the heap| -|[`_heapset`](./heapset.md)|Fill free heap entries with a value| -|[`_heapwalk`](./reference/heapwalk.md)|Get info about each entry in the heap| -|[`malloc`](./reference/malloc.md)|Allocate memory from the heap| -|[`_malloc_dbg`](./reference/malloc-dbg.md)|Debug version of **`malloc`**; only available in the debug versions of the run-time libraries| -|[`_msize`](./reference/msize.md)|Return the size of an allocated block of memory| -|[`_msize_dbg`](./reference/msize-dbg.md)|Debug version of **`_msize`**; only available in the debug versions of the run-time libraries| -|[`new`, `new[]`](./new-operator-crt.md)|Allocate a block of memory from the heap| -|[`_query_new_handler`](./reference/query-new-handler.md)|Get the address of the current new handler routine set by **`_set_new_handler`**| -|[`_query_new_mode`](./reference/query-new-mode.md)|Get the new handler mode set by **`_set_new_mode`** for **`malloc`**| -|[`realloc`](./reference/realloc.md)|Reallocate a block to a new size| -|[`_realloc_dbg`](./reference/realloc-dbg.md)|Debug version of **`realloc`**; only available in the debug versions of the run-time libraries| -|[`_set_new_handler`](./reference/set-new-handler.md)|Enable error-handling mechanism when the **`new`** operator fails to allocate memory, and enable compilation of the C++ Standard Libraries| -|[`_set_new_mode`](./reference/set-new-mode.md)|Set the new handler mode for **`malloc`**| +| Routine | Use | +|---|---| +| [`_alloca`](./reference/alloca.md), [`_malloca`](./reference/malloca.md) | Allocate memory from the stack | +| [`calloc`](./reference/calloc.md) | Allocate an array and initialize its elements to 0 (zero) | +| [`_calloc_dbg`](./reference/calloc-dbg.md) | Debug version of **`calloc`**. Only available in the debug versions of the run-time libraries | +| [`operator delete`, `operator delete[]`](./delete-operator-crt.md) | Free memory allocated on the heap | +| [`_expand`](./reference/expand.md) | Expand or shrink a block of memory without moving it | +| [`_expand_dbg`](./reference/expand-dbg.md) | Debug version of **`_expand`**. Only available in the debug versions of the run-time libraries | +| [`free`](./reference/free.md) | Free memory allocated on the heap | +| [`_free_dbg`](./reference/free-dbg.md) | Debug version of **`free`**. Only available in the debug versions of the run-time libraries | +| [`_freea`](./reference/freea.md) | Free memory allocated on the stack | +| [`_get_heap_handle`](./reference/get-heap-handle.md) | Get a Win32 `HANDLE` to the C runtime (CRT) heap. | +| [`_heapadd`](./heapadd.md) | Add memory to the heap | +| [`_heapchk`](./reference/heapchk.md) | Check the heap for consistency | +| [`_heapmin`](./reference/heapmin.md) | Release unused memory in the heap | +| [`_heapset`](./heapset.md) | Fill free heap entries with a value | +| [`_heapwalk`](./reference/heapwalk.md) | Get info about each entry in the heap | +| [`malloc`](./reference/malloc.md) | Allocate memory from the heap | +| [`_malloc_dbg`](./reference/malloc-dbg.md) | Debug version of **`malloc`**; only available in the debug versions of the run-time libraries | +| [`_msize`](./reference/msize.md) | Return the size of an allocated block of memory | +| [`_msize_dbg`](./reference/msize-dbg.md) | Debug version of **`_msize`**; only available in the debug versions of the run-time libraries | +| [`new`, `new[]`](./new-operator-crt.md) | Allocate a block of memory from the heap | +| [`_query_new_handler`](./reference/query-new-handler.md) | Get the address of the current new handler routine set by **`_set_new_handler`** | +| [`_query_new_mode`](./reference/query-new-mode.md) | Get the new handler mode set by **`_set_new_mode`** for **`malloc`** | +| [`realloc`](./reference/realloc.md) | Reallocate a block to a new size | +| [`_realloc_dbg`](./reference/realloc-dbg.md) | Debug version of **`realloc`**; only available in the debug versions of the run-time libraries | +| [`_set_new_handler`](./reference/set-new-handler.md) | Enable error-handling mechanism when the **`new`** operator fails to allocate memory, and enable compilation of the C++ Standard Libraries | +| [`_set_new_mode`](./reference/set-new-mode.md) | Set the new handler mode for **`malloc`** | ## See also diff --git a/docs/c-runtime-library/null-crt.md b/docs/c-runtime-library/null-crt.md index 99eb4bc5e52..a0e2fb57254 100644 --- a/docs/c-runtime-library/null-crt.md +++ b/docs/c-runtime-library/null-crt.md @@ -2,7 +2,7 @@ description: "Learn more about: NULL (CRT)" title: "NULL (CRT)" ms.date: "11/04/2016" -f1_keywords: ["null"] +f1_keywords: ["NULL", "VCRUNTIME/NULL"] helpviewer_keywords: ["NULL", "null pointers", "NULL, null pointer value"] ms.assetid: f9aac2a0-4f79-423f-8738-a76dccc0b1c3 --- diff --git a/docs/c-runtime-library/obsolete-functions.md b/docs/c-runtime-library/obsolete-functions.md index 38499701637..2ba2e314fa2 100644 --- a/docs/c-runtime-library/obsolete-functions.md +++ b/docs/c-runtime-library/obsolete-functions.md @@ -16,30 +16,30 @@ Certain library functions are obsolete and have more recent equivalents. We reco ## Deprecated as obsolete in Visual Studio 2015 -|Obsolete function|Alternative| -|-----------------------|-----------------| -|`is_wctype`|[`iswctype`](./reference/isctype-iswctype-isctype-l-iswctype-l.md)| -|`_loaddll`|[`LoadLibrary`](/windows/win32/api/libloaderapi/nf-libloaderapi-loadlibraryw), [`LoadLibraryEx`](/windows/win32/api/libloaderapi/nf-libloaderapi-loadlibraryexw), or [`LoadPackagedLibrary`](/windows/win32/api/winbase/nf-winbase-loadpackagedlibrary)| -|`_unloaddll`|[`FreeLibrary`](/windows/win32/api/libloaderapi/nf-libloaderapi-freelibrary)| -|`_getdllprocaddr`|[`GetProcAddress`](../build/getprocaddress.md)| -|`_seterrormode`|[`SetErrorMode`](/windows/win32/api/errhandlingapi/nf-errhandlingapi-seterrormode)| -|`_beep`|[`Beep`](/windows/win32/api/utilapiset/nf-utilapiset-beep)| -|`_sleep`|[`Sleep`](/windows/win32/api/synchapi/nf-synchapi-sleep)| -|`_getsystime`|[`GetLocalTime`](/windows/win32/api/sysinfoapi/nf-sysinfoapi-getlocaltime)| -|`_setsystime`|[`SetLocalTime`](/windows/win32/api/sysinfoapi/nf-sysinfoapi-setlocaltime)| +| Obsolete function | Alternative | +|---|---| +| `is_wctype` | [`iswctype`](./reference/isctype-iswctype-isctype-l-iswctype-l.md) | +| `_loaddll` | [`LoadLibrary`](/windows/win32/api/libloaderapi/nf-libloaderapi-loadlibraryw), [`LoadLibraryEx`](/windows/win32/api/libloaderapi/nf-libloaderapi-loadlibraryexw), or [`LoadPackagedLibrary`](/windows/win32/api/winbase/nf-winbase-loadpackagedlibrary) | +| `_unloaddll` | [`FreeLibrary`](/windows/win32/api/libloaderapi/nf-libloaderapi-freelibrary) | +| `_getdllprocaddr` | [`GetProcAddress`](../build/getprocaddress.md) | +| `_seterrormode` | [`SetErrorMode`](/windows/win32/api/errhandlingapi/nf-errhandlingapi-seterrormode) | +| `_beep` | [`Beep`](/windows/win32/api/utilapiset/nf-utilapiset-beep) | +| `_sleep` | [`Sleep`](/windows/win32/api/synchapi/nf-synchapi-sleep) | +| `_getsystime` | [`GetLocalTime`](/windows/win32/api/sysinfoapi/nf-sysinfoapi-getlocaltime) | +| `_setsystime` | [`SetLocalTime`](/windows/win32/api/sysinfoapi/nf-sysinfoapi-setlocaltime) | ## Removed from the CRT in Visual Studio 2015 -|Obsolete function|Alternative| -|-----------------------|-----------------| -|[`_cgets`, `_cgetws`](./cgets-cgetws.md)|[`_cgets_s`, `_cgetws_s`](./reference/cgets-s-cgetws-s.md)| -|[`gets`, `_getws`](./gets-getws.md)|[`gets_s`, `_getws_s`](./reference/gets-s-getws-s.md)| -|[`_get_output_format`](./get-output-format.md)|None| -|[`_heapadd`](./heapadd.md)|None| -|[`_heapset`](./heapset.md)|None| -|[`inp`, `inpw`, `_inp`, `_inpw`, `_inpd`](./inp-inpw-inpd.md)|None| -|[`outp`, `outpw`, `_outp`, `_outpw`, `_outpd`](./outp-outpw-outpd.md)|None| -|[`_set_output_format`](./set-output-format.md)|None| +| Obsolete function | Alternative | +|---|---| +| [`_cgets`, `_cgetws`](./cgets-cgetws.md) | [`_cgets_s`, `_cgetws_s`](./reference/cgets-s-cgetws-s.md) | +| [`gets`, `_getws`](./gets-getws.md) | [`gets_s`, `_getws_s`](./reference/gets-s-getws-s.md) | +| [`_get_output_format`](./get-output-format.md) | None | +| [`_heapadd`](./heapadd.md) | None | +| [`_heapset`](./heapset.md) | None | +| [`inp`, `inpw`, `_inp`, `_inpw`, `_inpd`](./inp-inpw-inpd.md) | None | +| [`outp`, `outpw`, `_outp`, `_outpw`, `_outpd`](./outp-outpw-outpd.md) | None | +| [`_set_output_format`](./set-output-format.md) | None | ## Removed from the CRT in earlier versions of Visual Studio diff --git a/docs/c-runtime-library/outp-outpw-outpd.md b/docs/c-runtime-library/outp-outpw-outpd.md index 9295c248b02..bc7244ca7a7 100644 --- a/docs/c-runtime-library/outp-outpw-outpd.md +++ b/docs/c-runtime-library/outp-outpw-outpd.md @@ -12,7 +12,7 @@ ms.assetid: c200fe22-41f6-46fd-b0be-ebb805b35181 --- # `outp`, `outpw`, `_outp`, `_outpw`, `_outpd` -Outputs, at a port, a byte (`outp`, `_outp`), a word (`outpw`, `_outpw`), or a double word (`_outpd`). +Outputs, at a port, a byte (**`outp`**, **`_outp`**), a word (**`outpw`**, **`_outpw`**), or a double word (**`_outpd`**). > [!IMPORTANT] > These functions are obsolete. Beginning in Visual Studio 2015, they are not available in the CRT.\ @@ -49,21 +49,21 @@ The functions return the data output. There's no error return. ## Remarks -The `_outp`, `_outpw`, and `_outpd` functions write a byte, a word, and a double word, respectively, to the specified output port. The *`port`* argument can be any unsigned integer in the range 0 - 65,535. *`data_byte`* can be any integer in the range 0 - 255. *`data_word`* can be any value in the range of an integer, an unsigned short integer, and an unsigned long integer, respectively. +The **`_outp`**, **`_outpw`**, and **`_outpd`** functions write a byte, a word, and a double word, respectively, to the specified output port. The *`port`* argument can be any unsigned integer in the range 0 - 65,535. *`data_byte`* can be any integer in the range 0 - 255. *`data_word`* can be any value in the range of an integer, an unsigned short integer, and an unsigned long integer, respectively. Because these functions write directly to an I/O port, they can't be used in user-mode Windows code. For information about using I/O ports in the Windows operating system, see [Serial communications](/previous-versions/ff802693(v=msdn.10)). -The `outp` and `outpw` names are older, deprecated names for the `_outp` and `_outpw` functions. For more information, see [POSIX function names](../error-messages/compiler-warnings/compiler-warning-level-3-c4996.md#posix-function-names). +The **`outp`** and **`outpw`** names are older, deprecated names for the **`_outp`** and **`_outpw`** functions. For more information, see [POSIX function names](../error-messages/compiler-warnings/compiler-warning-level-3-c4996.md#posix-function-names). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`_outp`|\| -|`_outpw`|\| -|`_outpd`|\| +| Routine | Required header | +|---|---| +| **`_outp`** | \ | +| **`_outpw`** | \ | +| **`_outpd`** | \ | For more compatibility information, see [Compatibility](./compatibility.md). diff --git a/docs/c-runtime-library/p-commode.md b/docs/c-runtime-library/p-commode.md index a6c1f3d7f36..a0b094e6677 100644 --- a/docs/c-runtime-library/p-commode.md +++ b/docs/c-runtime-library/p-commode.md @@ -27,7 +27,7 @@ Pointer to the `_commode` global variable. ## Remarks -The `__p__commode` function is for internal use only, and shouldn't be called from user code. +The **`__p__commode`** function is for internal use only, and shouldn't be called from user code. File commit mode specifies when critical data is written to disk. For more information, see [`fflush`](./reference/fflush.md). @@ -35,6 +35,6 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|__p\__commode|internal.h| +| Routine | Required header | +|---|---| +| **`__p__commode`** | `internal.h` | diff --git a/docs/c-runtime-library/p-fmode.md b/docs/c-runtime-library/p-fmode.md index ffe216432aa..11cb7456748 100644 --- a/docs/c-runtime-library/p-fmode.md +++ b/docs/c-runtime-library/p-fmode.md @@ -27,7 +27,7 @@ Pointer to the `_fmode` global variable. ## Remarks -The `__p__fmode` function is for internal use only, and shouldn't be called from user code. +The **`__p__fmode`** function is for internal use only, and shouldn't be called from user code. File translation mode specifies either `binary` or `text` translation for [`_open`](./reference/open-wopen.md) and [`_pipe`](./reference/pipe.md) I/O operations. For more information, see [`_fmode`](./fmode.md). @@ -35,6 +35,6 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|__p\__fmode|stdlib.h| +| Routine | Required header | +|---|---| +| **`__p__fmode`** | `` | diff --git a/docs/c-runtime-library/path-field-limits.md b/docs/c-runtime-library/path-field-limits.md index 071e4f3778a..1890385a5d7 100644 --- a/docs/c-runtime-library/path-field-limits.md +++ b/docs/c-runtime-library/path-field-limits.md @@ -2,7 +2,7 @@ description: "Learn more about: Path Field Limits" title: "Path Field Limits" ms.date: "11/04/2016" -f1_keywords: ["_MAX_EXT", "_MAX_DIR", "_MAX_PATH", "_MAX_FNAME", "_MAX_DRIVE"] +f1_keywords: ["_MAX_EXT", "_MAX_DIR", "_MAX_PATH", "_MAX_FNAME", "_MAX_DRIVE", "STDLIB/_MAX_EXT", "STDLIB/_MAX_DIR", "STDLIB/_MAX_PATH", "STDLIB/_MAX_FNAME", "STDLIB/_MAX_DRIVE"] helpviewer_keywords: ["path field constants", "MAX_FNAME constant", "_MAX_DIR constant", "_MAX_DRIVE constant", "paths, maximum limit", "_MAX_PATH constant", "MAX_DRIVE constant", "_MAX_FNAME constant", "_MAX_EXT constant", "MAX_DIR constant", "MAX_EXT constant"] ms.assetid: 2b5d0e43-1347-45b4-8397-24a8a45c444e --- @@ -18,13 +18,13 @@ ms.assetid: 2b5d0e43-1347-45b4-8397-24a8a45c444e These constants define the maximum length for the path and for the individual fields within the path. -|Constant|Meaning| -|--------------|-------------| -|`_MAX_DIR`|Maximum length of directory component| -|`_MAX_DRIVE`|Maximum length of drive component| -|`_MAX_EXT`|Maximum length of extension component| -|`_MAX_FNAME`|Maximum length of filename component| -|`_MAX_PATH`|Maximum length of full path| +| Constant | Meaning | +|---|---| +| `_MAX_DIR` | Maximum length of directory component | +| `_MAX_DRIVE` | Maximum length of drive component | +| `_MAX_EXT` | Maximum length of extension component | +| `_MAX_FNAME` | Maximum length of filename component | +| `_MAX_PATH` | Maximum length of full path | > [!NOTE] > The C Runtime supports path lengths up to 32768 characters in length, but it is up to the operating system, specifically the file system, to support these longer paths. The sum of the fields should not exceed `_MAX_PATH` for full backwards compatibility with FAT32 file systems. The Windows NTFS file system supports paths up to 32768 characters in length, but only when using the Unicode APIs. When using long path names, prefix the path with the characters \\\\?\ and use the Unicode versions of the C Runtime functions. diff --git a/docs/c-runtime-library/pctype-func.md b/docs/c-runtime-library/pctype-func.md index 958e5314ac8..fecede9e1a4 100644 --- a/docs/c-runtime-library/pctype-func.md +++ b/docs/c-runtime-library/pctype-func.md @@ -33,9 +33,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|__pctype_func|ctype.h| +| Routine | Required header | +|---|---| +| **`__pctype_func`** | `` | ## See also diff --git a/docs/c-runtime-library/pctype-pwctype-wctype-mbctype-mbcasemap.md b/docs/c-runtime-library/pctype-pwctype-wctype-mbctype-mbcasemap.md index a3bcb2f3e69..9359692fd97 100644 --- a/docs/c-runtime-library/pctype-pwctype-wctype-mbctype-mbcasemap.md +++ b/docs/c-runtime-library/pctype-pwctype-wctype-mbctype-mbcasemap.md @@ -6,8 +6,8 @@ api_name: ["_pctype", "_pwctype", "_wctype", "_mbctype", "_mbcasemap"] 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-string-l1-1-0.dll", "api-ms-win-crt-multibyte-l1-1-0.dll"] api_type: ["DLLExport"] topic_type: ["apiref"] -f1_keywords: ["pwctype", "pctype", "mbctype", "mbcasemap", "_mbcasemap", "_mbctype", "_pctype", "_wctype", "_pcwtype"] -helpviewer_keywords: ["_wctype function", "_pwctype function", "_pctype function", "_mbctype function", "wctype function", "pwctype function", "pctype function", "mbcasemap function", "mbctype function", "_mbcasemap function"] +f1_keywords: ["_pctype", "CORECRT_WCTYPE/_pctype", "_pwctype", "CORECRT_WCTYPE/_pcwtype", "_mbctype", "MBCTYPE/_mbctype", "_mbcasemap", "MBCTYPE/_mbcasemap", "_wctype"] +helpviewer_keywords: ["_pctype global variable", "_pwctype global variable", "_wctype global variable", "_mbctype global variable", "_mbcasemap global variable"] ms.assetid: 7f5e1107-c43b-4b9b-b387-781e6d2373cb --- # `_pctype`, `_pwctype`, `_wctype`, `_mbctype`, `_mbcasemap` @@ -16,7 +16,7 @@ These global variables contain information used by the character classification ## Syntax -``` +```C extern const unsigned short *_pctype; extern const wctype_t *_pwctype; extern const unsigned short _wctype[]; diff --git a/docs/c-runtime-library/pgmptr-wpgmptr.md b/docs/c-runtime-library/pgmptr-wpgmptr.md index 3ce4220da5c..e5779e90754 100644 --- a/docs/c-runtime-library/pgmptr-wpgmptr.md +++ b/docs/c-runtime-library/pgmptr-wpgmptr.md @@ -2,8 +2,8 @@ description: "Learn more about: _pgmptr, _wpgmptr" title: "_pgmptr, _wpgmptr" ms.date: "11/04/2016" -f1_keywords: ["pgmptr", "_pgmptr", "wpgmptr", "_wpgmptr"] -helpviewer_keywords: ["wpgmptr function", "_wpgmptr function", "_pgmptr function", "pgmptr function"] +f1_keywords: ["_pgmptr", "STDLIB/_pgmptr", "_wpgmptr", "STDLIB/_wpgmptr"] +helpviewer_keywords: ["_pgmptr global variable", "_wpgmptr global variable"] ms.assetid: 4d44b515-0eff-4136-8bc4-684195f218f5 --- # `_pgmptr`, `_wpgmptr` @@ -12,38 +12,38 @@ The path of the executable file. Deprecated; use [`_get_pgmptr`](./reference/get ## Syntax -``` +```C extern char *_pgmptr; extern wchar_t *_wpgmptr; ``` ## Remarks -When a program is run from the command interpreter (Cmd.exe), `_pgmptr` is automatically initialized to the full path of the executable file. For example, if Hello.exe is in C:\BIN and C:\BIN is in the path, `_pgmptr` is set to C:\BIN\Hello.exe when you execute: +When a program is run from the command interpreter (Cmd.exe), **`_pgmptr`** is automatically initialized to the full path of the executable file. For example, if Hello.exe is in C:\BIN and C:\BIN is in the path, **`_pgmptr`** is set to *`C:\BIN\Hello.exe`* when you execute: -``` +```cmd C> hello ``` -When a program isn't run from the command line, `_pgmptr` might be initialized to the program name (the file's base name without the file name extension) or to a file name, relative path, or full path. +When a program isn't run from the command line, **`_pgmptr`** might be initialized to the program name (the file's base name without the file name extension) or to a file name, relative path, or full path. -`_wpgmptr` is the wide-character counterpart of `_pgmptr` for use with programs that use `wmain`. +**`_wpgmptr`** is the wide-character counterpart of **`_pgmptr`** for use with programs that use `wmain`. ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tpgmptr`|`_pgmptr`|`_pgmptr`|`_wpgmptr`| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tpgmptr` | **`_pgmptr`** | **`_pgmptr`** | **`_wpgmptr`** | ## Requirements -|Variable|Required header| -|--------------|---------------------| -|`_pgmptr`, `_wpgmptr`|\| +| Variable | Required header | +|---|---| +| **`_pgmptr`**, **`_wpgmptr`** | \ | ## Example -The following program demonstrates the use of `_pgmptr`. +The following program demonstrates the use of **`_pgmptr`**. ```c // crt_pgmptr.c @@ -60,7 +60,7 @@ int main( void ) } ``` -You could use `_wpgmptr` by changing `%Fs` to `%S` and `main` to `wmain`. +You could use **`_wpgmptr`** by changing `%Fs` to `%S` and `main` to `wmain`. ## See also diff --git a/docs/c-runtime-library/printf-p-positional-parameters.md b/docs/c-runtime-library/printf-p-positional-parameters.md index 514bb835bc0..cb4ed9f1a46 100644 --- a/docs/c-runtime-library/printf-p-positional-parameters.md +++ b/docs/c-runtime-library/printf-p-positional-parameters.md @@ -14,13 +14,13 @@ Positional parameters let you specify by number the argument to substitute into | Non-positional printf functions | Positional parameter equivalents | |---|---| -|[`printf`, `_printf_l`, `wprintf`, `_wprintf_l`](./reference/printf-printf-l-wprintf-wprintf-l.md)|[`_printf_p`, `_printf_p_l`, `_wprintf_p`, `_wprintf_p_l`](./reference/printf-p-printf-p-l-wprintf-p-wprintf-p-l.md)| -|[`sprintf`, `_sprintf_l`, `swprintf`, `_swprintf_l`, `__swprintf_l`](./reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md)|[`_sprintf_p`, `_sprintf_p_l`, `_swprintf_p`, `_swprintf_p_l`](./reference/sprintf-p-sprintf-p-l-swprintf-p-swprintf-p-l.md)| -|[`_cprintf`, `_cprintf_l`, `_cwprintf`, `_cwprintf_l`](./reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md)|[`_cprintf_p`, `_cprintf_p_l`, `_cwprintf_p`, `_cwprintf_p_l`](./reference/cprintf-p-cprintf-p-l-cwprintf-p-cwprintf-p-l.md)| -|[`fprintf`, `_fprintf_l`, `fwprintf`, `_fwprintf_l`](./reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md)|[`_fprintf_p`, `_fprintf_p_l`, `_fwprintf_p`, `_fwprintf_p_l`](./reference/fprintf-p-fprintf-p-l-fwprintf-p-fwprintf-p-l.md)| -|[`vprintf`, `_vprintf_l`, `vwprintf`, `_vwprintf_l`](./reference/vprintf-vprintf-l-vwprintf-vwprintf-l.md)|[`_vprintf_p`, `_vprintf_p_l`, `_vwprintf_p`, `_vwprintf_p_l`](./reference/vprintf-p-vprintf-p-l-vwprintf-p-vwprintf-p-l.md)| -|[`vfprintf`, `_vfprintf_l`, `vfwprintf`, `_vfwprintf_l`](./reference/vfprintf-vfprintf-l-vfwprintf-vfwprintf-l.md)|[`_vfprintf_p`, `_vfprintf_p_l`, `_vfwprintf_p`, `_vfwprintf_p_l`](./reference/vfprintf-p-vfprintf-p-l-vfwprintf-p-vfwprintf-p-l.md)| -|[`vsprintf`, `_vsprintf_l`, `vswprintf`, `_vswprintf_l`, `__vswprintf_l`](./reference/vsprintf-vsprintf-l-vswprintf-vswprintf-l-vswprintf-l.md)|[`_vsprintf_p`, `_vsprintf_p_l`, `_vswprintf_p`, `_vswprintf_p_l`](./reference/vsprintf-p-vsprintf-p-l-vswprintf-p-vswprintf-p-l.md)| +| [`printf`, `_printf_l`, `wprintf`, `_wprintf_l`](./reference/printf-printf-l-wprintf-wprintf-l.md) | [`_printf_p`, `_printf_p_l`, `_wprintf_p`, `_wprintf_p_l`](./reference/printf-p-printf-p-l-wprintf-p-wprintf-p-l.md) | +| [`sprintf`, `_sprintf_l`, `swprintf`, `_swprintf_l`, `__swprintf_l`](./reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md) | [`_sprintf_p`, `_sprintf_p_l`, `_swprintf_p`, `_swprintf_p_l`](./reference/sprintf-p-sprintf-p-l-swprintf-p-swprintf-p-l.md) | +| [`_cprintf`, `_cprintf_l`, `_cwprintf`, `_cwprintf_l`](./reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md) | [`_cprintf_p`, `_cprintf_p_l`, `_cwprintf_p`, `_cwprintf_p_l`](./reference/cprintf-p-cprintf-p-l-cwprintf-p-cwprintf-p-l.md) | +| [`fprintf`, `_fprintf_l`, `fwprintf`, `_fwprintf_l`](./reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md) | [`_fprintf_p`, `_fprintf_p_l`, `_fwprintf_p`, `_fwprintf_p_l`](./reference/fprintf-p-fprintf-p-l-fwprintf-p-fwprintf-p-l.md) | +| [`vprintf`, `_vprintf_l`, `vwprintf`, `_vwprintf_l`](./reference/vprintf-vprintf-l-vwprintf-vwprintf-l.md) | [`_vprintf_p`, `_vprintf_p_l`, `_vwprintf_p`, `_vwprintf_p_l`](./reference/vprintf-p-vprintf-p-l-vwprintf-p-vwprintf-p-l.md) | +| [`vfprintf`, `_vfprintf_l`, `vfwprintf`, `_vfwprintf_l`](./reference/vfprintf-vfprintf-l-vfwprintf-vfwprintf-l.md) | [`_vfprintf_p`, `_vfprintf_p_l`, `_vfwprintf_p`, `_vfwprintf_p_l`](./reference/vfprintf-p-vfprintf-p-l-vfwprintf-p-vfwprintf-p-l.md) | +| [`vsprintf`, `_vsprintf_l`, `vswprintf`, `_vswprintf_l`, `__vswprintf_l`](./reference/vsprintf-vsprintf-l-vswprintf-vswprintf-l-vswprintf-l.md) | [`_vsprintf_p`, `_vsprintf_p_l`, `_vswprintf_p`, `_vswprintf_p_l`](./reference/vsprintf-p-vsprintf-p-l-vswprintf-p-vswprintf-p-l.md) | ## How to specify positional parameters @@ -36,7 +36,7 @@ _printf_p("%1$s %2$s", "November", "10"); This example prints: -``` +```Output November 10 ``` @@ -48,7 +48,7 @@ _printf_p("%2$s %1$s", "November", "10"); This example prints: -``` +```Output 10 November ``` @@ -60,7 +60,7 @@ _printf_p("%1$d times %1$d is %2$d", 10, 100); This example prints: -``` +```Output 10 times 10 is 100 ``` diff --git a/docs/c-runtime-library/process-and-environment-control.md b/docs/c-runtime-library/process-and-environment-control.md index 782d02c87b4..06d36fd705f 100644 --- a/docs/c-runtime-library/process-and-environment-control.md +++ b/docs/c-runtime-library/process-and-environment-control.md @@ -11,48 +11,48 @@ Use the process-control routines to start, stop, and manage processes from withi ## Process and environment control functions -|Routine|Use| -|-------------|---------| -|[`abort`](./reference/abort.md)|Abort process without flushing buffers or calling functions registered by **`atexit`** and **`_onexit`**| -|[`assert`](./reference/assert-macro-assert-wassert.md)|Test for logic error| -|[`_ASSERT`, `_ASSERTE`](./reference/assert-asserte-assert-expr-macros.md) macros|Similar to **`assert`**, but only available in the debug versions of the run-time libraries| -|[`atexit`](./reference/atexit.md)|Schedule routines for execution at program termination| -|[`_beginthread`, `_beginthreadex`](./reference/beginthread-beginthreadex.md)|Create a new thread on a Windows operating system process| -|[`_cexit`](./reference/cexit-c-exit.md)|Perform **`exit`** termination procedures (such as flushing buffers), then return control to calling program without terminating process| -|[`_c_exit`](./reference/cexit-c-exit.md)|Perform **`_exit`** termination procedures, then return control to calling program without terminating process| -|[`_cwait`](./reference/cwait.md)|Wait until another process terminates| -|[`_endthread`, `_endthreadex`](./reference/endthread-endthreadex.md)|Terminate a Windows operating system thread| -|[`_execl`, `_wexecl`](./reference/execl-wexecl.md)|Execute new process with argument list| -|[`_execle`, `_wexecle`](./reference/execle-wexecle.md)|Execute new process with argument list and given environment| -|[`_execlp`, `_wexeclp`](./reference/execlp-wexeclp.md)|Execute new process using `PATH` variable and argument list| -|[`_execlpe`, `_wexeclpe`](./reference/execlpe-wexeclpe.md)|Execute new process using `PATH` variable, given environment, and argument list| -|[`_execv`, `_wexecv`](./reference/execv-wexecv.md)|Execute new process with argument array| -|[`_execve`, `_wexecve`](./reference/execve-wexecve.md)|Execute new process with argument array and given environment| -|[`_execvp`, `_wexecvp`](./reference/execvp-wexecvp.md)|Execute new process using `PATH` variable and argument array| -|[`_execvpe`, `_wexecvpe`](./reference/execvpe-wexecvpe.md)|Execute new process using `PATH` variable, given environment, and argument array| -|[`exit`](./reference/exit-exit-exit.md)|Call functions registered by **`atexit`** and **`_onexit`**, flush all buffers, close all open files, and terminate process| -|[`_exit`](./reference/exit-exit-exit.md)|Terminate process immediately without calling **`atexit`** or **`_onexit`** or flushing buffers| -|[`getenv`, `_wgetenv`](./reference/getenv-wgetenv.md), [`getenv_s`, `_wgetenv_s`](./reference/getenv-s-wgetenv-s.md)|Get value of environment variable| -|[`_getpid`](./reference/getpid.md)|Get process ID number| -|[`longjmp`](./reference/longjmp.md)|Restore saved stack environment; use it to execute a nonlocal **`goto`**| -|[`_onexit`](./reference/onexit-onexit-m.md)|Schedule routines for execution at program termination; use for compatibility with Microsoft C/C++ version 7.0 and earlier| -|[`_pclose`](./reference/pclose.md)|Wait for new command processor and close stream on associated pipe| -|[`perror`, `_wperror`](./reference/perror-wperror.md)|Print error message| -|[`_pipe`](./reference/pipe.md)|Create pipe for reading and writing| -|[`_popen`, `_wpopen`](./reference/popen-wpopen.md)|Create pipe and execute command| -|[`_putenv`, `_wputenv`](./reference/putenv-wputenv.md), [`_putenv_s`, `_wputenv_s`](./reference/putenv-s-wputenv-s.md)|Add or change value of environment variable| -|[`raise`](./reference/raise.md)|Send signal to calling process| -|[`setjmp`](./reference/setjmp.md)|Save stack environment; use to execute non local **`goto`**| -|[`signal`](./reference/signal.md)|Handle interrupt signal| -|[`_spawnl`, `_wspawnl`](./reference/spawnl-wspawnl.md)|Create and execute new process with specified argument list| -|[`_spawnle`, `_wspawnle`](./reference/spawnle-wspawnle.md)|Create and execute new process with specified argument list and environment| -|[`_spawnlp`, `_wspawnlp`](./reference/spawnlp-wspawnlp.md)|Create and execute new process using `PATH` variable and specified argument list| -|[`_spawnlpe`, `_wspawnlpe`](./reference/spawnlpe-wspawnlpe.md)|Create and execute new process using `PATH` variable, specified environment, and argument list| -|[`_spawnv`, `_wspawnv`](./reference/spawnv-wspawnv.md)|Create and execute new process with specified argument array| -|[`_spawnve`, `_wspawnve`](./reference/spawnve-wspawnve.md)|Create and execute new process with specified environment and argument array| -|[`_spawnvp`, `_wspawnvp`](./reference/spawnvp-wspawnvp.md)|Create and execute new process using `PATH` variable and specified argument array| -|[`_spawnvpe`, `_wspawnvpe`](./reference/spawnvpe-wspawnvpe.md)|Create and execute new process using `PATH` variable, specified environment, and argument array| -|[`system`, `_wsystem`](./reference/system-wsystem.md)|Execute operating-system command| +| Routine | Use | +|---|---| +| [`abort`](./reference/abort.md) | Abort process without flushing buffers or calling functions registered by **`atexit`** and **`_onexit`** | +| [`assert`](./reference/assert-macro-assert-wassert.md) | Test for logic error | +| [`_ASSERT`, `_ASSERTE`](./reference/assert-asserte-assert-expr-macros.md) macros | Similar to **`assert`**, but only available in the debug versions of the run-time libraries | +| [`atexit`](./reference/atexit.md) | Schedule routines for execution at program termination | +| [`_beginthread`, `_beginthreadex`](./reference/beginthread-beginthreadex.md) | Create a new thread on a Windows operating system process | +| [`_cexit`](./reference/cexit-c-exit.md) | Perform **`exit`** termination procedures (such as flushing buffers), then return control to calling program without terminating process | +| [`_c_exit`](./reference/cexit-c-exit.md) | Perform **`_exit`** termination procedures, then return control to calling program without terminating process | +| [`_cwait`](./reference/cwait.md) | Wait until another process terminates | +| [`_endthread`, `_endthreadex`](./reference/endthread-endthreadex.md) | Terminate a Windows operating system thread | +| [`_execl`, `_wexecl`](./reference/execl-wexecl.md) | Execute new process with argument list | +| [`_execle`, `_wexecle`](./reference/execle-wexecle.md) | Execute new process with argument list and given environment | +| [`_execlp`, `_wexeclp`](./reference/execlp-wexeclp.md) | Execute new process using `PATH` variable and argument list | +| [`_execlpe`, `_wexeclpe`](./reference/execlpe-wexeclpe.md) | Execute new process using `PATH` variable, given environment, and argument list | +| [`_execv`, `_wexecv`](./reference/execv-wexecv.md) | Execute new process with argument array | +| [`_execve`, `_wexecve`](./reference/execve-wexecve.md) | Execute new process with argument array and given environment | +| [`_execvp`, `_wexecvp`](./reference/execvp-wexecvp.md) | Execute new process using `PATH` variable and argument array | +| [`_execvpe`, `_wexecvpe`](./reference/execvpe-wexecvpe.md) | Execute new process using `PATH` variable, given environment, and argument array | +| [`exit`](./reference/exit-exit-exit.md) | Call functions registered by **`atexit`** and **`_onexit`**, flush all buffers, close all open files, and terminate process | +| [`_exit`](./reference/exit-exit-exit.md) | Terminate process immediately without calling **`atexit`** or **`_onexit`** or flushing buffers | +| [`getenv`, `_wgetenv`](./reference/getenv-wgetenv.md), [`getenv_s`, `_wgetenv_s`](./reference/getenv-s-wgetenv-s.md) | Get value of environment variable | +| [`_getpid`](./reference/getpid.md) | Get process ID number | +| [`longjmp`](./reference/longjmp.md) | Restore saved stack environment; use it to execute a nonlocal **`goto`** | +| [`_onexit`](./reference/onexit-onexit-m.md) | Schedule routines for execution at program termination; use for compatibility with Microsoft C/C++ version 7.0 and earlier | +| [`_pclose`](./reference/pclose.md) | Wait for new command processor and close stream on associated pipe | +| [`perror`, `_wperror`](./reference/perror-wperror.md) | Print error message | +| [`_pipe`](./reference/pipe.md) | Create pipe for reading and writing | +| [`_popen`, `_wpopen`](./reference/popen-wpopen.md) | Create pipe and execute command | +| [`_putenv`, `_wputenv`](./reference/putenv-wputenv.md), [`_putenv_s`, `_wputenv_s`](./reference/putenv-s-wputenv-s.md) | Add or change value of environment variable | +| [`raise`](./reference/raise.md) | Send signal to calling process | +| [`setjmp`](./reference/setjmp.md) | Save stack environment; use to execute non local **`goto`** | +| [`signal`](./reference/signal.md) | Handle interrupt signal | +| [`_spawnl`, `_wspawnl`](./reference/spawnl-wspawnl.md) | Create and execute new process with specified argument list | +| [`_spawnle`, `_wspawnle`](./reference/spawnle-wspawnle.md) | Create and execute new process with specified argument list and environment | +| [`_spawnlp`, `_wspawnlp`](./reference/spawnlp-wspawnlp.md) | Create and execute new process using `PATH` variable and specified argument list | +| [`_spawnlpe`, `_wspawnlpe`](./reference/spawnlpe-wspawnlpe.md) | Create and execute new process using `PATH` variable, specified environment, and argument list | +| [`_spawnv`, `_wspawnv`](./reference/spawnv-wspawnv.md) | Create and execute new process with specified argument array | +| [`_spawnve`, `_wspawnve`](./reference/spawnve-wspawnve.md) | Create and execute new process with specified environment and argument array | +| [`_spawnvp`, `_wspawnvp`](./reference/spawnvp-wspawnvp.md) | Create and execute new process using `PATH` variable and specified argument array | +| [`_spawnvpe`, `_wspawnvpe`](./reference/spawnvpe-wspawnvpe.md) | Create and execute new process using `PATH` variable, specified environment, and argument array | +| [`system`, `_wsystem`](./reference/system-wsystem.md) | Execute operating-system command | In the Windows operating system, the spawned process is equivalent to the spawning process. Any process can use **`_cwait`** to wait for any other process for which the process ID is known. @@ -62,16 +62,16 @@ The differences among the functions in the **`_exec`** and **`_spawn`** families ### `_spawn` and `_exec` Function Families -|Functions|Use `PATH` variable to locate file|Argument-passing convention|Environment settings| -|---------------|--------------------------------------|----------------------------------|--------------------------| -|**`_execl`**, **`_spawnl`**|No|List|Inherited from calling process| -|**`_execle`**, **`_spawnle`**|No|List|Pointer to environment table for new process passed as last argument| -|**`_execlp`**, **`_spawnlp`**|Yes|List|Inherited from calling process| -|**`_execvpe`**, **`_spawnvpe`**|Yes|Array|Pointer to environment table for new process passed as last argument| -|**`_execlpe`**, **`_spawnlpe`**|Yes|List|Pointer to environment table for new process passed as last argument| -|**`_execv`**, **`_spawnv`**|No|Array|Inherited from calling process| -|**`_execve`**, **`_spawnve`**|No|Array|Pointer to environment table for new process passed as last argument| -|**`_execvp`**, **`_spawnvp`**|Yes|Array|Inherited from calling process| +| Functions | Use `PATH` variable to locate file | Argument-passing convention | Environment settings | +|---|---|---|---| +| **`_execl`**, **`_spawnl`** | No | List | Inherited from calling process | +| **`_execle`**, **`_spawnle`** | No | List | Pointer to environment table for new process passed as last argument | +| **`_execlp`**, **`_spawnlp`** | Yes | List | Inherited from calling process | +| **`_execvpe`**, **`_spawnvpe`** | Yes | Array | Pointer to environment table for new process passed as last argument | +| **`_execlpe`**, **`_spawnlpe`** | Yes | List | Pointer to environment table for new process passed as last argument | +| **`_execv`**, **`_spawnv`** | No | Array | Inherited from calling process | +| **`_execve`**, **`_spawnve`** | No | Array | Pointer to environment table for new process passed as last argument | +| **`_execvp`**, **`_spawnvp`** | Yes | Array | Inherited from calling process | ## See also diff --git a/docs/c-runtime-library/rand-max.md b/docs/c-runtime-library/rand-max.md index af3c4b4344e..4fa2115b4ea 100644 --- a/docs/c-runtime-library/rand-max.md +++ b/docs/c-runtime-library/rand-max.md @@ -9,7 +9,7 @@ helpviewer_keywords: ["RAND_MAX constant"] ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/reference/abort.md b/docs/c-runtime-library/reference/abort.md index f14439b1bb5..9a8eca09a53 100644 --- a/docs/c-runtime-library/reference/abort.md +++ b/docs/c-runtime-library/reference/abort.md @@ -56,9 +56,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`abort`**|`` or ``| +| Routine | Required header | +|---|---| +| **`abort`** | `` or `` | ## Example diff --git a/docs/c-runtime-library/reference/abs-labs-llabs-abs64.md b/docs/c-runtime-library/reference/abs-labs-llabs-abs64.md index 21dc3404350..19dbdf4c9d9 100644 --- a/docs/c-runtime-library/reference/abs-labs-llabs-abs64.md +++ b/docs/c-runtime-library/reference/abs-labs-llabs-abs64.md @@ -6,7 +6,7 @@ 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"] api_type: ["DLLExport"] topic_type: ["apiref"] -f1_keywords: ["stdlib/_abs64", "math/abs", "_abs64", "abs", "labs", "math/labs", "llabs", "math/llabs", "cmath/abs"] +f1_keywords: ["_abs64", "STDLIB/_abs64", "abs", "CORECRT_MATH/abs", "STDLIB/abs", "CSTDLIB/abs", "labs", "CORECRT_MATH/labs", "llabs", "CORECRT_MATH/llabs"] helpviewer_keywords: ["absolute values", "abs function", "abs64 function", "_abs64 function", "calculating absolute values"] --- # `abs`, `labs`, `llabs`, `_abs64` @@ -47,10 +47,10 @@ Because C++ allows overloading, you can call overloads of **`abs`** that take an ## Requirements -|Routine|Required C header|Required C++ header| -|-------------|-----------------------|---------------------------| -|**`abs`**, **`labs`**, **`llabs`**|`` or ``|``, ``, `` or ``| -|**`_abs64`**|``|`` or ``| +| Routine | Required C header | Required C++ header | +|---|---|---| +| **`abs`**, **`labs`**, **`llabs`** | `` or `` | ``, ``, `` or `` | +| **`_abs64`** | `` | `` or `` | To use the overloaded versions of **`abs`** in C++, you must include the `` header. diff --git a/docs/c-runtime-library/reference/access-crt.md b/docs/c-runtime-library/reference/access-crt.md index 3177d78036a..7a6d411ca89 100644 --- a/docs/c-runtime-library/reference/access-crt.md +++ b/docs/c-runtime-library/reference/access-crt.md @@ -6,7 +6,7 @@ api_name: ["access"] 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_type: ["DLLExport"] topic_type: ["apiref"] -f1_keywords: ["access"] +f1_keywords: ["access", "CORECRT_IO/access"] helpviewer_keywords: ["access function"] ms.assetid: 65197793-bd0a-41c3-9c29-18de2d95d9a6 --- diff --git a/docs/c-runtime-library/reference/access-s-waccess-s.md b/docs/c-runtime-library/reference/access-s-waccess-s.md index 586f48371c0..5bb4f041b71 100644 --- a/docs/c-runtime-library/reference/access-s-waccess-s.md +++ b/docs/c-runtime-library/reference/access-s-waccess-s.md @@ -39,11 +39,11 @@ Permission setting. Each function returns 0 if the file has the given mode. The function returns an error code if the named file doesn't exist or isn't accessible in the given mode. In this case, the function returns an error code from the set as follows and also sets `errno` to the same value. -|errno value|Condition| -|-|-| -`EACCES`|Access denied. The file's permission setting doesn't allow specified access. -`ENOENT`|File name or path not found. -`EINVAL`|Invalid parameter. +| `errno` value | Condition | +|---|---| +| `EACCES` | Access denied. The file's permission setting doesn't allow specified access. | +| `ENOENT` | File name or path not found. | +| `EINVAL` | Invalid parameter. | For more information, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -51,12 +51,12 @@ For more information, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr` When used with files, the **`_access_s`** function determines whether the specified file exists and can be accessed as specified by the value of *`mode`*. When used with directories, **`_access_s`** determines only whether the specified directory exists. In Windows 2000 and later operating systems, all directories have read and write access. -|mode value|Checks file for| -|----------------|---------------------| -|00|Existence only.| -|02|Write permission.| -|04|Read permission.| -|06|Read and write permission.| +| *`mode`* value | Checks file for | +|---|---| +| 00 | Existence only. | +| 02 | Write permission. | +| 04 | Read permission. | +| 06 | Read and write permission. | Permission to read or write the file isn't enough to ensure the ability to open a file. For example, if a file is locked by another process, it might not be accessible even though **`_access_s`** returns 0. @@ -68,16 +68,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_taccess_s`|**`_access_s`**|**`_access_s`**|**`_waccess_s`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_taccess_s` | **`_access_s`** | **`_access_s`** | **`_waccess_s`** | ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_access_s`**|\|\| -|**`_waccess_s`**|\ or \|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_access_s`** | \ | \ | +| **`_waccess_s`** | \ or \ | \ | ## Example diff --git a/docs/c-runtime-library/reference/access-waccess.md b/docs/c-runtime-library/reference/access-waccess.md index 6d30fb93fe9..01b8b3a2d89 100644 --- a/docs/c-runtime-library/reference/access-waccess.md +++ b/docs/c-runtime-library/reference/access-waccess.md @@ -40,7 +40,7 @@ Read/write attribute. Each function returns 0 if the file has the given mode. The function returns -1 if the named file doesn't exist or doesn't have the given mode; in this case, `errno` is set as shown in the following table. | Value | Description | -|--|--| +|---|---| | `EACCES` | Access denied: the file's permission setting doesn't allow specified access. | | `ENOENT` | File name or path not found. | | `EINVAL` | Invalid parameter. | @@ -51,12 +51,12 @@ For more information about these and other return codes, see [`errno`, `_doserrn When used with files, the **`_access`** function determines whether the specified file or directory exists and has the attributes specified by the value of *`mode`*. When used with directories, **`_access`** determines only whether the specified directory exists; in Windows 2000 and later operating systems, all directories have read and write access. -|*`mode`* value|Checks file for| -|------------------|---------------------| -|00|Existence only| -|02|Write-only| -|04|Read-only| -|06|Read and write| +| *`mode`* value | Checks file for | +|---|---| +| 00 | Existence only | +| 02 | Write-only | +| 04 | Read-only | +| 06 | Read and write | This function only checks whether the file and directory are read-only or not, it doesn't check the filesystem security settings. For that you need an access token. For more information on filesystem security, see [Access tokens](/windows/win32/SecAuthZ/access-tokens). An ATL class exists to provide this functionality; see [`CAccessToken` Class](../../atl/reference/caccesstoken-class.md). @@ -68,16 +68,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_taccess`|**`_access`**|**`_access`**|**`_waccess`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_taccess` | **`_access`** | **`_access`** | **`_waccess`** | ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`_access`**|``|``| -|**`_waccess`**|`` or ``|``| +| Routine | Required header | Optional headers | +|---|---|---| +| **`_access`** | `` | `` | +| **`_waccess`** | `` or `` | `` | ## Example diff --git a/docs/c-runtime-library/reference/acos-acosf-acosl.md b/docs/c-runtime-library/reference/acos-acosf-acosl.md index 65dd6d63cef..459bda0e7b5 100644 --- a/docs/c-runtime-library/reference/acos-acosf-acosl.md +++ b/docs/c-runtime-library/reference/acos-acosf-acosl.md @@ -6,7 +6,7 @@ api_name: ["acosf", "acos", "acosl", "_o_acos", "_o_acosf"] 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"] topic_type: ["apiref"] -f1_keywords: ["acos", "acosl", "acosf", "math/acosf", "math/acosl"] +f1_keywords: ["acos", "CMATH/acos", "CORECRT_MATH/acos", "acosl", "CORECRT_MATH/acosl", "acosf", "CORECRT_MATH/acosf"] helpviewer_keywords: ["acos function", "acosl function", "acosf function", "trigonometric functions", "arccosine function"] --- # `acos`, `acosf`, `acosl` @@ -36,11 +36,11 @@ The **`acos`** function returns the arccosine of *`x`* in the range 0 to π radi By default, if *`x`* is less than -1 or greater than 1, **`acos`** returns an indefinite. -|Input|`SEH` exception|`Matherr` exception| -|-----------|-------------------|-----------------------| -|`± ∞`|`INVALID`|`_DOMAIN`| -|`± QNAN, IND`|none|`_DOMAIN`| -|`|x| > 1`|`INVALID`|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± INF | `INVALID` | `_DOMAIN` | +| ± QNaN, IND | none | `_DOMAIN` | +| `|x| > 1` | `INVALID` | `_DOMAIN` | ## Remarks @@ -52,10 +52,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`acos`**, **`acosf`**, **`acosl`**|``|``| -|**`acos()`** macro | `` || +| Routine | Required header | Optional headers | +|---|---|---| +| **`acos`**, **`acosf`**, **`acosl`** | `` | `` | +| **`acos`** macro | `` | | ## Example diff --git a/docs/c-runtime-library/reference/acosh-acoshf-acoshl.md b/docs/c-runtime-library/reference/acosh-acoshf-acoshl.md index 2dd55a042e6..bfaa6a32779 100644 --- a/docs/c-runtime-library/reference/acosh-acoshf-acoshl.md +++ b/docs/c-runtime-library/reference/acosh-acoshf-acoshl.md @@ -35,10 +35,10 @@ Floating-point value. The **`acosh`** functions return the inverse hyperbolic cosine (arc hyperbolic cosine) of *`x`*. These functions are valid over the domain *`x`* ≥ 1. If *`x`* is less than 1, `errno` is set to `EDOM`, and the result is a quiet NaN. If *`x`* is a quiet NaN, indefinite, or infinity, the same value is returned. -|Input|SEH Exception|`_matherr` Exception| -|-----------|-------------------|--------------------------| -|± QNAN, IND, INF|none|none| -|*`x`* < 1|none|none| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND, INF | none | none | +| *`x`* < 1 | none | none | ## Remarks @@ -50,10 +50,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`acosh`**, **`acoshf`**, **`acoshl`**|\|\| -|**acosh()** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`acosh`**, **`acoshf`**, **`acoshl`** | \ | \ | +| **`acosh`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/aligned-free-dbg.md b/docs/c-runtime-library/reference/aligned-free-dbg.md index 9ebb81e2e2a..335eb7bcd75 100644 --- a/docs/c-runtime-library/reference/aligned-free-dbg.md +++ b/docs/c-runtime-library/reference/aligned-free-dbg.md @@ -39,9 +39,9 @@ For information about how memory blocks are allocated, initialized, and managed ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_free_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_free_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/aligned-free.md b/docs/c-runtime-library/reference/aligned-free.md index 4416fbbce86..57f0c8a6bf2 100644 --- a/docs/c-runtime-library/reference/aligned-free.md +++ b/docs/c-runtime-library/reference/aligned-free.md @@ -37,9 +37,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_free`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_free`** | \ | ## Example diff --git a/docs/c-runtime-library/reference/aligned-malloc-dbg.md b/docs/c-runtime-library/reference/aligned-malloc-dbg.md index 5e93b451f49..3bd869b5973 100644 --- a/docs/c-runtime-library/reference/aligned-malloc-dbg.md +++ b/docs/c-runtime-library/reference/aligned-malloc-dbg.md @@ -55,9 +55,9 @@ For information about how memory blocks are allocated, initialized, and managed ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_malloc_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_malloc_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/aligned-malloc.md b/docs/c-runtime-library/reference/aligned-malloc.md index 42e0053649e..ce7b8f7dc25 100644 --- a/docs/c-runtime-library/reference/aligned-malloc.md +++ b/docs/c-runtime-library/reference/aligned-malloc.md @@ -49,9 +49,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_malloc`**|``| +| Routine | Required C header | C++ header | +|---|---|---| +| **`_aligned_malloc`** | `` | `` | ## Example diff --git a/docs/c-runtime-library/reference/aligned-msize-dbg.md b/docs/c-runtime-library/reference/aligned-msize-dbg.md index ceb5c57f2c6..59c29a626b8 100644 --- a/docs/c-runtime-library/reference/aligned-msize-dbg.md +++ b/docs/c-runtime-library/reference/aligned-msize-dbg.md @@ -51,9 +51,9 @@ For information about how memory blocks are allocated, initialized, and managed ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_msize_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_msize_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/aligned-msize.md b/docs/c-runtime-library/reference/aligned-msize.md index c73b2dd0e93..7124b141659 100644 --- a/docs/c-runtime-library/reference/aligned-msize.md +++ b/docs/c-runtime-library/reference/aligned-msize.md @@ -51,9 +51,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_msize`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_msize`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/aligned-offset-malloc-dbg.md b/docs/c-runtime-library/reference/aligned-offset-malloc-dbg.md index 99f2817cbec..1ba74be1cb1 100644 --- a/docs/c-runtime-library/reference/aligned-offset-malloc-dbg.md +++ b/docs/c-runtime-library/reference/aligned-offset-malloc-dbg.md @@ -65,9 +65,9 @@ For information about the allocation block types and how they're used, see [Type ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_offset_malloc_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_offset_malloc_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/aligned-offset-malloc.md b/docs/c-runtime-library/reference/aligned-offset-malloc.md index 82e664c283a..d96a96b0ad4 100644 --- a/docs/c-runtime-library/reference/aligned-offset-malloc.md +++ b/docs/c-runtime-library/reference/aligned-offset-malloc.md @@ -53,9 +53,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_offset_malloc`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_offset_malloc`** | \ | ## Example diff --git a/docs/c-runtime-library/reference/aligned-offset-realloc-dbg.md b/docs/c-runtime-library/reference/aligned-offset-realloc-dbg.md index b335e614750..1d15ec87937 100644 --- a/docs/c-runtime-library/reference/aligned-offset-realloc-dbg.md +++ b/docs/c-runtime-library/reference/aligned-offset-realloc-dbg.md @@ -65,9 +65,9 @@ For information about how memory blocks are allocated, initialized, and managed ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_offset_realloc_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_offset_realloc_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/aligned-offset-realloc.md b/docs/c-runtime-library/reference/aligned-offset-realloc.md index d0bde6b25fd..414985475a6 100644 --- a/docs/c-runtime-library/reference/aligned-offset-realloc.md +++ b/docs/c-runtime-library/reference/aligned-offset-realloc.md @@ -57,9 +57,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_offset_realloc`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_offset_realloc`** | \ | ## Example diff --git a/docs/c-runtime-library/reference/aligned-offset-recalloc-dbg.md b/docs/c-runtime-library/reference/aligned-offset-recalloc-dbg.md index 00815c22144..5cb27e2cfed 100644 --- a/docs/c-runtime-library/reference/aligned-offset-recalloc-dbg.md +++ b/docs/c-runtime-library/reference/aligned-offset-recalloc-dbg.md @@ -67,9 +67,9 @@ For information about how memory blocks are allocated, initialized, and managed ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_offset_recalloc_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_offset_recalloc_dbg`** | \ | ## See also diff --git a/docs/c-runtime-library/reference/aligned-offset-recalloc.md b/docs/c-runtime-library/reference/aligned-offset-recalloc.md index e6326a89b47..806b6e980f7 100644 --- a/docs/c-runtime-library/reference/aligned-offset-recalloc.md +++ b/docs/c-runtime-library/reference/aligned-offset-recalloc.md @@ -61,9 +61,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_offset_recalloc`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_offset_recalloc`** | \ | ## See also diff --git a/docs/c-runtime-library/reference/aligned-realloc-dbg.md b/docs/c-runtime-library/reference/aligned-realloc-dbg.md index 88c204d9913..046ed087e99 100644 --- a/docs/c-runtime-library/reference/aligned-realloc-dbg.md +++ b/docs/c-runtime-library/reference/aligned-realloc-dbg.md @@ -63,9 +63,9 @@ For information about how memory blocks are allocated, initialized, and managed ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_realloc_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_realloc_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/aligned-realloc.md b/docs/c-runtime-library/reference/aligned-realloc.md index ff9cc1312f4..1e9c1f211c4 100644 --- a/docs/c-runtime-library/reference/aligned-realloc.md +++ b/docs/c-runtime-library/reference/aligned-realloc.md @@ -51,9 +51,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_realloc`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_realloc`** | \ | ## Example diff --git a/docs/c-runtime-library/reference/aligned-recalloc-dbg.md b/docs/c-runtime-library/reference/aligned-recalloc-dbg.md index 31aa3a15f8d..40b3a04bb3a 100644 --- a/docs/c-runtime-library/reference/aligned-recalloc-dbg.md +++ b/docs/c-runtime-library/reference/aligned-recalloc-dbg.md @@ -67,9 +67,9 @@ For information about how memory blocks are allocated, initialized, and managed ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_recalloc_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_recalloc_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/aligned-recalloc.md b/docs/c-runtime-library/reference/aligned-recalloc.md index 176d3233e06..d37d65d4bb5 100644 --- a/docs/c-runtime-library/reference/aligned-recalloc.md +++ b/docs/c-runtime-library/reference/aligned-recalloc.md @@ -55,9 +55,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_aligned_recalloc`**|\| +| Routine | Required header | +|---|---| +| **`_aligned_recalloc`** | \ | ## See also diff --git a/docs/c-runtime-library/reference/alloca.md b/docs/c-runtime-library/reference/alloca.md index c2c6215f721..693bcebda9f 100644 --- a/docs/c-runtime-library/reference/alloca.md +++ b/docs/c-runtime-library/reference/alloca.md @@ -53,9 +53,9 @@ In addition to the above restrictions, when using the[`/clr` (Common Language Ru ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_alloca`**|``| +| Routine | Required header | +|---|---| +| **`_alloca`** | `` | ## Example diff --git a/docs/c-runtime-library/reference/amsg-exit.md b/docs/c-runtime-library/reference/amsg-exit.md index 272f2ab0cf4..ca2e19752d6 100644 --- a/docs/c-runtime-library/reference/amsg-exit.md +++ b/docs/c-runtime-library/reference/amsg-exit.md @@ -31,6 +31,6 @@ This function emits the runtime error message to `stderr` for console applicatio ## Requirements -|Routine|Required header| -|-------------|---------------------| -|_amsg_exit|internal.h| +| Routine | Required header | +|---|---| +| _amsg_exit | internal.h | diff --git a/docs/c-runtime-library/reference/asctime-s-wasctime-s.md b/docs/c-runtime-library/reference/asctime-s-wasctime-s.md index f0187351cbd..2f9c7688bb9 100644 --- a/docs/c-runtime-library/reference/asctime-s-wasctime-s.md +++ b/docs/c-runtime-library/reference/asctime-s-wasctime-s.md @@ -56,13 +56,13 @@ Zero if successful. If there's a failure, the invalid parameter handler is invok ### Error conditions -|*`buffer`*|*`numberOfElements`*|*`tmSource`*|Return|Value in *`buffer`*| -|--------------|------------------------|----------|------------|-----------------------| -|`NULL`|Any|Any|`EINVAL`|Not modified| -|Not `NULL` (points to valid memory)|0|Any|`EINVAL`|Not modified| -|Not `NULL`|0< *`numberOfElements`* < 26|Any|`EINVAL`|Empty string| -|Not `NULL`|>= 26|`NULL`|`EINVAL`|Empty string| -|Not `NULL`|>= 26|Invalid time structure or out of range values for components of the time|`EINVAL`|Empty string| +| *`buffer`* | *`numberOfElements`* | *`tmSource`* | Return | Value in *`buffer`* | +|---|---|---|---|---| +| `NULL` | Any | Any | `EINVAL` | Not modified | +| Not `NULL` (points to valid memory) | 0 | Any | `EINVAL` | Not modified | +| Not `NULL` | 0< *`numberOfElements`* < 26 | Any | `EINVAL` | Empty string | +| Not `NULL` | >= 26 | `NULL` | `EINVAL` | Empty string | +| Not `NULL` | >= 26 | Invalid time structure or out of range values for components of the time | `EINVAL` | Empty string | > [!NOTE] > Error conditions for **`wasctime_s`** are similar to **`asctime_s`** with the exception that the size limit is measured in words. @@ -71,17 +71,17 @@ Zero if successful. If there's a failure, the invalid parameter handler is invok The `asctime` function converts a time stored as a structure to a character string. The *`tmSource`* value is typically obtained from a call to `gmtime` or `localtime`. Both functions can be used to fill in a `tm` structure, as defined in TIME.H. -|timeptr member|Value| -|--------------------|-----------| -|`tm_hour`|Hours since midnight (0-23)| -|`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).| -|`tm_mday`|Day of month (1-31)| -|`tm_min`|Minutes after hour (0-59)| -|`tm_mon`|Month (0-11; January = 0)| -|`tm_sec`|Seconds after minute (0-59)| -|`tm_wday`|Day of week (0-6; Sunday = 0)| -|`tm_yday`|Day of year (0-365; January 1 = 0)| -|`tm_year`|Year (current year minus 1900)| +| timeptr member | Value | +|---|---| +| `tm_hour` | Hours since midnight (0-23) | +| `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). | +| `tm_mday` | Day of month (1-31) | +| `tm_min` | Minutes after hour (0-59) | +| `tm_mon` | Month (0-11; January = 0) | +| `tm_sec` | Seconds after minute (0-59) | +| `tm_wday` | Day of week (0-6; Sunday = 0) | +| `tm_yday` | Day of year (0-365; January 1 = 0) | +| `tm_year` | Year (current year minus 1900) | The converted character string is also adjusted according to the local time zone settings. For information about configuring the local time, see the [`time`, `_time32`, `_time64`](time-time32-time64.md), [`_ftime`, `_ftime32`, `_ftime64`](ftime-ftime32-ftime64.md), and [`localtime_s`, `_localtime32_s`, `_localtime64_s`](localtime-s-localtime32-s-localtime64-s.md) functions. For information about defining the time zone environment and global variables, see [`_tzset`](tzset.md). @@ -95,18 +95,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mapping -|TCHAR.H routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tasctime_s`**|**`asctime_s`**|**`asctime_s`**|**`_wasctime_s`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tasctime_s`** | **`asctime_s`** | **`asctime_s`** | **`_wasctime_s`** | In C++, using these functions is simplified by template overloads; the overloads can infer buffer length automatically, eliminating the need to specify a size argument. For more information, see [Secure template overloads](../secure-template-overloads.md). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`asctime_s`**|\| -|**`_wasctime_s`**|\ or \| +| Routine | Required header | +|---|---| +| **`asctime_s`** | \ | +| **`_wasctime_s`** | \ or \ | ## Security diff --git a/docs/c-runtime-library/reference/asctime-wasctime.md b/docs/c-runtime-library/reference/asctime-wasctime.md index fd1a390a301..69f30682ebb 100644 --- a/docs/c-runtime-library/reference/asctime-wasctime.md +++ b/docs/c-runtime-library/reference/asctime-wasctime.md @@ -40,17 +40,17 @@ More secure versions of these functions are available; see [`asctime_s`, `_wasct 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. -|`timeptr` member|Value| -|--------------------|-----------| -|`tm_hour`|Hours since midnight (0-23)| -|`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).| -|`tm_mday`|Day of month (1-31)| -|`tm_min`|Minutes after hour (0-59)| -|`tm_mon`|Month (0-11; January = 0)| -|`tm_sec`|Seconds after minute (0-59)| -|`tm_wday`|Day of week (0-6; Sunday = 0)| -|`tm_yday`|Day of year (0-365; January 1 = 0)| -|`tm_year`|Year (current year minus 1900)| +| `timeptr` member | Value | +|---|---| +| `tm_hour` | Hours since midnight (0-23) | +| `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). | +| `tm_mday` | Day of month (1-31) | +| `tm_min` | Minutes after hour (0-59) | +| `tm_mon` | Month (0-11; January = 0) | +| `tm_sec` | Seconds after minute (0-59) | +| `tm_wday` | Day of week (0-6; Sunday = 0) | +| `tm_yday` | Day of year (0-365; January 1 = 0) | +| `tm_year` | Year (current year minus 1900) | 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. @@ -64,16 +64,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mapping -|TCHAR.H routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tasctime`|**`asctime`**|**`asctime`**|**`_wasctime`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tasctime` | **`asctime`** | **`asctime`** | **`_wasctime`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`asctime`**|\| -|**`_wasctime`**|\ or \| +| Routine | Required header | +|---|---| +| **`asctime`** | \ | +| **`_wasctime`** | \ or \ | ## Example diff --git a/docs/c-runtime-library/reference/asin-asinf-asinl.md b/docs/c-runtime-library/reference/asin-asinf-asinl.md index 8993cf127bd..81c2f19df89 100644 --- a/docs/c-runtime-library/reference/asin-asinf-asinl.md +++ b/docs/c-runtime-library/reference/asin-asinf-asinl.md @@ -36,11 +36,11 @@ The **`asin`** function returns the arcsine (the inverse sine function) of *`x`* By default, if *`x`* is less than -1 or greater than 1, **`asin`** returns an indefinite. -|Input|SEH exception|`Matherr` exception| -|-----------|-------------------|-----------------------| -|`± ∞`|`INVALID`|`_DOMAIN`| -|`± QNAN`, `IND`|none|`_DOMAIN`| -|`|x| > 1`|`INVALID`|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± INF | `INVALID` | `_DOMAIN` | +| ± QNaN, IND | none | `_DOMAIN` | +| `|x| > 1` | `INVALID` | `_DOMAIN` | ## Remarks @@ -52,10 +52,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header (C)|Required header (C++)| -|-------------|---------------------|-| -|**`asin`**, **`asinf`**, **`asinl`**|``|`` or ``| -|**`asin()`** macro | `` || +| Routine | Required header (C) | Required header (C++) | +|---|---|---| +| **`asin`**, **`asinf`**, **`asinl`** | `` | `` or `` | +| **`asin`** macro | `` | | ## Example diff --git a/docs/c-runtime-library/reference/asinh-asinhf-asinhl.md b/docs/c-runtime-library/reference/asinh-asinhf-asinhl.md index 00858723737..5efde20f761 100644 --- a/docs/c-runtime-library/reference/asinh-asinhf-asinhl.md +++ b/docs/c-runtime-library/reference/asinh-asinhf-asinhl.md @@ -35,9 +35,9 @@ Floating-point value. 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. -|Input|SEH Exception|`_matherr` Exception| -|-----------|-------------------|--------------------------| -|± QNAN, IND, INF|none|none| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND, INF | none | none | ## Remarks @@ -49,10 +49,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required C header|Required C++ header| -|--------------|--------------|------------------| -|**`asinh`**, **`asinhf`**, **`asinhl`**|\|\ or \| -|**asinh()** macro | \ || +| Function | Required C header | Required C++ header | +|---|---|---| +| **`asinh`**, **`asinhf`**, **`asinhl`** | \ | \ or \ | +| **asinh()** macro | \ | | For additional compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/assert-asserte-assert-expr-macros.md b/docs/c-runtime-library/reference/assert-asserte-assert-expr-macros.md index c24bf84e0ea..2067b8fa6a6 100644 --- a/docs/c-runtime-library/reference/assert-asserte-assert-expr-macros.md +++ b/docs/c-runtime-library/reference/assert-asserte-assert-expr-macros.md @@ -57,9 +57,9 @@ Although `_ASSERT_EXPR`, `_ASSERT` and `_ASSERTE` are macros and are available b ## Requirements -|Macro|Required header| -|-----------|---------------------| -|`_ASSERT_EXPR`, `_ASSERT`, `_ASSERTE`|``| +| Macro | Required header | +|---|---| +| `_ASSERT_EXPR`, `_ASSERT`, `_ASSERTE` | `` | ## Example diff --git a/docs/c-runtime-library/reference/assert-macro-assert-wassert.md b/docs/c-runtime-library/reference/assert-macro-assert-wassert.md index c7b26da77ac..4601d51fb1e 100644 --- a/docs/c-runtime-library/reference/assert-macro-assert-wassert.md +++ b/docs/c-runtime-library/reference/assert-macro-assert-wassert.md @@ -62,11 +62,11 @@ After `assert` displays its message, it calls [`abort`](abort.md), which display 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. -|Error mode|Output to `stderr` (Console/`_OUT_TO_STDERR`)|Display Dialog Box (Windows/`_OUT_TO_MSGBOX`)| -|----------|----------------|------------------| -|`Abort`|Exit immediately with exit code 3|Exit immediately with exit code 3| -|`Retry`|Break into debugger during `abort`|Break into debugger during `assert`| -|`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)| +| Error mode | Output to `stderr` (Console/`_OUT_TO_STDERR`) | Display Dialog Box (Windows/`_OUT_TO_MSGBOX`) | +|---|---|---| +| `Abort` | Exit immediately with exit code 3 | Exit immediately with exit code 3 | +| `Retry` | Break into debugger during `abort` | Break into debugger during `assert` | +| `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) | For more information about CRT debugging, see [CRT debugging techniques](/visualstudio/debugger/crt-debugging-techniques). @@ -76,9 +76,9 @@ The `assert` macro is enabled in both the release and debug versions of the C ru ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`assert`, `_wassert`|``| +| Routine | Required header | +|---|---| +| `assert`, `_wassert` | `` | The signature of the `_assert` function isn't available in a header file. The signature of the `_wassert` function is only available when the `NDEBUG` macro isn't defined. diff --git a/docs/c-runtime-library/reference/atan-atanf-atanl-atan2-atan2f-atan2l.md b/docs/c-runtime-library/reference/atan-atanf-atanl-atan2-atan2f-atan2l.md index accf5003331..691d8b4a215 100644 --- a/docs/c-runtime-library/reference/atan-atanf-atanl-atan2-atan2f-atan2l.md +++ b/docs/c-runtime-library/reference/atan-atanf-atanl-atan2-atan2f-atan2l.md @@ -44,9 +44,9 @@ Any numbers. **`atan2`** uses the signs of both parameters to determine the quadrant of the return value. -|Input|SEH exception|`Matherr` exception| -|-----------|-------------------|-----------------------| -|± QNAN, IND|none|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | `_DOMAIN` | ## Remarks @@ -62,10 +62,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header (C)|Required header (C++)| -|-------------|---------------------|-| -|**`atan`**, **`atan2`**, **`atanf`**, **`atan2f`**, **`atanl`**, **`atan2l`**|``|`` or ``| -|**`atan()`**, **`atan2`** macros | `` || +| Routine | Required header (C) | Required header (C++) | +|---|---|---| +| **`atan`**, **`atan2`**, **`atanf`**, **`atan2f`**, **`atanl`**, **`atan2l`** | `` | `` or `` | +| **`atan`**, **`atan2`** macros | `` | | ## Example diff --git a/docs/c-runtime-library/reference/atanh-atanhf-atanhl.md b/docs/c-runtime-library/reference/atanh-atanhf-atanhl.md index 8b2a3f9d16d..0833e58baf9 100644 --- a/docs/c-runtime-library/reference/atanh-atanhf-atanhl.md +++ b/docs/c-runtime-library/reference/atanh-atanhf-atanhl.md @@ -35,10 +35,10 @@ Floating-point value. 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`. -|Input|SEH Exception|`Matherr` Exception| -|-----------|-------------------|-------------------------| -|± QNAN, IND|none|none| -|*`X`* ≥ 1; *`x`* ≤ -1|none|none| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | none | +| *`X`* ≥ 1; *`x`* ≤ -1 | none | none | ## Remarks @@ -50,10 +50,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`atanh`**, **`atanhf`**, **`atanhl`**|\|\ or \| -|**atanh()** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`atanh`**, **`atanhf`**, **`atanhl`** | \ | \ or \ | +| **`atanh`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/atexit.md b/docs/c-runtime-library/reference/atexit.md index 744cbe24ea6..1264498d49f 100644 --- a/docs/c-runtime-library/reference/atexit.md +++ b/docs/c-runtime-library/reference/atexit.md @@ -40,9 +40,9 @@ To generate an ANSI-conformant application, use the ANSI-standard **`atexit`** f ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`atexit`**|``| +| Routine | Required header | +|---|---| +| **`atexit`** | `` | ## Example diff --git a/docs/c-runtime-library/reference/atodbl-atodbl-l-atoldbl-atoldbl-l-atoflt-atoflt-l.md b/docs/c-runtime-library/reference/atodbl-atodbl-l-atoldbl-atoldbl-l-atoflt-atoflt-l.md index 465f2fa2ed8..d75b266ec3d 100644 --- a/docs/c-runtime-library/reference/atodbl-atodbl-l-atoldbl-atoldbl-l-atoflt-atoflt-l.md +++ b/docs/c-runtime-library/reference/atodbl-atodbl-l-atoldbl-atoldbl-l-atoflt-atoflt-l.md @@ -52,9 +52,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routines|Required header| -|--------------|---------------------| -|**`_atodbl`**, **`_atoldbl`**, **`_atoflt`**

**`_atodbl_l`**, **`_atoldbl_l`**, **`_atoflt_l`**|\| +| Routines | Required header | +|---|---| +| **`_atodbl`**, **`_atoldbl`**, **`_atoflt`**

**`_atodbl_l`**, **`_atoldbl_l`**, **`_atoflt_l`** | \ | ## Example diff --git a/docs/c-runtime-library/reference/atof-atof-l-wtof-wtof-l.md b/docs/c-runtime-library/reference/atof-atof-l-wtof-wtof-l.md index f9116341bba..cf90de7fe09 100644 --- a/docs/c-runtime-library/reference/atof-atof-l-wtof-wtof-l.md +++ b/docs/c-runtime-library/reference/atof-atof-l-wtof-wtof-l.md @@ -67,17 +67,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tstof`**|**`atof`**|**`atof`**|**`_wtof`**| -|**`_ttof`**|**`atof`**|**`atof`**|**`_wtof`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tstof`** | **`atof`** | **`atof`** | **`_wtof`** | +| **`_ttof`** | **`atof`** | **`atof`** | **`_wtof`** | ## Requirements -|Routine(s)|Required header| -|------------------|---------------------| -|**`atof`**, **`_atof_l`**|C: `` or `` C++: ``, ``, `` or ``| -|**`_wtof`**, **`_wtof_l`**|C: `` or `` C++: ``, `` or ``| +| Routine(s) | Required header | +|---|---| +| **`atof`**, **`_atof_l`** | C: `` or `` C++: ``, ``, `` or `` | +| **`_wtof`**, **`_wtof_l`** | C: `` or `` C++: ``, `` or `` | ## Example diff --git a/docs/c-runtime-library/reference/atoi-atoi-l-wtoi-wtoi-l.md b/docs/c-runtime-library/reference/atoi-atoi-l-wtoi-wtoi-l.md index b960cf1042d..f5d9d60caba 100644 --- a/docs/c-runtime-library/reference/atoi-atoi-l-wtoi-wtoi-l.md +++ b/docs/c-runtime-library/reference/atoi-atoi-l-wtoi-wtoi-l.md @@ -63,17 +63,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tstoi`**|**`atoi`**|**`atoi`**|**`_wtoi`**| -|**`_ttoi`**|**`atoi`**|**`atoi`**|**`_wtoi`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tstoi`** | **`atoi`** | **`atoi`** | **`_wtoi`** | +| **`_ttoi`** | **`atoi`** | **`atoi`** | **`_wtoi`** | ## Requirements -|Routines|Required header| -|--------------|---------------------| -|**`atoi`**|``| -|**`_atoi_l`**, **`_wtoi`**, **`_wtoi_l`**|`` or ``| +| Routines | Required header | +|---|---| +| **`atoi`** | `` | +| **`_atoi_l`**, **`_wtoi`**, **`_wtoi_l`** | `` or `` | ## Example diff --git a/docs/c-runtime-library/reference/atoi64-atoi64-l-wtoi64-wtoi64-l.md b/docs/c-runtime-library/reference/atoi64-atoi64-l-wtoi64-wtoi64-l.md index a4d6622394a..52012f1f813 100644 --- a/docs/c-runtime-library/reference/atoi64-atoi64-l-wtoi64-wtoi64-l.md +++ b/docs/c-runtime-library/reference/atoi64-atoi64-l-wtoi64-wtoi64-l.md @@ -69,17 +69,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tstoi64`|**`_atoi64`**|**`_atoi64`**|**`_wtoi64`**| -|`_ttoi64`|**`_atoi64`**|**`_atoi64`**|**`_wtoi64`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tstoi64` | **`_atoi64`** | **`_atoi64`** | **`_wtoi64`** | +| `_ttoi64` | **`_atoi64`** | **`_atoi64`** | **`_wtoi64`** | ## Requirements -|Routines|Required header| -|--------------|---------------------| -|**`_atoi64`**, **`_atoi64_l`**|\| -|**`_wtoi64`**, **`_wtoi64_l`**|\ or \| +| Routines | Required header | +|---|---| +| **`_atoi64`**, **`_atoi64_l`** | \ | +| **`_wtoi64`**, **`_wtoi64_l`** | \ or \ | ## Example diff --git a/docs/c-runtime-library/reference/atol-atol-l-wtol-wtol-l.md b/docs/c-runtime-library/reference/atol-atol-l-wtol-wtol-l.md index 4a616139d13..96206e407d4 100644 --- a/docs/c-runtime-library/reference/atol-atol-l-wtol-wtol-l.md +++ b/docs/c-runtime-library/reference/atol-atol-l-wtol-wtol-l.md @@ -66,17 +66,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tstol`**|**`atol`**|**`atol`**|**`_wtol`**| -|**`_ttol`**|**`atol`**|**`atol`**|**`_wtol`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tstol`** | **`atol`** | **`atol`** | **`_wtol`** | +| **`_ttol`** | **`atol`** | **`atol`** | **`_wtol`** | ## Requirements -|Routines|Required header| -|--------------|---------------------| -|**`atol`**|``| -|**`_atol_l`**, **`_wtol`**, **`_wtol_l`**|`` and ``| +| Routines | Required header | +|---|---| +| **`atol`** | `` | +| **`_atol_l`**, **`_wtol`**, **`_wtol_l`** | `` and `` | ## Example diff --git a/docs/c-runtime-library/reference/atoll-atoll-l-wtoll-wtoll-l.md b/docs/c-runtime-library/reference/atoll-atoll-l-wtoll-wtoll-l.md index da0034b19c3..484a9fd84fd 100644 --- a/docs/c-runtime-library/reference/atoll-atoll-l-wtoll-wtoll-l.md +++ b/docs/c-runtime-library/reference/atoll-atoll-l-wtoll-wtoll-l.md @@ -69,18 +69,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tstoll`|**`atoll`**|**`atoll`**|**`_wtoll`**| -|`_tstoll_l`|**`_atoll_l`**|**`_atoll_l`**|**`_wtoll_l`**| -|`_ttoll`|**`_atoll`**|**`_atoll`**|**`_wtoll`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tstoll` | **`atoll`** | **`atoll`** | **`_wtoll`** | +| `_tstoll_l` | **`_atoll_l`** | **`_atoll_l`** | **`_wtoll_l`** | +| `_ttoll` | **`_atoll`** | **`_atoll`** | **`_wtoll`** | ## Requirements -|Routines|Required header| -|--------------|---------------------| -|**`atoll`**, **`_atoll_l`**|\| -|**`_wtoll`**, **`_wtoll_l`**|\ or \| +| Routines | Required header | +|---|---| +| **`atoll`**, **`_atoll_l`** | \ | +| **`_wtoll`**, **`_wtoll_l`** | \ or \ | ## Example diff --git a/docs/c-runtime-library/reference/beginthread-beginthreadex.md b/docs/c-runtime-library/reference/beginthread-beginthreadex.md index bc994136590..e40a5e17ef2 100644 --- a/docs/c-runtime-library/reference/beginthread-beginthreadex.md +++ b/docs/c-runtime-library/reference/beginthread-beginthreadex.md @@ -112,10 +112,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_beginthread`**|``| -|**`_beginthreadex`**|``| +| Routine | Required header | +|---|---| +| **`_beginthread`** | `` | +| **`_beginthreadex`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/bessel-functions-j0-j1-jn-y0-y1-yn.md b/docs/c-runtime-library/reference/bessel-functions-j0-j1-jn-y0-y1-yn.md index 325513f223f..7c786645162 100644 --- a/docs/c-runtime-library/reference/bessel-functions-j0-j1-jn-y0-y1-yn.md +++ b/docs/c-runtime-library/reference/bessel-functions-j0-j1-jn-y0-y1-yn.md @@ -55,25 +55,25 @@ Each of these routines returns a Bessel function of *`x`*. If *`x`* is negative The **`_j0`**, **`_j1`**, and **`_jn`** routines return Bessel functions of the first kind: orders 0, 1, and n, respectively. -|Input|SEH Exception|`Matherr` Exception| -|-----------|-------------------|-----------------------| -|`± QNAN`, `IND`|`INVALID`|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | `INVALID` | `_DOMAIN` | The **`_y0`**, **`_y1`**, and **`_yn`** routines return Bessel functions of the second kind: orders 0, 1, and n, respectively. -|Input|SEH Exception|`Matherr` Exception| -|-----------|-------------------|-----------------------| -|`± QNAN`, `IND`|`INVALID`|`_DOMAIN`| -|`± 0`|`ZERODIVIDE`|`_SING`| -|`|x| < 0.0`|`INVALID`|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | `INVALID` | `_DOMAIN` | +| ± 0 | `ZERODIVIDE` | `_SING` | +| `|x| < 0.0` | `INVALID` | `_DOMAIN` | 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). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_j0`**, **`_j1`**, **`_jn`**, **`_y0`**, **`_y1`**, **`_yn`**|\ (C++), \ (C, C++)| +| Routine | Required header | +|---|---| +| **`_j0`**, **`_j1`**, **`_jn`**, **`_y0`**, **`_y1`**, **`_yn`** | \ (C++), \ (C, C++) | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/bsearch-s.md b/docs/c-runtime-library/reference/bsearch-s.md index b0bc1ff4451..20b0c97694a 100644 --- a/docs/c-runtime-library/reference/bsearch-s.md +++ b/docs/c-runtime-library/reference/bsearch-s.md @@ -55,22 +55,22 @@ If invalid parameters are passed to the function, it invokes the invalid paramet ### Error conditions -|*`key`*|*`base`*|*`compare`*|*`number`*|*`width`*|`errno` value| -|-|-|-|-|-|-| -|`NULL`|any|any|any|any|`EINVAL`| -|any|`NULL`|any|!= 0|any|`EINVAL`| -|any|any|any|any|= 0|`EINVAL`| -|any|any|`NULL`|an|any|`EINVAL`| +| *`key`* | *`base`* | *`compare`* | *`number`* | *`width`* | `errno` value | +|---|---|---|---|---|---| +| `NULL` | any | any | any | any | `EINVAL` | +| any | `NULL` | any | != 0 | any | `EINVAL` | +| any | any | any | any | = 0 | `EINVAL` | +| any | any | `NULL` | an | any | `EINVAL` | ## Remarks The **`bsearch_s`** function performs a binary search of a sorted array of *`number`* elements, each of *`width`* bytes in size. The *`base`* value is a pointer to the base of the array to be searched, and *`key`* is the value being sought. The *`compare`* parameter is a pointer to a user-supplied routine that compares the requested key to an array element and returns one of the following values specifying their relationship: -|Value returned by *`compare`* routine|Description| -|-----------------------------------------|-----------------| -|\< 0|Key is less than array element.| -|0|Key is equal to array element.| -|> 0|Key is greater than array element.| +| Value returned by *`compare`* routine | Description | +|---|---| +| \< 0 | Key is less than array element. | +| 0 | Key is equal to array element. | +| > 0 | Key is greater than array element. | The *`context`* pointer may be useful if the searched data structure is part of an object, and the compare function needs to access members of the object. The *`compare`* function may cast the void pointer into the appropriate object type and access members of that object. The addition of the *`context`* parameter makes **`bsearch_s`** more secure, since the context may be used to avoid reentrancy bugs associated with using static variables to make data available to the *`compare`* function. @@ -78,9 +78,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`bsearch_s`**|\ and \| +| Routine | Required header | +|---|---| +| **`bsearch_s`** | \ and \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/bsearch.md b/docs/c-runtime-library/reference/bsearch.md index de2f0f7b7b0..036ed6382eb 100644 --- a/docs/c-runtime-library/reference/bsearch.md +++ b/docs/c-runtime-library/reference/bsearch.md @@ -51,11 +51,11 @@ Callback function that compares two elements. The first is a pointer to the key The **`bsearch`** function performs a binary search of a sorted array of *`number`* elements, each of *`width`* bytes in size. The *`base`* value is a pointer to the base of the array to be searched, and *`key`* is the value being sought. The *`compare`* parameter is a pointer to a user-supplied routine that compares the requested key to an array element. It returns one of the following values that specify their relationship: -|Value returned by *`compare`* routine|Description| -|-----------------------------------------|-----------------| -|`< 0`|Key is less than array element.| -|`0`|Key is equal to array element.| -|`> 0`|Key is greater than array element.| +| Value returned by *`compare`* routine | Description | +|---|---| +| `< 0` | Key is less than array element. | +| `0` | Key is equal to array element. | +| `> 0` | Key is greater than array element. | This function validates its parameters. If *`compare`*, *`key`* or *`number`* is `NULL`, or if *`base`* is `NULL` and *`number`* is nonzero, or if *`width`* is zero, the function invokes the invalid parameter handler, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `errno` is set to `EINVAL` and the function returns `NULL`. @@ -63,9 +63,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`bsearch`**|\ and \| +| Routine | Required header | +|---|---| +| **`bsearch`** | \ and \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/btowc.md b/docs/c-runtime-library/reference/btowc.md index 864197406a7..32296b92543 100644 --- a/docs/c-runtime-library/reference/btowc.md +++ b/docs/c-runtime-library/reference/btowc.md @@ -37,9 +37,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`btowc`**|\ or \| +| Routine | Required header | +|---|---| +| **`btowc`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/byteswap-uint64-byteswap-ulong-byteswap-ushort.md b/docs/c-runtime-library/reference/byteswap-uint64-byteswap-ulong-byteswap-ushort.md index f7095a5bdfa..5c63829355f 100644 --- a/docs/c-runtime-library/reference/byteswap-uint64-byteswap-ulong-byteswap-ushort.md +++ b/docs/c-runtime-library/reference/byteswap-uint64-byteswap-ulong-byteswap-ushort.md @@ -29,11 +29,11 @@ The integer to reverse byte order. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_byteswap_ushort`**|``| -|**`_byteswap_ulong`**|``| -|**`_byteswap_uint64`**|``| +| Routine | Required header | +|---|---| +| **`_byteswap_ushort`** | `` | +| **`_byteswap_ulong`** | `` | +| **`_byteswap_uint64`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/c16rtomb-c32rtomb1.md b/docs/c-runtime-library/reference/c16rtomb-c32rtomb1.md index 6bf22acd744..8e6069ca3c3 100644 --- a/docs/c-runtime-library/reference/c16rtomb-c32rtomb1.md +++ b/docs/c-runtime-library/reference/c16rtomb-c32rtomb1.md @@ -58,9 +58,9 @@ To convert UTF-16 characters into non-UTF-8 multibyte characters, use the [`wcst ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`c16rtomb`**, **`c32rtomb`**|C, C++: \| +| Routine | Required header | +|---|---| +| **`c16rtomb`**, **`c32rtomb`** | C, C++: \ | For compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cabs-cabsf-cabsl.md b/docs/c-runtime-library/reference/cabs-cabsf-cabsl.md index 93fd231b576..dbac4dbb891 100644 --- a/docs/c-runtime-library/reference/cabs-cabsf-cabsl.md +++ b/docs/c-runtime-library/reference/cabs-cabsf-cabsl.md @@ -49,9 +49,9 @@ Because C++ allows overloading, you can call overloads of **`cabs`** that take ` ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`cabs`**, **`cabsf`**, **`cabsl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`cabs`**, **`cabsf`**, **`cabsl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cabs.md b/docs/c-runtime-library/reference/cabs.md index 955c2fe6197..beb8c6db07b 100644 --- a/docs/c-runtime-library/reference/cabs.md +++ b/docs/c-runtime-library/reference/cabs.md @@ -39,9 +39,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_cabs`**|\| +| Routine | Required header | +|---|---| +| **`_cabs`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cacos-cacosf-cacosl.md b/docs/c-runtime-library/reference/cacos-cacosf-cacosl.md index 9828639f31c..661b09887c4 100644 --- a/docs/c-runtime-library/reference/cacos-cacosf-cacosl.md +++ b/docs/c-runtime-library/reference/cacos-cacosf-cacosl.md @@ -42,9 +42,9 @@ Because C++ allows overloading, you can call overloads of **`cacos`** that take ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`cacos`**, **`cacosf`**, **`cacosl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`cacos`**, **`cacosf`**, **`cacosl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cacosh-cacoshf-cacoshl.md b/docs/c-runtime-library/reference/cacosh-cacoshf-cacoshl.md index 618efebe7df..f9f0c7198b0 100644 --- a/docs/c-runtime-library/reference/cacosh-cacoshf-cacoshl.md +++ b/docs/c-runtime-library/reference/cacosh-cacoshf-cacoshl.md @@ -49,9 +49,9 @@ Because C++ allows overloading, you can call overloads of **`cacosh`** that take ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`cacosh`**, **`cacoshf`**, **`cacoshl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`cacosh`**, **`cacoshf`**, **`cacoshl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/callnewh.md b/docs/c-runtime-library/reference/callnewh.md index a7fe49f1fb4..e3ab2e701c3 100644 --- a/docs/c-runtime-library/reference/callnewh.md +++ b/docs/c-runtime-library/reference/callnewh.md @@ -12,7 +12,7 @@ ms.assetid: 4dcb73e9-6384-4d12-a973-a8807d4de7a8 --- # `_callnewh` -Calls the currently installed *new handler*. +Calls the currently installed *`new` handler*. ## Syntax @@ -25,30 +25,30 @@ int _callnewh( ### Parameters *`size`*\ -The amount of memory that the [new operator](../../cpp/new-operator-cpp.md) tried to allocate. +The amount of memory that the [`new` operator](../../cpp/new-operator-cpp.md) tried to allocate. ## Return value -|Value|Description| -|-----------|-----------------| -|0|Failure: Either no new handler is installed or no new handler is active.| -|1|Success: The new handler is installed and active. The memory allocation can be retried.| +| Value | Description | +|---|---| +| 0 | Failure: Either no `new` handler is installed or no `new` handler is active. | +| 1 | Success: The `new` handler is installed and active. The memory allocation can be retried. | ## Exceptions -This function throws [`bad_alloc`](../../standard-library/bad-alloc-class.md) if the *new handler* can't be located. +This function throws [`bad_alloc`](../../standard-library/bad-alloc-class.md) if the *`new` handler* can't be located. ## Remarks -The *new handler* is called if the [new operator](../../cpp/new-operator-cpp.md) fails to successfully allocate memory. The new handler might then initiate some appropriate action, such as freeing memory so that subsequent allocations succeed. +The *`new` handler* is called if the [`new` operator](../../cpp/new-operator-cpp.md) fails to successfully allocate memory. The `new` handler might then initiate some appropriate action, such as freeing memory so that subsequent allocations succeed. 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). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|_callnewh|internal.h| +| Routine | Required header | +|---|---| +| `_callnewh` | internal.h | ## See also diff --git a/docs/c-runtime-library/reference/calloc-dbg.md b/docs/c-runtime-library/reference/calloc-dbg.md index adb15a11d47..b480d041b1f 100644 --- a/docs/c-runtime-library/reference/calloc-dbg.md +++ b/docs/c-runtime-library/reference/calloc-dbg.md @@ -69,9 +69,9 @@ For information about how memory blocks are allocated, initialized, and managed ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_calloc_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_calloc_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/calloc.md b/docs/c-runtime-library/reference/calloc.md index bf6c646cc1b..3620e42fae5 100644 --- a/docs/c-runtime-library/reference/calloc.md +++ b/docs/c-runtime-library/reference/calloc.md @@ -58,9 +58,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`calloc`**|`` and ``| +| Routine | Required header | +|---|---| +| **`calloc`** | `` and `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/carg-cargf-cargl.md b/docs/c-runtime-library/reference/carg-cargf-cargl.md index 20efea1ace2..0635b71a2e0 100644 --- a/docs/c-runtime-library/reference/carg-cargf-cargl.md +++ b/docs/c-runtime-library/reference/carg-cargf-cargl.md @@ -52,10 +52,10 @@ If you use the \ `carg()` macro, the type of the argument determines w ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`carg`**, **`cargf`**, **`cargl`**|\|\| -|**`carg`** macro | \ || +| Routine | C header | C++ header | +|---|---|---| +| **`carg`**, **`cargf`**, **`cargl`** | \ | \ | +| **`carg`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/casin-casinf-casinl.md b/docs/c-runtime-library/reference/casin-casinf-casinl.md index fda418be33e..e6e24b16ab9 100644 --- a/docs/c-runtime-library/reference/casin-casinf-casinl.md +++ b/docs/c-runtime-library/reference/casin-casinf-casinl.md @@ -49,9 +49,9 @@ Because C++ allows overloading, you can call overloads of **`casin`** that take ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`casin`**, **`casinf`**, **`casinl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`casin`**, **`casinf`**, **`casinl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/casinh-casinhf-casinhl.md b/docs/c-runtime-library/reference/casinh-casinhf-casinhl.md index fc391657ec0..8065bac92cd 100644 --- a/docs/c-runtime-library/reference/casinh-casinhf-casinhl.md +++ b/docs/c-runtime-library/reference/casinh-casinhf-casinhl.md @@ -49,9 +49,9 @@ Because C++ allows overloading, you can call overloads of **`casinh`** that take ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`casinh`**, **`casinhf`**, **`casinhl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`casinh`**, **`casinhf`**, **`casinhl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/catan-catanf-catanl.md b/docs/c-runtime-library/reference/catan-catanf-catanl.md index b97babc7470..aa7746b3a89 100644 --- a/docs/c-runtime-library/reference/catan-catanf-catanl.md +++ b/docs/c-runtime-library/reference/catan-catanf-catanl.md @@ -42,9 +42,9 @@ Because C++ allows overloading, you can call overloads of **`catan`** that take ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`catan`**, **`catanf`**, **`catanl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`catan`**, **`catanf`**, **`catanl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/catanh-catanhf-catanhl.md b/docs/c-runtime-library/reference/catanh-catanhf-catanhl.md index ea5d017eee3..97b1628a265 100644 --- a/docs/c-runtime-library/reference/catanh-catanhf-catanhl.md +++ b/docs/c-runtime-library/reference/catanh-catanhf-catanhl.md @@ -49,9 +49,9 @@ Because C++ allows overloading, you can call overloads of **`catanh`** that take ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`catanh`**, **`catanhf`**, **`catanhl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`catanh`**, **`catanhf`**, **`catanhl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cbrt-cbrtf-cbrtl.md b/docs/c-runtime-library/reference/cbrt-cbrtf-cbrtl.md index 957e47536fb..62d2344b91e 100644 --- a/docs/c-runtime-library/reference/cbrt-cbrtf-cbrtl.md +++ b/docs/c-runtime-library/reference/cbrt-cbrtf-cbrtl.md @@ -44,9 +44,9 @@ Floating-point value The **`cbrt`** functions return the cube-root of *`x`*. -|Input|SEH Exception|`_matherr` Exception| -|-----------|-------------------|--------------------------| -|± ∞, QNAN, IND|none|none| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± INF, QNaN, IND | none | none | ## Remarks @@ -58,10 +58,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`cbrt`**, **`cbrtf`**, **`cbrtl`**|\|\| -|**`cbrt`** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`cbrt`**, **`cbrtf`**, **`cbrtl`** | \ | \ | +| **`cbrt`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cbuild-fcbuild-lcbuild.md b/docs/c-runtime-library/reference/cbuild-fcbuild-lcbuild.md index 0fe4d779d6a..54a1feffe83 100644 --- a/docs/c-runtime-library/reference/cbuild-fcbuild-lcbuild.md +++ b/docs/c-runtime-library/reference/cbuild-fcbuild-lcbuild.md @@ -39,9 +39,9 @@ The **`_Cbuild`**, **`_FCbuild`**, and **`_LCbuild`** functions simplify creatio ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`_Cbuild`**, **`_FCbuild`**, **`_LCbuild`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`_Cbuild`**, **`_FCbuild`**, **`_LCbuild`** | \ | \ | These functions are Microsoft-specific. The types `_Dcomplex`, `_Fcomplex`, and `_Lcomplex` are Microsoft-specific equivalents to the unimplemented C99 native types **`double _Complex`**, **`float _Complex`**, and **`long double _Complex`**, respectively. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ccos-ccosf-ccosl.md b/docs/c-runtime-library/reference/ccos-ccosf-ccosl.md index 6f2aa2cdbf2..9e690c8a46d 100644 --- a/docs/c-runtime-library/reference/ccos-ccosf-ccosl.md +++ b/docs/c-runtime-library/reference/ccos-ccosf-ccosl.md @@ -49,9 +49,9 @@ Because C++ allows overloading, you can call overloads of **`ccos`** that take a ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`ccos`**, **`ccosf`**, **`ccosl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`ccos`**, **`ccosf`**, **`ccosl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ccosh-ccoshf-ccoshl.md b/docs/c-runtime-library/reference/ccosh-ccoshf-ccoshl.md index 68e83f1a303..5097b025822 100644 --- a/docs/c-runtime-library/reference/ccosh-ccoshf-ccoshl.md +++ b/docs/c-runtime-library/reference/ccosh-ccoshf-ccoshl.md @@ -49,9 +49,9 @@ Because C++ allows overloading, you can call overloads of **`ccosh`** that take ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`ccosh`**, **`ccoshf`**, **`ccoshl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`ccosh`**, **`ccoshf`**, **`ccoshl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ceil-ceilf-ceill.md b/docs/c-runtime-library/reference/ceil-ceilf-ceill.md index 11de4191c67..77f1026d6f4 100644 --- a/docs/c-runtime-library/reference/ceil-ceilf-ceill.md +++ b/docs/c-runtime-library/reference/ceil-ceilf-ceill.md @@ -44,9 +44,9 @@ Floating-point value. The **`ceil`** functions return a floating-point value that represents the smallest integer that is greater than or equal to *`x`*. There's no error return. -|Input|SEH Exception|`Matherr` Exception| -|-----------|-------------------|-----------------------| -|± `QNAN`, `IND`|none|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | `_DOMAIN` | **`ceil`** 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). @@ -60,9 +60,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -| **`ceil`**, **`ceilf`**, **`ceill`**| \ | +| Routine | Required header | +|---|---| +| **`ceil`**, **`ceilf`**, **`ceill`** | \ | | **`ceil`** macro | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cexit-c-exit.md b/docs/c-runtime-library/reference/cexit-c-exit.md index c7fb4a44eb2..e0c9611630d 100644 --- a/docs/c-runtime-library/reference/cexit-c-exit.md +++ b/docs/c-runtime-library/reference/cexit-c-exit.md @@ -25,12 +25,12 @@ void _c_exit( void ); The **`_cexit`** function calls, in last-in, first-out (LIFO) order, the functions registered by `atexit` and `_onexit`. Then **`_cexit`** flushes all I/O buffers and closes all open streams before returning. **`_c_exit`** is the same as `_exit` but returns to the calling process without processing `atexit` or `_onexit` or flushing stream buffers. The behavior of `exit`, `_exit`, **`_cexit`**, and **`_c_exit`** is shown in the following table. -|Function|Behavior| -|--------------|--------------| -|`exit`|Performs complete C library termination procedures, terminates process, and exits with supplied status code.| -|`_exit`|Performs quick C library termination procedures, terminates process, and exits with supplied status code.| -|**`_cexit`**|Performs complete C library termination procedures and returns to caller, but doesn't terminate process.| -|**`_c_exit`**|Performs quick C library termination procedures and returns to caller, but doesn't terminate process.| +| Function | Behavior | +|---|---| +| `exit` | Performs complete C library termination procedures, terminates process, and exits with supplied status code. | +| `_exit` | Performs quick C library termination procedures, terminates process, and exits with supplied status code. | +| **`_cexit`** | Performs complete C library termination procedures and returns to caller, but doesn't terminate process. | +| **`_c_exit`** | Performs quick C library termination procedures and returns to caller, but doesn't terminate process. | When you call the **`_cexit`** or **`_c_exit`** functions, the destructors for any temporary or automatic objects that exist at the time of the call aren't called. An automatic object is an object that is defined in a function where the object isn't declared to be static. A temporary object is an object created by the compiler. To destroy an automatic object before calling **`_cexit`** or **`_c_exit`**, explicitly call the destructor for the object, as follows: @@ -42,10 +42,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_cexit`**|\| -|**`_c_exit`**|\| +| Routine | Required header | +|---|---| +| **`_cexit`** | \ | +| **`_c_exit`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cexp-cexpf-cexpl.md b/docs/c-runtime-library/reference/cexp-cexpf-cexpl.md index 3cb594d03f2..c2c221f1f2f 100644 --- a/docs/c-runtime-library/reference/cexp-cexpf-cexpl.md +++ b/docs/c-runtime-library/reference/cexp-cexpf-cexpl.md @@ -40,9 +40,9 @@ Because C++ allows overloading, you can call overloads of **`cexp`** that take a ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`cexp`**, **`cexpf`**, **`cexpl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`cexp`**, **`cexpf`**, **`cexpl`** | \ | \ | For compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cgets-s-cgetws-s.md b/docs/c-runtime-library/reference/cgets-s-cgetws-s.md index a2058bed4d5..6a20b5096bb 100644 --- a/docs/c-runtime-library/reference/cgets-s-cgetws-s.md +++ b/docs/c-runtime-library/reference/cgets-s-cgetws-s.md @@ -59,11 +59,11 @@ The return value is zero if successful; otherwise, an error code if a failure oc ### Error conditions -|*`buffer`*|*`numberOfElements`*|*`pSizeRead`*|Return|Contents of *`buffer`*| -|--------------|------------------------|-----------------|------------|--------------------------| -|`NULL`|any|any|`EINVAL`|n/a| -|not `NULL`|zero|any|`EINVAL`|not modified| -|not `NULL`|any|`NULL`|`EINVAL`|zero-length string| +| *`buffer`* | *`numberOfElements`* | *`pSizeRead`* | Return | Contents of *`buffer`* | +|---|---|---|---|---| +| `NULL` | any | any | `EINVAL` | n/a | +| not `NULL` | zero | any | `EINVAL` | not modified | +| not `NULL` | any | `NULL` | `EINVAL` | zero-length string | ## Remarks @@ -79,16 +79,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_cgetts_s`|**`_cgets_s`**|**`_cgets_s`**|**`_cgetws_s`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_cgetts_s` | **`_cgets_s`** | **`_cgets_s`** | **`_cgetws_s`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_cgets_s`**|\| -|**`_cgetws_s`**|\ or \| +| Routine | Required header | +|---|---| +| **`_cgets_s`** | \ | +| **`_cgetws_s`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/chdir-wchdir.md b/docs/c-runtime-library/reference/chdir-wchdir.md index 0b2e6ea3057..f356ee840bf 100644 --- a/docs/c-runtime-library/reference/chdir-wchdir.md +++ b/docs/c-runtime-library/reference/chdir-wchdir.md @@ -49,16 +49,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mapping -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_tchdir`**|**`_chdir`**|**`_chdir`**|**`_wchdir`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tchdir`** | **`_chdir`** | **`_chdir`** | **`_wchdir`** | ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_chdir`**|``|``| -|**`_wchdir`**|`` or ``|``| +| Routine | Required header | Optional header | +|---|---|---| +| **`_chdir`** | `` | `` | +| **`_wchdir`** | `` or `` | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/chdrive.md b/docs/c-runtime-library/reference/chdrive.md index ed945e51b6c..a91c6c0d473 100644 --- a/docs/c-runtime-library/reference/chdrive.md +++ b/docs/c-runtime-library/reference/chdrive.md @@ -46,9 +46,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_chdrive`**|\| +| Routine | Required header | +|---|---| +| **`_chdrive`** | \ | For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/chgsign-chgsignf-chgsignl.md b/docs/c-runtime-library/reference/chgsign-chgsignf-chgsignl.md index f5e803bf944..3377a6e345a 100644 --- a/docs/c-runtime-library/reference/chgsign-chgsignf-chgsignl.md +++ b/docs/c-runtime-library/reference/chgsign-chgsignf-chgsignl.md @@ -39,10 +39,10 @@ The **`_chgsign`** functions return a value that's equal to the floating-point a ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_chgsign`**|\| -|**`_chgsignf`**, **`_chgsignl`**|\| +| Routine | Required header | +|---|---| +| **`_chgsign`** | \ | +| **`_chgsignf`**, **`_chgsignl`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/chmod-wchmod.md b/docs/c-runtime-library/reference/chmod-wchmod.md index ff5abefbce9..08c669a7e9f 100644 --- a/docs/c-runtime-library/reference/chmod-wchmod.md +++ b/docs/c-runtime-library/reference/chmod-wchmod.md @@ -53,16 +53,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tchmod`|**`_chmod`**|**`_chmod`**|**`_wchmod`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tchmod` | **`_chmod`** | **`_chmod`** | **`_wchmod`** | ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_chmod`**|\|\, \, \| -|**`_wchmod`**|\ or \|\, \, \| +| Routine | Required header | Optional header | +|---|---|---| +| **`_chmod`** | \ | \, \, \ | +| **`_wchmod`** | \ or \ | \, \, \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/chsize-s.md b/docs/c-runtime-library/reference/chsize-s.md index 527a87840bc..c76000d6375 100644 --- a/docs/c-runtime-library/reference/chsize-s.md +++ b/docs/c-runtime-library/reference/chsize-s.md @@ -49,9 +49,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_chsize_s`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_chsize_s`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/chsize.md b/docs/c-runtime-library/reference/chsize.md index fe5eccbe1db..6c9a72c4662 100644 --- a/docs/c-runtime-library/reference/chsize.md +++ b/docs/c-runtime-library/reference/chsize.md @@ -47,9 +47,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_chsize`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_chsize`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cimag-cimagf-cimagl.md b/docs/c-runtime-library/reference/cimag-cimagf-cimagl.md index 23fd3ab185a..dfcdd2f3819 100644 --- a/docs/c-runtime-library/reference/cimag-cimagf-cimagl.md +++ b/docs/c-runtime-library/reference/cimag-cimagf-cimagl.md @@ -43,10 +43,10 @@ If you use the \ `cimag()` macro, the type of the argument determines ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`cimag`**, **`cimagf`**, **`cimagl`**|\|\| -|**`cimag`** macro | \ || +| Routine | C header | C++ header | +|---|---|---| +| **`cimag`**, **`cimagf`**, **`cimagl`** | \ | \ | +| **`cimag`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/clear87-clearfp.md b/docs/c-runtime-library/reference/clear87-clearfp.md index 289dd1f6154..e91fd1f7390 100644 --- a/docs/c-runtime-library/reference/clear87-clearfp.md +++ b/docs/c-runtime-library/reference/clear87-clearfp.md @@ -35,10 +35,10 @@ These functions are deprecated when compiling with [/clr (Common Language Runtim ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_clear87`**|\| -|**`_clearfp`**|\| +| Routine | Required header | +|---|---| +| **`_clear87`** | \ | +| **`_clearfp`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/clearerr-s.md b/docs/c-runtime-library/reference/clearerr-s.md index 8a1c47bb633..eacdea0a146 100644 --- a/docs/c-runtime-library/reference/clearerr-s.md +++ b/docs/c-runtime-library/reference/clearerr-s.md @@ -41,9 +41,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`clearerr_s`**|\| +| Routine | Required header | +|---|---| +| **`clearerr_s`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/clearerr.md b/docs/c-runtime-library/reference/clearerr.md index 23cd055b400..8ffd6c6f996 100644 --- a/docs/c-runtime-library/reference/clearerr.md +++ b/docs/c-runtime-library/reference/clearerr.md @@ -39,9 +39,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`clearerr`**|\| +| Routine | Required header | +|---|---| +| **`clearerr`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/clock.md b/docs/c-runtime-library/reference/clock.md index ee56c71453d..6d1d7d63b97 100644 --- a/docs/c-runtime-library/reference/clock.md +++ b/docs/c-runtime-library/reference/clock.md @@ -31,9 +31,9 @@ Given enough time, the value returned by **`clock`** can exceed the maximum posi ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`clock`**|``| +| Routine | Required header | +|---|---| +| **`clock`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/clog-clogf-clogl.md b/docs/c-runtime-library/reference/clog-clogf-clogl.md index 327fc684dea..833e6b3e775 100644 --- a/docs/c-runtime-library/reference/clog-clogf-clogl.md +++ b/docs/c-runtime-library/reference/clog-clogf-clogl.md @@ -45,13 +45,13 @@ The natural logarithm of *`z`*. The result is unbounded along the real axis and The possible return values are: -|z parameter|Return value| -|-----------------|------------------| -|Positive|The logarithm (base 10) of z| -|Zero|- ∞| -|Negative|NaN| -|NaN|NaN| -|+ ∞|+ ∞| +| *`z`* parameter | Return value | +|---|---| +| Positive | The logarithm (base 10) of *`z`* | +| Zero | - INF | +| Negative | NaN | +| NaN | NaN | +| + INF | + INF | ## Remarks @@ -59,9 +59,9 @@ Because C++ allows overloading, you can call overloads of **`clog`** that take a ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`clog`**, **`clogf`**, **`clogl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`clog`**, **`clogf`**, **`clogl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/clog10-clog10f-clog10l.md b/docs/c-runtime-library/reference/clog10-clog10f-clog10l.md index 48aa3f9b456..d5588e23168 100644 --- a/docs/c-runtime-library/reference/clog10-clog10f-clog10l.md +++ b/docs/c-runtime-library/reference/clog10-clog10f-clog10l.md @@ -36,13 +36,13 @@ The base of the logarithm. The possible return values are: -|z parameter|Return value| -|-----------------|------------------| -|Positive|The logarithm (base 10) of z| -|Zero|- ∞| -|Negative|NaN| -|NaN|NaN| -|+ ∞|+ ∞| +| *`z`* parameter | Return value | +|---|---| +| Positive | The logarithm (base 10) of *`z`* | +| Zero | - INF | +| Negative | NaN | +| NaN | NaN | +| + INF | + INF | ## Remarks @@ -50,9 +50,9 @@ Because C++ allows overloading, you can call overloads of **`clog10`** that take ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`clog10`**, **`clog10f`**, **`clog10l`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`clog10`**, **`clog10f`**, **`clog10l`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/close.md b/docs/c-runtime-library/reference/close.md index cb833dc5afa..576b046e75c 100644 --- a/docs/c-runtime-library/reference/close.md +++ b/docs/c-runtime-library/reference/close.md @@ -43,9 +43,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_close`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_close`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cmulcc-fcmulcc-lcmulcc.md b/docs/c-runtime-library/reference/cmulcc-fcmulcc-lcmulcc.md index 6318565ee01..cfffc2b3153 100644 --- a/docs/c-runtime-library/reference/cmulcc-fcmulcc-lcmulcc.md +++ b/docs/c-runtime-library/reference/cmulcc-fcmulcc-lcmulcc.md @@ -39,9 +39,9 @@ Because the built-in arithmetic operators don't work on the Microsoft implementa ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`_Cmulcc`**, **`_FCmulcc`**, **`_LCmulcc`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`_Cmulcc`**, **`_FCmulcc`**, **`_LCmulcc`** | \ | \ | These functions are Microsoft-specific. The types `_Dcomplex`, `_Fcomplex`, and `_Lcomplex` are Microsoft-specific equivalents to the unimplemented C99 native types **double _Complex**, **float _Complex**, and **long double _Complex**, respectively. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cmulcr-fcmulcr-lcmulcr.md b/docs/c-runtime-library/reference/cmulcr-fcmulcr-lcmulcr.md index 1439ab57a18..c6323ec167a 100644 --- a/docs/c-runtime-library/reference/cmulcr-fcmulcr-lcmulcr.md +++ b/docs/c-runtime-library/reference/cmulcr-fcmulcr-lcmulcr.md @@ -39,11 +39,11 @@ Because the built-in arithmetic operators don't work on the Microsoft implementa ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`_Cmulcr`**, **`_FCmulcr`**, **`_LCmulcr`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`_Cmulcr`**, **`_FCmulcr`**, **`_LCmulcr`** | \ | \ | -These functions are Microsoft-specific. The types `_Dcomplex`, `_Fcomplex`, and `_Lcomplex` are Microsoft-specific equivalents to the unimplemented C99 native types **double _Complex**, **float _Complex**, and **long double _Complex**, respectively. For more compatibility information, see [Compatibility](../compatibility.md). +These functions are Microsoft-specific. The types `_Dcomplex`, `_Fcomplex`, and `_Lcomplex` are Microsoft-specific equivalents to the unimplemented C99 native types **`double _Complex`**, **`float _Complex`**, and **`long double _Complex`**, respectively. For more compatibility information, see [Compatibility](../compatibility.md). ## See also diff --git a/docs/c-runtime-library/reference/commit.md b/docs/c-runtime-library/reference/commit.md index 8db999d572e..3e4d6b26051 100644 --- a/docs/c-runtime-library/reference/commit.md +++ b/docs/c-runtime-library/reference/commit.md @@ -41,9 +41,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`_commit`**|\|\| +| Routine | Required header | Optional headers | +|---|---|---| +| **`_commit`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/configthreadlocale.md b/docs/c-runtime-library/reference/configthreadlocale.md index dde64b270ec..eaccf7b2e06 100644 --- a/docs/c-runtime-library/reference/configthreadlocale.md +++ b/docs/c-runtime-library/reference/configthreadlocale.md @@ -49,9 +49,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_configthreadlocale`**|\``| +| Routine | Required header | +|---|---| +| **`_configthreadlocale`** | \`` | ## Example diff --git a/docs/c-runtime-library/reference/conj-conjf-conjl.md b/docs/c-runtime-library/reference/conj-conjf-conjl.md index 37161eda8e6..60b5e95ad99 100644 --- a/docs/c-runtime-library/reference/conj-conjf-conjl.md +++ b/docs/c-runtime-library/reference/conj-conjf-conjl.md @@ -52,10 +52,10 @@ If you use the \ `conj()` macro, the type of the argument determines w ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`conj`**, **`conjf`**, **`conjl`**|\|\| -|**`conj`** macro | \ || +| Routine | C header | C++ header | +|---|---|---| +| **`conj`**, **`conjf`**, **`conjl`** | \ | \ | +| **`conj`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/control87-controlfp-control87-2.md b/docs/c-runtime-library/reference/control87-controlfp-control87-2.md index 2d054af5f80..4f3f7cc98a0 100644 --- a/docs/c-runtime-library/reference/control87-controlfp-control87-2.md +++ b/docs/c-runtime-library/reference/control87-controlfp-control87-2.md @@ -98,19 +98,19 @@ These functions are ignored when you use [`/clr` (Common Language Runtime Compil For the `_MCW_EM` mask, clearing the mask sets the exception, which allows the hardware exception; setting the mask hides the exception. If a `_EM_UNDERFLOW` or `_EM_OVERFLOW` occurs, no hardware exception is thrown until the next floating-point instruction is executed. To generate a hardware exception immediately after `_EM_UNDERFLOW` or `_EM_OVERFLOW`, call the `FWAIT` MASM instruction. -|Mask|Hex value|Constant|Hex value| -|----------|---------------|--------------|---------------| -|`_MCW_DN` (Denormal control)|0x03000000|`_DN_SAVE`

`_DN_FLUSH`|0x00000000

0x01000000| -|`_MCW_EM` (Interrupt exception mask)|0x0008001F|`_EM_INVALID`

`_EM_DENORMAL`

`_EM_ZERODIVIDE`

`_EM_OVERFLOW`

`_EM_UNDERFLOW`

`_EM_INEXACT`|0x00000010

0x00080000

0x00000008

0x00000004

0x00000002

0x00000001| -|`_MCW_IC` (Infinity control)

(Not supported on ARM or x64 platforms.)|0x00040000|`_IC_AFFINE`

`_IC_PROJECTIVE`|0x00040000

0x00000000| -|`_MCW_RC` (Rounding control)|0x00000300|`_RC_CHOP`

`_RC_UP`

`_RC_DOWN`

`_RC_NEAR`|0x00000300

0x00000200

0x00000100

0x00000000| -|`_MCW_PC` (Precision control)

(Not supported on ARM or x64 platforms.)|0x00030000|`_PC_24` (24 bits)

`_PC_53` (53 bits)

`_PC_64` (64 bits)|0x00020000

0x00010000

0x00000000| +| Mask | Hex value | Constant | Hex value | +|---|---|---|---| +| `_MCW_DN` (Denormal control) | 0x03000000 | `_DN_SAVE`

`_DN_FLUSH` | 0x00000000

0x01000000 | +| `_MCW_EM` (Interrupt exception mask) | 0x0008001F | `_EM_INVALID`

`_EM_DENORMAL`

`_EM_ZERODIVIDE`

`_EM_OVERFLOW`

`_EM_UNDERFLOW`

`_EM_INEXACT` | 0x00000010

0x00080000

0x00000008

0x00000004

0x00000002

0x00000001 | +| `_MCW_IC` (Infinity control)

(Not supported on ARM or x64 platforms.) | 0x00040000 | `_IC_AFFINE`

`_IC_PROJECTIVE` | 0x00040000

0x00000000 | +| `_MCW_RC` (Rounding control) | 0x00000300 | `_RC_CHOP`

`_RC_UP`

`_RC_DOWN`

`_RC_NEAR` | 0x00000300

0x00000200

0x00000100

0x00000000 | +| `_MCW_PC` (Precision control)

(Not supported on ARM or x64 platforms.) | 0x00030000 | `_PC_24` (24 bits)

`_PC_53` (53 bits)

`_PC_64` (64 bits) | 0x00020000

0x00010000

0x00000000 | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_control87`**, **`_controlfp`**, **`_control87_2`**|``| +| Routine | Required header | +|---|---| +| **`_control87`**, **`_controlfp`**, **`_control87_2`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/controlfp-s.md b/docs/c-runtime-library/reference/controlfp-s.md index 2b7ff50f02b..bf4b087774b 100644 --- a/docs/c-runtime-library/reference/controlfp-s.md +++ b/docs/c-runtime-library/reference/controlfp-s.md @@ -89,19 +89,19 @@ By default, this function's global state is scoped to the application. To change For the `_MCW_EM` mask, clearing it sets the exception, which allows the hardware exception; setting it hides the exception. If a `_EM_UNDERFLOW` or `_EM_OVERFLOW` occurs, no hardware exception is thrown until the next floating-point instruction is executed. To generate a hardware exception immediately after `_EM_UNDERFLOW` or `_EM_OVERFLOW`, call the `FWAIT MASM` instruction. -|Mask|Hex value|Constant|Hex value| -|----------|---------------|--------------|---------------| -|`_MCW_DN` (Denormal control)|0x03000000|`_DN_SAVE`

`_DN_FLUSH`|0x00000000

0x01000000| -|`_MCW_EM` (Interrupt exception mask)|0x0008001F|`_EM_INVALID`

`_EM_DENORMAL`

`_EM_ZERODIVIDE`

`_EM_OVERFLOW`

`_EM_UNDERFLOW`

`_EM_INEXACT`|0x00000010

0x00080000

0x00000008

0x00000004

0x00000002

0x00000001| -|`_MCW_IC` (Infinity control)

(Not supported on ARM or x64 platforms.)|0x00040000|`_IC_AFFINE`

`_IC_PROJECTIVE`|0x00040000

0x00000000| -|`_MCW_RC` (Rounding control)|0x00000300|`_RC_CHOP`

`_RC_UP`

`_RC_DOWN`

`_RC_NEAR`|0x00000300

0x00000200

0x00000100

0x00000000| -|`_MCW_PC` (Precision control)

(Not supported on ARM or x64 platforms.)|0x00030000|`_PC_24` (24 bits)

`_PC_53` (53 bits)

`_PC_64` (64 bits)|0x00020000

0x00010000

0x00000000| +| Mask | Hex value | Constant | Hex value | +|---|---|---|---| +| `_MCW_DN` (Denormal control) | 0x03000000 | `_DN_SAVE`

`_DN_FLUSH` | 0x00000000

0x01000000 | +| `_MCW_EM` (Interrupt exception mask) | 0x0008001F | `_EM_INVALID`

`_EM_DENORMAL`

`_EM_ZERODIVIDE`

`_EM_OVERFLOW`

`_EM_UNDERFLOW`

`_EM_INEXACT` | 0x00000010

0x00080000

0x00000008

0x00000004

0x00000002

0x00000001 | +| `_MCW_IC` (Infinity control)

(Not supported on ARM or x64 platforms.) | 0x00040000 | `_IC_AFFINE`

`_IC_PROJECTIVE` | 0x00040000

0x00000000 | +| `_MCW_RC` (Rounding control) | 0x00000300 | `_RC_CHOP`

`_RC_UP`

`_RC_DOWN`

`_RC_NEAR` | 0x00000300

0x00000200

0x00000100

0x00000000 | +| `_MCW_PC` (Precision control)

(Not supported on ARM or x64 platforms.) | 0x00030000 | `_PC_24` (24 bits)

`_PC_53` (53 bits)

`_PC_64` (64 bits) | 0x00020000

0x00010000

0x00000000 | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_controlfp_s`**|``| +| Routine | Required header | +|---|---| +| **`_controlfp_s`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/copysign-copysignf-copysignl-copysign-copysignf-copysignl.md b/docs/c-runtime-library/reference/copysign-copysignf-copysignl-copysign-copysignf-copysignl.md index 5d13cdafd3d..8d979ab1f3e 100644 --- a/docs/c-runtime-library/reference/copysign-copysignf-copysignl-copysign-copysignf-copysignl.md +++ b/docs/c-runtime-library/reference/copysign-copysignf-copysignl-copysign-copysignf-copysignl.md @@ -70,11 +70,11 @@ If you use the \ `copysign()` macro, the type of the argument determin ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_copysign`**|\| -|**`copysign`**, **`copysignf`**, **`copysignl`**, **`_copysignf`**, **`_copysignl`**|\| -|**`copysign`** macro | \ | +| Routine | Required header | +|---|---| +| **`_copysign`** | \ | +| **`copysign`**, **`copysignf`**, **`copysignl`**, **`_copysignf`**, **`_copysignl`** | \ | +| **`copysign`** macro | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cos-cosf-cosl.md b/docs/c-runtime-library/reference/cos-cosf-cosl.md index da59b19aed3..713a7257b78 100644 --- a/docs/c-runtime-library/reference/cos-cosf-cosl.md +++ b/docs/c-runtime-library/reference/cos-cosf-cosl.md @@ -35,10 +35,10 @@ Angle in radians. The cosine 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. -|Input|SEH Exception|`Matherr` Exception| -|-----------|-------------------|-----------------------| -|± QNAN, IND|none|`_DOMAIN`| -|± INF|`INVALID`|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | `_DOMAIN` | +| ± INF | `INVALID` | `_DOMAIN` | ## Remarks @@ -50,10 +50,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required C header|Required C++ header| -|-------------|---------------------|-| -|**`cos`**, **`cosh`**, **`cosf`**|\|\ or \| -|**cos()** macro | \ || +| Routine | Required C header | Required C++ header | +|---|---|---| +| **`cos`**, **`cosh`**, **`cosf`** | \ | \ or \ | +| **cos()** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cosh-coshf-coshl.md b/docs/c-runtime-library/reference/cosh-coshf-coshl.md index 332e71ffb2d..e4353dee5db 100644 --- a/docs/c-runtime-library/reference/cosh-coshf-coshl.md +++ b/docs/c-runtime-library/reference/cosh-coshf-coshl.md @@ -36,10 +36,10 @@ The hyperbolic cosine of *`x`*. By default, if the result is too large in a **`cosh`**, **`coshf`**, or **`coshl`** call, the function returns `HUGE_VAL` and sets `errno` to `ERANGE`. -|Input|SEH exception|`Matherr` exception| -|-----------|-------------------|-----------------------| -|± QNAN, IND|none|`_DOMAIN`| -|*`x`* ≥ 7.104760e+002|`INEXACT`+`OVERFLOW`|`OVERFLOW`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | `_DOMAIN` | +| *`x`* ≥ 7.104760e+002 | `INEXACT`+`OVERFLOW` | `OVERFLOW` | ## Remarks @@ -51,10 +51,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header (C)|Required header (C++)| -|-------------|---------------------|-| -|**`coshf`**, **`cosl`**, **`coshl`**|``|`` or ``| -|**`coshf()`** macro | `` || +| Routine | Required header (C) | Required header (C++) | +|---|---|---| +| **`coshf`**, **`cosl`**, **`coshl`** | `` | `` or `` | +| **`coshf`** macro | `` | | For more compatibility information, see [Compatibility](../compatibility.md). @@ -65,9 +65,9 @@ See the example in [`sinh`, `sinhf`, `sinhl`](sinh-sinhf-sinhl.md). ## See also [Math and floating-point support](../floating-point-support.md)\ -[`acosh, acoshf, acoshl`](acosh-acoshf-acoshl.md)\ -[`asinh, asinhf, asinhl`](asinh-asinhf-asinhl.md)\ -[`atanh, atanhf, atanhl`](atanh-atanhf-atanhl.md)\ +[`acosh`, `acoshf`, `acoshl`](acosh-acoshf-acoshl.md)\ +[`asinh`, `asinhf`, `asinhl`](asinh-asinhf-asinhl.md)\ +[`atanh`, `atanhf`, `atanhl`](atanh-atanhf-atanhl.md)\ [`_matherr`](matherr.md)\ -[`sinh, sinhf, sinhl`](sinh-sinhf-sinhl.md)\ -[`tanh, tanhf, tanhl`](tanh-tanhf-tanhl.md) +[`sinh`, `sinhf`, `sinhl`](sinh-sinhf-sinhl.md)\ +[`tanh`, `tanhf`, `tanhl`](tanh-tanhf-tanhl.md) diff --git a/docs/c-runtime-library/reference/countof-macro.md b/docs/c-runtime-library/reference/countof-macro.md index e59086c0c0e..cec03ed26cd 100644 --- a/docs/c-runtime-library/reference/countof-macro.md +++ b/docs/c-runtime-library/reference/countof-macro.md @@ -36,9 +36,9 @@ Ensure that *`array`* is actually an array, not a pointer. In C, **`_countof`** ## Requirements -|Macro|Required header| -|-----------|---------------------| -|**`_countof`**|``| +| Macro | Required header | +|---|---| +| **`_countof`** | `` | ## Example diff --git a/docs/c-runtime-library/reference/cpow-cpowf-cpowl.md b/docs/c-runtime-library/reference/cpow-cpowf-cpowl.md index d81aef6d0f1..aad1d819dd9 100644 --- a/docs/c-runtime-library/reference/cpow-cpowf-cpowl.md +++ b/docs/c-runtime-library/reference/cpow-cpowf-cpowl.md @@ -52,9 +52,9 @@ Because C++ allows overloading, you can call overloads of **`cpow`** that take a ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`cpow`**, **`cpowf`**, **`cpowl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`cpow`**, **`cpowf`**, **`cpowl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md b/docs/c-runtime-library/reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md index f184719a092..55418b0ad26 100644 --- a/docs/c-runtime-library/reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md +++ b/docs/c-runtime-library/reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md @@ -67,17 +67,17 @@ The versions of these functions with the `_l` suffix are identical except that t ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcprintf`|**`_cprintf`**|**`_cprintf`**|**`_cwprintf`**| -|`_tcprintf_l`|**`_cprintf_l`**|**`_cprintf_l`**|**`_cwprintf_l`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcprintf` | **`_cprintf`** | **`_cprintf`** | **`_cwprintf`** | +| `_tcprintf_l` | **`_cprintf_l`** | **`_cprintf_l`** | **`_cwprintf_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_cprintf`**, **`_cprintf_l`**|\| -|**`_cwprintf`**, **`_cwprintf_l`**|\| +| Routine | Required header | +|---|---| +| **`_cprintf`**, **`_cprintf_l`** | \ | +| **`_cwprintf`**, **`_cwprintf_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cprintf-p-cprintf-p-l-cwprintf-p-cwprintf-p-l.md b/docs/c-runtime-library/reference/cprintf-p-cprintf-p-l-cwprintf-p-cwprintf-p-l.md index b83296c379c..5c99264be7a 100644 --- a/docs/c-runtime-library/reference/cprintf-p-cprintf-p-l-cwprintf-p-cwprintf-p-l.md +++ b/docs/c-runtime-library/reference/cprintf-p-cprintf-p-l-cwprintf-p-cwprintf-p-l.md @@ -72,17 +72,17 @@ Also, like `_cprintf_s` and `_cwprintf_s`, they validate the input pointer and t ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcprintf_p`|**`_cprintf_p`**|**`_cprintf_p`**|**`_cwprintf_p`**| -|`_tcprintf_p_l`|**`_cprintf_p_l`**|**`_cprintf_p_l`**|**`_cwprintf_p_l`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcprintf_p` | **`_cprintf_p`** | **`_cprintf_p`** | **`_cwprintf_p`** | +| `_tcprintf_p_l` | **`_cprintf_p_l`** | **`_cprintf_p_l`** | **`_cwprintf_p_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_cprintf_p`**, **`_cprintf_p_l`**|\| -|**`_cwprintf_p`**, **`_cwprintf_p_l`**|\| +| Routine | Required header | +|---|---| +| **`_cprintf_p`**, **`_cprintf_p_l`** | \ | +| **`_cwprintf_p`**, **`_cwprintf_p_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cprintf-s-cprintf-s-l-cwprintf-s-cwprintf-s-l.md b/docs/c-runtime-library/reference/cprintf-s-cprintf-s-l-cwprintf-s-cwprintf-s-l.md index 5678b7a6729..cab723ba690 100644 --- a/docs/c-runtime-library/reference/cprintf-s-cprintf-s-l-cwprintf-s-cwprintf-s-l.md +++ b/docs/c-runtime-library/reference/cprintf-s-cprintf-s-l-cwprintf-s-cwprintf-s-l.md @@ -71,17 +71,17 @@ Like the non-secure versions (see [`_cprintf`, `_cprintf_l`, `_cwprintf`, `_cwpr ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcprintf_s`|**`_cprintf_s`**|**`_cprintf_s`**|**`_cwprintf_s`**| -|`_tcprintf_s_l`|**`_cprintf_s_l`**|**`_cprintf_s_l`**|**`_cwprintf_s_l`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcprintf_s` | **`_cprintf_s`** | **`_cprintf_s`** | **`_cwprintf_s`** | +| `_tcprintf_s_l` | **`_cprintf_s_l`** | **`_cprintf_s_l`** | **`_cwprintf_s_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_cprintf_s`**, **`_cprintf_s_l`**|\| -|**`_cwprintf_s`**, **`_cwprintf_s_l`**|\| +| Routine | Required header | +|---|---| +| **`_cprintf_s`**, **`_cprintf_s_l`** | \ | +| **`_cwprintf_s`**, **`_cwprintf_s_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cproj-cprojf-cprojl.md b/docs/c-runtime-library/reference/cproj-cprojf-cprojl.md index 7105b710a2c..39bd6ca7d8a 100644 --- a/docs/c-runtime-library/reference/cproj-cprojf-cprojl.md +++ b/docs/c-runtime-library/reference/cproj-cprojf-cprojl.md @@ -52,10 +52,10 @@ If you use the \ `cproj()` macro, the type of the argument determines ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`cproj`**, **`cprojf`**, **`cprojl`**|\|\| -|**`cproj`** macro | \ || +| Routine | C header | C++ header | +|---|---|---| +| **`cproj`**, **`cprojf`**, **`cprojl`** | \ | \ | +| **`cproj`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cputs-cputws.md b/docs/c-runtime-library/reference/cputs-cputws.md index d288a4dc2a5..0f7c1c3df73 100644 --- a/docs/c-runtime-library/reference/cputs-cputws.md +++ b/docs/c-runtime-library/reference/cputs-cputws.md @@ -47,16 +47,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_cputts`|**`_cputs`**|**`_cputs`**|**`_cputws`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_cputts` | **`_cputs`** | **`_cputs`** | **`_cputws`** | ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_cputs`**|\|\| -|**`_cputws`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_cputs`** | \ | \ | +| **`_cputws`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/creal-crealf-creall.md b/docs/c-runtime-library/reference/creal-crealf-creall.md index f078b382778..40a36d933e1 100644 --- a/docs/c-runtime-library/reference/creal-crealf-creall.md +++ b/docs/c-runtime-library/reference/creal-crealf-creall.md @@ -43,10 +43,10 @@ If you use the \ `creal()` macro, the type of the argument determines ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`creal`**, **`crealf`**, **`creall`**|\|\| -|**`creal`** macro | \ || +| Routine | C header | C++ header | +|---|---|---| +| **`creal`**, **`crealf`**, **`creall`** | \ | \ | +| **`creal`** macro | \ | | The `_Fcomplex`, `_Dcomplex`, and `_Lcomplex` types are Microsoft-specific equivalents of the unimplemented native C99 types **float _Complex**, **double _Complex**, and **long double _Complex**, respectively. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/creat-wcreat.md b/docs/c-runtime-library/reference/creat-wcreat.md index 10ac46fc6f3..404fb92a687 100644 --- a/docs/c-runtime-library/reference/creat-wcreat.md +++ b/docs/c-runtime-library/reference/creat-wcreat.md @@ -39,11 +39,11 @@ Permission setting. These functions, if successful, return a file descriptor to the created file. Otherwise, the functions return -1 and set `errno` as shown in the following table. -|`errno` setting|Description| -|---------------------|-----------------| -|`EACCES`|*`filename`* specifies an existing read-only file or specifies a directory instead of a file.| -|`EMFILE`|No more file descriptors are available.| -|`ENOENT`|Specified file couldn't be found.| +| `errno` value | Description | +|---|---| +| `EACCES` | *`filename`* specifies an existing read-only file or specifies a directory instead of a file. | +| `EMFILE` | No more file descriptors are available. | +| `ENOENT` | Specified file couldn't be found. | If *`filename`* is `NULL`, these functions invoke the invalid parameter handler, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions set `errno` to `EINVAL` and return -1. @@ -57,17 +57,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcreat`|**`_creat`**|**`_creat`**|**`_wcreat`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcreat` | **`_creat`** | **`_creat`** | **`_wcreat`** | If the file specified by *`filename`* doesn't exist, a new file is created with the given permission setting and is opened for writing. If the file already exists and its permission setting allows writing, **`_creat`** truncates the file to length 0, destroying the previous contents, and opens it for writing. The permission setting, *`pmode`*, applies to newly created files only. The new file receives the specified permission setting after it's closed for the first time. The integer expression *`pmode`* contains one or both of the manifest constants `_S_IWRITE` and `_S_IREAD`, defined in SYS\Stat.h. When both constants are given, they're joined with the bitwise or operator ( **`|`** ). The *`pmode`* parameter is set to one of the following values. -|Value|Definition| -|-----------|----------------| -|`_S_IWRITE`|Writing permitted.| -|`_S_IREAD`|Reading permitted.| -|`_S_IREAD | _S_IWRITE`|Reading and writing permitted.| +| Value | Definition | +|---|---| +| `_S_IWRITE` | Writing permitted. | +| `_S_IREAD` | Reading permitted. | +| `_S_IREAD | _S_IWRITE` | Reading and writing permitted. | If write permission isn't given, the file is read-only. All files are always readable; it's impossible to give write-only permission. The modes `_S_IWRITE` and `_S_IREAD | _S_IWRITE` are then equivalent. Files opened using **`_creat`** are always opened in compatibility mode (see [`_sopen`](sopen-wsopen.md)) with `_SH_DENYNO`. @@ -75,10 +75,10 @@ If write permission isn't given, the file is read-only. All files are always rea ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_creat`**|\|\, \, \| -|**`_wcreat`**|\ or \|\, \, \| +| Routine | Required header | Optional header | +|---|---|---| +| **`_creat`** | \ | \, \, \ | +| **`_wcreat`** | \ or \ | \, \, \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/create-locale-wcreate-locale.md b/docs/c-runtime-library/reference/create-locale-wcreate-locale.md index 1159285cd5c..0339d5b76eb 100644 --- a/docs/c-runtime-library/reference/create-locale-wcreate-locale.md +++ b/docs/c-runtime-library/reference/create-locale-wcreate-locale.md @@ -70,10 +70,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_create_locale`**|\| -|**`_wcreate_locale`**|\ or \| +| Routine | Required header | +|---|---| +| **`_create_locale`** | \ | +| **`_wcreate_locale`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtcheckmemory.md b/docs/c-runtime-library/reference/crtcheckmemory.md index 1cfdb4d295f..df206aa1900 100644 --- a/docs/c-runtime-library/reference/crtcheckmemory.md +++ b/docs/c-runtime-library/reference/crtcheckmemory.md @@ -41,9 +41,9 @@ For more information about how **`_CrtCheckMemory`** can be used with other debu ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtCheckMemory`**|\| +| Routine | Required header | +|---|---| +| **`_CrtCheckMemory`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtdbgbreak.md b/docs/c-runtime-library/reference/crtdbgbreak.md index aef08343937..b3763e3cfa2 100644 --- a/docs/c-runtime-library/reference/crtdbgbreak.md +++ b/docs/c-runtime-library/reference/crtdbgbreak.md @@ -32,9 +32,9 @@ For more information about using other hook-capable run-time functions and writi ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtDbgBreak`**|\| +| Routine | Required header | +|---|---| +| **`_CrtDbgBreak`** | \ | ## Libraries diff --git a/docs/c-runtime-library/reference/crtdbgreport-crtdbgreportw.md b/docs/c-runtime-library/reference/crtdbgreport-crtdbgreportw.md index 6811a2f45a5..25218f63358 100644 --- a/docs/c-runtime-library/reference/crtdbgreport-crtdbgreportw.md +++ b/docs/c-runtime-library/reference/crtdbgreport-crtdbgreportw.md @@ -72,13 +72,13 @@ and [`_RPTFW`](rpt-rptf-rptw-rptfw-macros.md), use **`_CrtDbgReportW`** to gener The following table lists the available choices for the report mode or modes and file and the resulting behavior of **`_CrtDbgReport`** and **`_CrtDbgReportW`**. These options are defined as bit flags in \. -|Report mode|Report file|**`_CrtDbgReport`**, **`_CrtDbgReportW`** behavior| -|-----------------|-----------------|------------------------------------------------| -|`_CRTDBG_MODE_DEBUG`|Not applicable|Writes message by using Windows [`OutputDebugString`](/windows/win32/api/debugapi/nf-debugapi-outputdebugstringw) API.| -|`_CRTDBG_MODE_WNDW`|Not applicable|Calls Windows [`MessageBox`](/windows/win32/api/winuser/nf-winuser-messagebox) API to create message box to display the message along with **Abort**, **Retry**, and **Ignore** buttons. If a user chooses **Abort**, **`_CrtDbgReport`** or **`_CrtDbgReport`** immediately aborts. If a user chooses **Retry**, it returns 1. If a user chooses **Ignore**, execution continues and **`_CrtDbgReport`** and **`_CrtDbgReportW`** return 0. Choosing **Ignore** when an error condition exists often results in undefined behavior.| -|`_CRTDBG_MODE_FILE`|`__HFILE`|Writes message to user-supplied `HANDLE`, using the Windows [`WriteFile`](/windows/win32/api/fileapi/nf-fileapi-writefile) API and doesn't verify validity of file handle; the application is responsible for opening the report file and passing a valid file handle.| -|`_CRTDBG_MODE_FILE`|`_CRTDBG_FILE_STDERR`|Writes message to `stderr`.| -|`_CRTDBG_MODE_FILE`|`_CRTDBG_FILE_STDOUT`|Writes message to `stdout`.| +| Report mode | Report file | **`_CrtDbgReport`**, **`_CrtDbgReportW`** behavior | +|---|---|---| +| `_CRTDBG_MODE_DEBUG` | Not applicable | Writes message by using Windows [`OutputDebugString`](/windows/win32/api/debugapi/nf-debugapi-outputdebugstringw) API. | +| `_CRTDBG_MODE_WNDW` | Not applicable | Calls Windows [`MessageBox`](/windows/win32/api/winuser/nf-winuser-messagebox) API to create message box to display the message along with **Abort**, **Retry**, and **Ignore** buttons. If a user chooses **Abort**, **`_CrtDbgReport`** or **`_CrtDbgReport`** immediately aborts. If a user chooses **Retry**, it returns 1. If a user chooses **Ignore**, execution continues and **`_CrtDbgReport`** and **`_CrtDbgReportW`** return 0. Choosing **Ignore** when an error condition exists often results in undefined behavior. | +| `_CRTDBG_MODE_FILE` | `__HFILE` | Writes message to user-supplied `HANDLE`, using the Windows [`WriteFile`](/windows/win32/api/fileapi/nf-fileapi-writefile) API and doesn't verify validity of file handle; the application is responsible for opening the report file and passing a valid file handle. | +| `_CRTDBG_MODE_FILE` | `_CRTDBG_FILE_STDERR` | Writes message to `stderr`. | +| `_CRTDBG_MODE_FILE` | `_CRTDBG_FILE_STDOUT` | Writes message to `stdout`. | The report can be sent to one, two, or three destinations or to no destination at all. For more information about specifying the report mode or modes and report file, see the [`_CrtSetReportMode`](crtsetreportmode.md) and [`_CrtSetReportFile`](crtsetreportfile.md) functions. For more information about using the debug macros and reporting functions, see [Macros for reporting](/visualstudio/debugger/macros-for-reporting). @@ -86,10 +86,10 @@ If your application needs more flexibility than that provided by **`_CrtDbgRepor ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtDbgReport`**|\| -|**`_CrtDbgReportW`**|\| +| Routine | Required header | +|---|---| +| **`_CrtDbgReport`** | \ | +| **`_CrtDbgReportW`** | \ | **`_CrtDbgReport`** and **`_CrtDbgReportW`** are Microsoft extensions. For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtdoforallclientobjects.md b/docs/c-runtime-library/reference/crtdoforallclientobjects.md index 23619fffda5..9db4a22cfe4 100644 --- a/docs/c-runtime-library/reference/crtdoforallclientobjects.md +++ b/docs/c-runtime-library/reference/crtdoforallclientobjects.md @@ -43,9 +43,9 @@ If *`pfn`* is `NULL`, the invalid parameter handler is invoked, as described in ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtDoForAllClientObjects`**|\, \| +| Routine | Required header | +|---|---| +| **`_CrtDoForAllClientObjects`** | \, \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtdumpmemoryleaks.md b/docs/c-runtime-library/reference/crtdumpmemoryleaks.md index 26843ff4e18..bbcc1210b61 100644 --- a/docs/c-runtime-library/reference/crtdumpmemoryleaks.md +++ b/docs/c-runtime-library/reference/crtdumpmemoryleaks.md @@ -38,9 +38,9 @@ For more information about heap state functions and the **`_CrtMemState`** struc ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtDumpMemoryLeaks`**|``| +| Routine | Required header | +|---|---| +| **`_CrtDumpMemoryLeaks`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtgetallochook.md b/docs/c-runtime-library/reference/crtgetallochook.md index 75253914f1d..f37adc40c35 100644 --- a/docs/c-runtime-library/reference/crtgetallochook.md +++ b/docs/c-runtime-library/reference/crtgetallochook.md @@ -32,9 +32,9 @@ For more information about using other hook-capable run-time functions and writi ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtGetAllocHook`**|\| +| Routine | Required header | +|---|---| +| **`_CrtGetAllocHook`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtgetdumpclient.md b/docs/c-runtime-library/reference/crtgetdumpclient.md index ed82cb9bb31..df55f8a4282 100644 --- a/docs/c-runtime-library/reference/crtgetdumpclient.md +++ b/docs/c-runtime-library/reference/crtgetdumpclient.md @@ -32,9 +32,9 @@ For more information about using other hook-capable run-time functions and writi ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtGetDumpClient`**|\| +| Routine | Required header | +|---|---| +| **`_CrtGetDumpClient`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtgetreporthook.md b/docs/c-runtime-library/reference/crtgetreporthook.md index f8480b441db..54f48676960 100644 --- a/docs/c-runtime-library/reference/crtgetreporthook.md +++ b/docs/c-runtime-library/reference/crtgetreporthook.md @@ -32,9 +32,9 @@ For more information about using other hook-capable run-time functions and writi ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtGetReportHook`**|\| +| Routine | Required header | +|---|---| +| **`_CrtGetReportHook`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtismemoryblock.md b/docs/c-runtime-library/reference/crtismemoryblock.md index db2681efc50..12a1f2e07a9 100644 --- a/docs/c-runtime-library/reference/crtismemoryblock.md +++ b/docs/c-runtime-library/reference/crtismemoryblock.md @@ -64,9 +64,9 @@ For more information about how **`_CrtIsMemoryBlock`** can be used with other de ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtIsMemoryBlock`**|\| +| Routine | Required header | +|---|---| +| **`_CrtIsMemoryBlock`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtisvalidheappointer.md b/docs/c-runtime-library/reference/crtisvalidheappointer.md index 11601bdbed9..40d24affff4 100644 --- a/docs/c-runtime-library/reference/crtisvalidheappointer.md +++ b/docs/c-runtime-library/reference/crtisvalidheappointer.md @@ -44,9 +44,9 @@ For more information about how **`_CrtIsValidHeapPointer`** can be used with oth ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtIsValidHeapPointer`**|``| +| Routine | Required header | +|---|---| +| **`_CrtIsValidHeapPointer`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtisvalidpointer.md b/docs/c-runtime-library/reference/crtisvalidpointer.md index 5ef44268daa..2ced5ae22b1 100644 --- a/docs/c-runtime-library/reference/crtisvalidpointer.md +++ b/docs/c-runtime-library/reference/crtisvalidpointer.md @@ -53,9 +53,9 @@ For more information about how **`_CrtIsValidPointer`** can be used with other d ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtIsValidPointer`**|\| +| Routine | Required header | +|---|---| +| **`_CrtIsValidPointer`** | \ | **`_CrtIsValidPointer`** is a Microsoft extension. For compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtmemcheckpoint.md b/docs/c-runtime-library/reference/crtmemcheckpoint.md index de7a3d5ea88..d1d20858d91 100644 --- a/docs/c-runtime-library/reference/crtmemcheckpoint.md +++ b/docs/c-runtime-library/reference/crtmemcheckpoint.md @@ -39,9 +39,9 @@ If *`state`* is `NULL`, the invalid parameter handler is invoked, as described i ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtMemCheckpoint`**|\, \| +| Routine | Required header | +|---|---| +| **`_CrtMemCheckpoint`** | \, \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtmemdifference.md b/docs/c-runtime-library/reference/crtmemdifference.md index 4f3dae34042..6b783c68b94 100644 --- a/docs/c-runtime-library/reference/crtmemdifference.md +++ b/docs/c-runtime-library/reference/crtmemdifference.md @@ -42,7 +42,7 @@ If the difference in memory states is significant, **`_CrtMemDifference`** retur The **`_CrtMemDifference`** function compares *`oldState`* and *`newState`* and stores their differences in *`stateDiff`*, which can then be used by the app to detect memory leaks and other memory problems. When [`_DEBUG`](../debug.md) isn't defined, calls to **`_CrtMemDifference`** are removed during preprocessing. -*`newState`* and *`oldState`* must each be a valid pointer to a **`_CrtMemState`** structure, defined in `crtdbg.h`, that [`_CrtMemCheckpoint`](crtmemcheckpoint.md) has filled in before the call to **`_CrtMemDifference`**. *`stateDiff`* must be a pointer to a previously allocated instance of the **`_CrtMemState`** structure. If *`stateDiff`*, *`newState`*, or *`oldState`* is `NULL`, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, [`errno, _doserrno, _sys_errlist, and _sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md) is set to `EINVAL` and the function returns `FALSE`. +*`newState`* and *`oldState`* must each be a valid pointer to a **`_CrtMemState`** structure, defined in `crtdbg.h`, that [`_CrtMemCheckpoint`](crtmemcheckpoint.md) has filled in before the call to **`_CrtMemDifference`**. *`stateDiff`* must be a pointer to a previously allocated instance of the **`_CrtMemState`** structure. If *`stateDiff`*, *`newState`*, or *`oldState`* is `NULL`, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md) is set to `EINVAL` and the function returns `FALSE`. **`_CrtMemDifference`** compares the **`_CrtMemState`** field values of the blocks in *`oldState`* to the ones in *`newState`* and stores the result in *`stateDiff`*. When the number of allocated block types or total number of allocated blocks for each type differs between the two memory states, the difference in states is considered significant. The difference between the largest amount ever allocated at once for the two states and the difference between total allocations for the two states are also stored in *`stateDiff`*. @@ -52,9 +52,9 @@ For more information about heap state functions and the **`_CrtMemState`** struc ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_CrtMemDifference`**|``|``| +| Routine | Required header | Optional header | +|---|---|---| +| **`_CrtMemDifference`** | `` | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtmemdumpallobjectssince.md b/docs/c-runtime-library/reference/crtmemdumpallobjectssince.md index 094c743dcd1..215b33d999e 100644 --- a/docs/c-runtime-library/reference/crtmemdumpallobjectssince.md +++ b/docs/c-runtime-library/reference/crtmemdumpallobjectssince.md @@ -39,9 +39,9 @@ For more information about heap state functions and the `_CrtMemState` structure ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**_CrtMemDumpAll-ObjectsSince**|\| +| Routine | Required header | +|---|---| +| **_CrtMemDumpAll-ObjectsSince** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtmemdumpstatistics.md b/docs/c-runtime-library/reference/crtmemdumpstatistics.md index 8796e9b263f..1015da2d9f2 100644 --- a/docs/c-runtime-library/reference/crtmemdumpstatistics.md +++ b/docs/c-runtime-library/reference/crtmemdumpstatistics.md @@ -37,9 +37,9 @@ For more information about heap state functions and the `_CrtMemState` structure ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`_CrtMemDumpStatistics`**|\|\| +| Routine | Required header | Optional headers | +|---|---|---| +| **`_CrtMemDumpStatistics`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtreportblocktype.md b/docs/c-runtime-library/reference/crtreportblocktype.md index 5d9d2b17f2a..c433723ed30 100644 --- a/docs/c-runtime-library/reference/crtreportblocktype.md +++ b/docs/c-runtime-library/reference/crtreportblocktype.md @@ -39,9 +39,9 @@ For information about the allocation block types and how they're used, see [Type ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtReportBlockType`**|\| +| Routine | Required header | +|---|---| +| **`_CrtReportBlockType`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtsetallochook.md b/docs/c-runtime-library/reference/crtsetallochook.md index aa33324d3d1..f17713841f5 100644 --- a/docs/c-runtime-library/reference/crtsetallochook.md +++ b/docs/c-runtime-library/reference/crtsetallochook.md @@ -60,9 +60,9 @@ For more information about how **`_CrtSetAllocHook`** can be used with other mem ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtSetAllocHook`**|\| +| Routine | Required header | +|---|---| +| **`_CrtSetAllocHook`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtsetbreakalloc.md b/docs/c-runtime-library/reference/crtsetbreakalloc.md index 554fabba8f9..0e402b09e0d 100644 --- a/docs/c-runtime-library/reference/crtsetbreakalloc.md +++ b/docs/c-runtime-library/reference/crtsetbreakalloc.md @@ -41,9 +41,9 @@ For more information about how **`_CrtSetBreakAlloc`** can be used with other me ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtSetBreakAlloc`**|\| +| Routine | Required header | +|---|---| +| **`_CrtSetBreakAlloc`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtsetdbgflag.md b/docs/c-runtime-library/reference/crtsetdbgflag.md index d79683831e3..c9ac3570529 100644 --- a/docs/c-runtime-library/reference/crtsetdbgflag.md +++ b/docs/c-runtime-library/reference/crtsetdbgflag.md @@ -42,13 +42,13 @@ When [`_DEBUG`](../debug.md) isn't defined, calls to **`_CrtSetDbgFlag`** are re The following table lists the bit fields for **`_crtDbgFlag`** and describes their behavior. Because setting the bits results in increased diagnostic output and reduced program execution speed, these bits aren't set (turned off) by default. For more information about these bit fields, see [Heap state reporting functions](/visualstudio/debugger/crt-debug-heap-details). -|Bit field|Default|Description| -|---------------|-------------|-----------------| -|`_CRTDBG_ALLOC_MEM_DF`|ON|ON: Enable debug heap allocations and use of memory block type identifiers, such as `_CLIENT_BLOCK`. OFF: Add new allocations to heap's linked list, but set block type to `_IGNORE_BLOCK`.

Can also be combined with any of the heap-frequency check macros.| -|`_CRTDBG_CHECK_ALWAYS_DF`|OFF|ON: Call [`_CrtCheckMemory`](crtcheckmemory.md) at every allocation and deallocation request. OFF: **`_CrtCheckMemory`** must be called explicitly.

Heap-frequency check macros have no effect when this flag is set.| -|`_CRTDBG_CHECK_CRT_DF`|OFF|ON: Include `_CRT_BLOCK` types in leak detection and memory state difference operations. OFF: Memory used internally by the run-time library is ignored by these operations.

Can also be combined with any of the heap-frequency check macros.| -|`_CRTDBG_DELAY_FREE_MEM_DF`|OFF|ON: Keep freed memory blocks in the heap's linked list, assign them the `_FREE_BLOCK` type, and fill them with the byte value 0xDD. OFF: Don't keep freed blocks in the heap's linked list.

Can also be combined with any of the heap-frequency check macros.| -|`_CRTDBG_LEAK_CHECK_DF`|OFF|ON: Perform automatic leak checking at program exit through a call to [`_CrtDumpMemoryLeaks`](crtdumpmemoryleaks.md) and generate an error report if the application failed to free all the memory it allocated. OFF: Don't automatically perform leak checking at program exit.

Can also be combined with any of the heap-frequency check macros.| +| Bit field | Default | Description | +|---|---|---| +| `_CRTDBG_ALLOC_MEM_DF` | ON | ON: Enable debug heap allocations and use of memory block type identifiers, such as `_CLIENT_BLOCK`. OFF: Add new allocations to heap's linked list, but set block type to `_IGNORE_BLOCK`.

Can also be combined with any of the heap-frequency check macros. | +| `_CRTDBG_CHECK_ALWAYS_DF` | OFF | ON: Call [`_CrtCheckMemory`](crtcheckmemory.md) at every allocation and deallocation request. OFF: **`_CrtCheckMemory`** must be called explicitly.

Heap-frequency check macros have no effect when this flag is set. | +| `_CRTDBG_CHECK_CRT_DF` | OFF | ON: Include `_CRT_BLOCK` types in leak detection and memory state difference operations. OFF: Memory used internally by the run-time library is ignored by these operations.

Can also be combined with any of the heap-frequency check macros. | +| `_CRTDBG_DELAY_FREE_MEM_DF` | OFF | ON: Keep freed memory blocks in the heap's linked list, assign them the `_FREE_BLOCK` type, and fill them with the byte value 0xDD. OFF: Don't keep freed blocks in the heap's linked list.

Can also be combined with any of the heap-frequency check macros. | +| `_CRTDBG_LEAK_CHECK_DF` | OFF | ON: Perform automatic leak checking at program exit through a call to [`_CrtDumpMemoryLeaks`](crtdumpmemoryleaks.md) and generate an error report if the application failed to free all the memory it allocated. OFF: Don't automatically perform leak checking at program exit.

Can also be combined with any of the heap-frequency check macros. | **Heap-Check Frequency Macros** @@ -56,12 +56,12 @@ You can specify how often the C run-time library performs validation of the debu **`_CrtSetDbgFlag`** then inspects the upper 16 bits of the *`newFlag`* parameter for a value. The value specified is the number of **`malloc`**, **`realloc`**, **`free`**, and **`_msize`** calls between **`_CrtCheckMemory`** calls. Four predefined macros are provided for this purpose. -|Macro|Number of `malloc`, `realloc`, `free`, and `_msize` calls between calls to `_CrtCheckMemory`| -|-----------|------------------------------------------------------------------------------------------| -|`_CRTDBG_CHECK_EVERY_16_DF`|16| -|`_CRTDBG_CHECK_EVERY_128_DF`|128| -|`_CRTDBG_CHECK_EVERY_1024_DF`|1024| -|`_CRTDBG_CHECK_DEFAULT_DF`|0 (by default, no heap checks)| +| Macro | Number of `malloc`, `realloc`, `free`, and `_msize` calls between calls to `_CrtCheckMemory` | +|---|---| +| `_CRTDBG_CHECK_EVERY_16_DF` | 16 | +| `_CRTDBG_CHECK_EVERY_128_DF` | 128 | +| `_CRTDBG_CHECK_EVERY_1024_DF` | 1024 | +| `_CRTDBG_CHECK_DEFAULT_DF` | 0 (by default, no heap checks) | By default, **`_CrtCheckMemory`** isn't called during memory operations. You can change that by sending the flags shown above to [`_CrtSetDbgFlag()`](crtsetdbgflag.md). @@ -125,9 +125,9 @@ If *`newFlag`* isn't a valid value, this function invokes the invalid parameter ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtSetDbgFlag`**|``| +| Routine | Required header | +|---|---| +| **`_CrtSetDbgFlag`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtsetdebugfillthreshold.md b/docs/c-runtime-library/reference/crtsetdebugfillthreshold.md index 1e987bff958..bd91d7fa572 100644 --- a/docs/c-runtime-library/reference/crtsetdebugfillthreshold.md +++ b/docs/c-runtime-library/reference/crtsetdebugfillthreshold.md @@ -87,9 +87,9 @@ Here's a list of the affected functions: ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtSetDebugFillThreshold`**|\| +| Routine | Required header | +|---|---| +| **`_CrtSetDebugFillThreshold`** | \ | This function is Microsoft-specific. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtsetdumpclient.md b/docs/c-runtime-library/reference/crtsetdumpclient.md index 49b0c886ca7..220fadaa08e 100644 --- a/docs/c-runtime-library/reference/crtsetdumpclient.md +++ b/docs/c-runtime-library/reference/crtsetdumpclient.md @@ -49,9 +49,9 @@ For more information about functions that operate on `_CLIENT_BLOCK` type memory ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtSetDumpClient`**|\| +| Routine | Required header | +|---|---| +| **`_CrtSetDumpClient`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtsetreportfile.md b/docs/c-runtime-library/reference/crtsetreportfile.md index 16b196eb5e4..35b801e080a 100644 --- a/docs/c-runtime-library/reference/crtsetreportfile.md +++ b/docs/c-runtime-library/reference/crtsetreportfile.md @@ -81,9 +81,9 @@ You can control the report file used by each report type separately. For example ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_CrtSetReportFile`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_CrtSetReportFile`** | \ | \ | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtsetreporthook.md b/docs/c-runtime-library/reference/crtsetreporthook.md index 703207c7351..7b71a5eaa70 100644 --- a/docs/c-runtime-library/reference/crtsetreporthook.md +++ b/docs/c-runtime-library/reference/crtsetreporthook.md @@ -54,9 +54,9 @@ For more information about using other hook-capable run-time functions and writi ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_CrtSetReportHook`**|\| +| Routine | Required header | +|---|---| +| **`_CrtSetReportHook`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtsetreporthook2-crtsetreporthookw2.md b/docs/c-runtime-library/reference/crtsetreporthook2-crtsetreporthookw2.md index 28a3be8305c..bbd300bda3d 100644 --- a/docs/c-runtime-library/reference/crtsetreporthook2-crtsetreporthookw2.md +++ b/docs/c-runtime-library/reference/crtsetreporthook2-crtsetreporthookw2.md @@ -66,10 +66,10 @@ These functions validate their parameters. If *`mode`* or *`pfnNewHook`* is inva ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_CrtSetReportHook2`**|\|\| -|**`_CrtSetReportHookW2`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_CrtSetReportHook2`** | \ | \ | +| **`_CrtSetReportHookW2`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/crtsetreportmode.md b/docs/c-runtime-library/reference/crtsetreportmode.md index a8b776ed8a1..1049ca67b05 100644 --- a/docs/c-runtime-library/reference/crtsetreportmode.md +++ b/docs/c-runtime-library/reference/crtsetreportmode.md @@ -11,7 +11,7 @@ helpviewer_keywords: ["_CrtSetReportMode function", "CrtSetReportMode function"] --- # `_CrtSetReportMode` -Specifies the destination or destinations for a specific report type generated by `_CrtDbgReport` and any macros that call [`_CrtDbgReport, _CrtDbgReportW`](crtdbgreport-crtdbgreportw.md), such as [`_ASSERT`, `_ASSERTE`, `_ASSERT_EXPR` macros](assert-asserte-assert-expr-macros.md) and [`_RPT`, `_RPTF`, `_RPTW`, `_RPTFW` macros](rpt-rptf-rptw-rptfw-macros.md) (debug version only). +Specifies the destination or destinations for a specific report type generated by `_CrtDbgReport` and any macros that call [`_CrtDbgReport`, `_CrtDbgReportW`](crtdbgreport-crtdbgreportw.md), such as [`_ASSERT`, `_ASSERTE`, `_ASSERT_EXPR` macros](assert-asserte-assert-expr-macros.md) and [`_RPT`, `_RPTF`, `_RPTW`, `_RPTFW` macros](rpt-rptf-rptw-rptfw-macros.md) (debug version only). ## Syntax @@ -32,7 +32,7 @@ New report mode or modes for *`reportType`*. ## Return value -On successful completion, **`_CrtSetReportMode`** returns the previous report mode or modes for the report type specified in *`reportType`*. If an invalid value is passed in as *`reportType`* or an invalid mode is specified for *`reportMode`*, **`_CrtSetReportMode`** invokes the invalid parameter handler as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, this function sets `errno` to `EINVAL` and returns -1. For more information, see [`errno, _doserrno, _sys_errlist, and _sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). +On successful completion, **`_CrtSetReportMode`** returns the previous report mode or modes for the report type specified in *`reportType`*. If an invalid value is passed in as *`reportType`* or an invalid mode is specified for *`reportMode`*, **`_CrtSetReportMode`** invokes the invalid parameter handler as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, this function sets `errno` to `EINVAL` and returns -1. For more information, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). ## Remarks @@ -50,20 +50,20 @@ If you don't call **`_CrtSetReportMode`** to define the output destination of me The following table lists the report types defined in `Crtdbg.h`. -|Report type|Description| -|-----------------|-----------------| -|`_CRT_WARN`|Warnings, messages, and information that doesn't need immediate attention.| -|`_CRT_ERROR`|Errors, unrecoverable problems, and issues that require immediate attention.| -|`_CRT_ASSERT`|Assertion failures (asserted expressions that evaluate to `FALSE`).| +| Report type | Description | +|---|---| +| `_CRT_WARN` | Warnings, messages, and information that doesn't need immediate attention. | +| `_CRT_ERROR` | Errors, unrecoverable problems, and issues that require immediate attention. | +| `_CRT_ASSERT` | Assertion failures (asserted expressions that evaluate to `FALSE`). | The **`_CrtSetReportMode`** function assigns the new report mode specified in *`reportMode`* to the report type specified in *`reportType`* and returns the previously defined report mode for *`reportType`*. The following table lists the available choices for *`reportMode`* and the resulting behavior of **`_CrtDbgReport`**. These options are defined as bit flags in Crtdbg.h. -|Report mode|_CrtDbgReport behavior| -|-----------------|-----------------------------| -|`_CRTDBG_MODE_DEBUG`|Writes the message to the debugger's output window.| -|`_CRTDBG_MODE_FILE`|Writes the message to a user-supplied file handle. [`_CrtSetReportFile`](crtsetreportfile.md) should be called to define the specific file or stream to use as the destination.| -|`_CRTDBG_MODE_WNDW`|Creates a message box to display the message along with the **Abort**, **Retry**, and **Ignore** buttons.| -|`_CRTDBG_REPORT_MODE`|Returns *`reportMode`* for the specified *`reportType`*:

1 `_CRTDBG_MODE_FILE`

2 `_CRTDBG_MODE_DEBUG`

4 `_CRTDBG_MODE_WNDW`| +| Report mode | _CrtDbgReport behavior | +|---|---| +| `_CRTDBG_MODE_DEBUG` | Writes the message to the debugger's output window. | +| `_CRTDBG_MODE_FILE` | Writes the message to a user-supplied file handle. [`_CrtSetReportFile`](crtsetreportfile.md) should be called to define the specific file or stream to use as the destination. | +| `_CRTDBG_MODE_WNDW` | Creates a message box to display the message along with the **Abort**, **Retry**, and **Ignore** buttons. | +| `_CRTDBG_REPORT_MODE` | Returns *`reportMode`* for the specified *`reportType`*:

1 `_CRTDBG_MODE_FILE`

2 `_CRTDBG_MODE_DEBUG`

4 `_CRTDBG_MODE_WNDW` | Each report type can be reported using one, two, or three modes or no mode at all. Therefore, it's possible to have more than one destination defined for a single report type. For example, the following code fragment causes assertion failures to be sent to both a debug message window and to **`stderr`**: @@ -76,9 +76,9 @@ In addition, you can control the reporting mode or modes for each report type se ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_CrtSetReportMode`**|``|``| +| Routine | Required header | Optional header | +|---|---|---| +| **`_CrtSetReportMode`** | `` | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cscanf-cscanf-l-cwscanf-cwscanf-l.md b/docs/c-runtime-library/reference/cscanf-cscanf-l-cwscanf-cwscanf-l.md index 9fcc085593d..a28d6c58c60 100644 --- a/docs/c-runtime-library/reference/cscanf-cscanf-l-cwscanf-cwscanf-l.md +++ b/docs/c-runtime-library/reference/cscanf-cscanf-l-cwscanf-cwscanf-l.md @@ -68,17 +68,17 @@ The versions of these functions with the `_l` suffix are identical except that t ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcscanf`|**`_cscanf`**|**`_cscanf`**|**`_cwscanf`**| -|`_tcscanf_l`|**`_cscanf_l`**|**`_cscanf_l`**|**`_cwscanf_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcscanf` | **`_cscanf`** | **`_cscanf`** | **`_cwscanf`** | +| `_tcscanf_l` | **`_cscanf_l`** | **`_cscanf_l`** | **`_cwscanf_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_cscanf`**, **`_cscanf_l`**|\| -|**`_cwscanf`**, **`_cwscanf_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`_cscanf`**, **`_cscanf_l`** | \ | +| **`_cwscanf`**, **`_cwscanf_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cscanf-s-cscanf-s-l-cwscanf-s-cwscanf-s-l.md b/docs/c-runtime-library/reference/cscanf-s-cscanf-s-l-cwscanf-s-cwscanf-s-l.md index 3d7ba85a661..87dac808b60 100644 --- a/docs/c-runtime-library/reference/cscanf-s-cscanf-s-l-cwscanf-s-cwscanf-s-l.md +++ b/docs/c-runtime-library/reference/cscanf-s-cscanf-s-l-cwscanf-s-cwscanf-s-l.md @@ -70,17 +70,17 @@ The versions of these functions with the `_l` suffix are identical except that t ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcscanf_s`|**`_cscanf_s`**|**`_cscanf_s`**|**`_cwscanf_s`**| -|`_tcscanf_s_l`|**`_cscanf_s_l`**|**`_cscanf_s_l`**|**`_cwscanf_s_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcscanf_s` | **`_cscanf_s`** | **`_cscanf_s`** | **`_cwscanf_s`** | +| `_tcscanf_s_l` | **`_cscanf_s_l`** | **`_cscanf_s_l`** | **`_cwscanf_s_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_cscanf_s`**, **`_cscanf_s_l`**|\| -|**`_cwscanf_s`**, **`_cwscanf_s_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`_cscanf_s`**, **`_cscanf_s_l`** | \ | +| **`_cwscanf_s`**, **`_cwscanf_s_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/csin-csinf-csinl.md b/docs/c-runtime-library/reference/csin-csinf-csinl.md index 3cb6875a979..b2b68bab638 100644 --- a/docs/c-runtime-library/reference/csin-csinf-csinl.md +++ b/docs/c-runtime-library/reference/csin-csinf-csinl.md @@ -49,9 +49,9 @@ Because C++ allows overloading, you can call overloads of **`csin`** that take a ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`csin`**, **`csinf`**, **`csinl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`csin`**, **`csinf`**, **`csinl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/csinh-csinhf-csinhl.md b/docs/c-runtime-library/reference/csinh-csinhf-csinhl.md index b150a97e06e..b1dea5a7425 100644 --- a/docs/c-runtime-library/reference/csinh-csinhf-csinhl.md +++ b/docs/c-runtime-library/reference/csinh-csinhf-csinhl.md @@ -49,9 +49,9 @@ Because C++ allows overloading, you can call overloads of **`csinh`** that take ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`csinh`**, **`csinhf`**, **`csinhl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`csinh`**, **`csinhf`**, **`csinhl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/csqrt-csqrtf-csqrtl.md b/docs/c-runtime-library/reference/csqrt-csqrtf-csqrtl.md index 5f9d41c17b7..91ae3bdad69 100644 --- a/docs/c-runtime-library/reference/csqrt-csqrtf-csqrtl.md +++ b/docs/c-runtime-library/reference/csqrt-csqrtf-csqrtl.md @@ -43,10 +43,10 @@ A complex number. The square root of *`z`*. The result is in the right half-plane. -|Input|SEH Exception|`_matherr` Exception| -|-----------|-------------------|--------------------------| -|± QNAN, IND|none|_DOMAIN| -|- ∞|none|_DOMAIN| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | _DOMAIN | +| - INF | none | _DOMAIN | ## Remarks @@ -54,9 +54,9 @@ Because C++ allows overloading, you can call overloads of **`csqrt`** that take ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`csqrt`**, **`csqrtf`**, **`csqrtl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`csqrt`**, **`csqrtf`**, **`csqrtl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ctan-ctanf-ctanl.md b/docs/c-runtime-library/reference/ctan-ctanf-ctanl.md index 012ff41d889..a88bd27f839 100644 --- a/docs/c-runtime-library/reference/ctan-ctanf-ctanl.md +++ b/docs/c-runtime-library/reference/ctan-ctanf-ctanl.md @@ -43,10 +43,10 @@ A complex number that represents the angle, in radians. The tangent of *`z`*. -|Input|SEH Exception|`_matherr` Exception| -|-----------|-------------------|--------------------------| -|± ∞, QNAN, IND|none|_DOMAIN| -|± ∞ (`tan`, `tanf`)|INVALID|_DOMAIN| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± INF, QNaN, IND | none | _DOMAIN | +| ± INF (`tan`, `tanf`) | INVALID | _DOMAIN | ## Remarks @@ -54,9 +54,9 @@ Because C++ allows overloading, you can call overloads of **`ctan`** that take a ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`ctan`**, **`ctanf`**, **`ctanl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`ctan`**, **`ctanf`**, **`ctanl`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ctanh-ctanhf-ctanhl.md b/docs/c-runtime-library/reference/ctanh-ctanhf-ctanhl.md index 5c625d3a34d..0b7fa8bfce4 100644 --- a/docs/c-runtime-library/reference/ctanh-ctanhf-ctanhl.md +++ b/docs/c-runtime-library/reference/ctanh-ctanhf-ctanhl.md @@ -43,10 +43,10 @@ A complex number that represents an angle, in radians. The complex hyperbolic tangent of *`z`*. -|Input|SEH Exception|`_matherr` Exception| -|-----------|-------------------|--------------------------| -|± ∞, QNAN, IND|none|_DOMAIN| -|± ∞ (tan, tanf)|INVALID|_DOMAIN| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± INF, QNaN, IND | none | _DOMAIN | +| ± INF (tan, tanf) | INVALID | _DOMAIN | ## Remarks @@ -54,9 +54,9 @@ Because C++ allows overloading, you can call overloads of **`ctanh`** that take ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`ctanh`**, **`ctanhf`**, **`ctanhl`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`ctanh`**, **`ctanhf`**, **`ctanhl`** | \ | \ | For compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md b/docs/c-runtime-library/reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md index c46cb84286c..d7dacac408f 100644 --- a/docs/c-runtime-library/reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md +++ b/docs/c-runtime-library/reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md @@ -64,22 +64,22 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tctime`|**`ctime`**|**`ctime`**|**`_wctime`**| -|`_tctime32`|**`_ctime32`**|**`_ctime32`**|**`_wctime32`**| -|`_tctime64`|**`_ctime64`**|**`_ctime64`**|**`_wctime64`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tctime` | **`ctime`** | **`ctime`** | **`_wctime`** | +| `_tctime32` | **`_ctime32`** | **`_ctime32`** | **`_wctime32`** | +| `_tctime64` | **`_ctime64`** | **`_ctime64`** | **`_wctime64`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`ctime`**|\| -|**`_ctime32`**|\| -|**`_ctime64`**|\| -|**`_wctime`**|\ or \| -|**`_wctime32`**|\ or \| -|**`_wctime64`**|\ or \| +| Routine | Required header | +|---|---| +| **`ctime`** | \ | +| **`_ctime32`** | \ | +| **`_ctime64`** | \ | +| **`_wctime`** | \ or \ | +| **`_wctime32`** | \ or \ | +| **`_wctime64`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md b/docs/c-runtime-library/reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md index 03fb6010995..585569faae9 100644 --- a/docs/c-runtime-library/reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md +++ b/docs/c-runtime-library/reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md @@ -97,13 +97,13 @@ Zero if successful. If there's a failure due to an invalid parameter, the invali ## Error conditions -|*`buffer`*|*`numberOfElements`*|*`sourceTime`*|Return|Value in *`buffer`*| -|--------------|------------------------|------------|------------|-----------------------| -|`NULL`|any|any|`EINVAL`|Not modified| -|Not `NULL` (points to valid memory)|0|any|`EINVAL`|Not modified| -|Not `NULL`|0< size < 26|any|`EINVAL`|Empty string| -|Not `NULL`|>= 26|NULL|`EINVAL`|Empty string| -|Not `NULL`|>= 26|< 0|`EINVAL`|Empty string| +| *`buffer`* | *`numberOfElements`* | *`sourceTime`* | Return | Value in *`buffer`* | +|---|---|---|---|---| +| `NULL` | any | any | `EINVAL` | Not modified | +| Not `NULL` (points to valid memory) | 0 | any | `EINVAL` | Not modified | +| Not `NULL` | 0< size < 26 | any | `EINVAL` | Empty string | +| Not `NULL` | >= 26 | NULL | `EINVAL` | Empty string | +| Not `NULL` | >= 26 | < 0 | `EINVAL` | Empty string | ## Remarks @@ -127,18 +127,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tctime_s`|**`ctime_s`**|**`ctime_s`**|**`_wctime_s`**| -|`_tctime32_s`|**`_ctime32_s`**|**`_ctime32_s`**|**`_wctime32_s`**| -|`_tctime64_s`|**`_ctime64_s`**|**`_ctime64_s`**|**`_wctime64_s`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tctime_s` | **`ctime_s`** | **`ctime_s`** | **`_wctime_s`** | +| `_tctime32_s` | **`_ctime32_s`** | **`_ctime32_s`** | **`_wctime32_s`** | +| `_tctime64_s` | **`_ctime64_s`** | **`_ctime64_s`** | **`_wctime64_s`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`ctime_s`**, **`_ctime32_s`**, **`_ctime64_s`**|\| -|**`_wctime_s`**, **`_wctime32_s`**, **`_wctime64_s`**|\ or \| +| Routine | Required header | +|---|---| +| **`ctime_s`**, **`_ctime32_s`**, **`_ctime64_s`** | \ | +| **`_wctime_s`**, **`_wctime32_s`**, **`_wctime64_s`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/cwait.md b/docs/c-runtime-library/reference/cwait.md index fc4aa78a02d..89e626c3454 100644 --- a/docs/c-runtime-library/reference/cwait.md +++ b/docs/c-runtime-library/reference/cwait.md @@ -42,12 +42,12 @@ The handle to the process to wait on (that is, the process that has to terminate When the specified process has successfully completed, returns the handle of the specified process and sets *`termstat`* to the result code that's returned by the specified process. Otherwise, returns -1 and sets `errno` as follows. -|Value|Description| -|-----------|-----------------| -|`ECHILD`|No specified process exists, *`procHandle`* is invalid, or the call to the [`GetExitCodeProcess`](/windows/win32/api/processthreadsapi/nf-processthreadsapi-getexitcodeprocess) or [`WaitForSingleObject`](/windows/win32/api/synchapi/nf-synchapi-waitforsingleobject) API failed.| -|`EINVAL`|*`action`* is invalid.| +| `errno` value | Description | +|---|---| +| `ECHILD` | No specified process exists, *`procHandle`* is invalid, or the call to the [`GetExitCodeProcess`](/windows/win32/api/processthreadsapi/nf-processthreadsapi-getexitcodeprocess) or [`WaitForSingleObject`](/windows/win32/api/synchapi/nf-synchapi-waitforsingleobject) API failed. | +| `EINVAL` | *`action`* is invalid. | -For more information about these and other return codes, see [`errno, _doserrno, _sys_errlist, and _sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). +For more information about these and other return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). ## Remarks @@ -63,9 +63,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_cwait`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_cwait`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/difftime-difftime32-difftime64.md b/docs/c-runtime-library/reference/difftime-difftime32-difftime64.md index bfac04ee278..61843466fc0 100644 --- a/docs/c-runtime-library/reference/difftime-difftime32-difftime64.md +++ b/docs/c-runtime-library/reference/difftime-difftime32-difftime64.md @@ -48,11 +48,11 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`difftime`**|\| -|**`_difftime32`**|\| -|**`_difftime64`**|\| +| Routine | Required header | +|---|---| +| **`difftime`** | \ | +| **`_difftime32`** | \ | +| **`_difftime64`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/dup-dup2.md b/docs/c-runtime-library/reference/dup-dup2.md index ef1b11c460a..fe043fafcef 100644 --- a/docs/c-runtime-library/reference/dup-dup2.md +++ b/docs/c-runtime-library/reference/dup-dup2.md @@ -48,10 +48,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_dup`**|``| -|**`_dup2`**|``| +| Routine | Required header | +|---|---| +| **`_dup`** | `` | +| **`_dup2`** | `` | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, **`stdin`**, **`stdout`**, and **`stderr`**, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/dupenv-s-dbg-wdupenv-s-dbg.md b/docs/c-runtime-library/reference/dupenv-s-dbg-wdupenv-s-dbg.md index 62b2320b294..9fab3a0583b 100644 --- a/docs/c-runtime-library/reference/dupenv-s-dbg-wdupenv-s-dbg.md +++ b/docs/c-runtime-library/reference/dupenv-s-dbg-wdupenv-s-dbg.md @@ -71,16 +71,16 @@ You don't need to call these functions explicitly in most cases. Instead, you ca ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tdupenv_s_dbg`|**`_dupenv_s_dbg`**|**`_dupenv_s_dbg`**|**`_wdupenv_s_dbg`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tdupenv_s_dbg` | **`_dupenv_s_dbg`** | **`_dupenv_s_dbg`** | **`_wdupenv_s_dbg`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_dupenv_s_dbg`**|\| -|**`_wdupenv_s_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_dupenv_s_dbg`** | \ | +| **`_wdupenv_s_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/dupenv-s-wdupenv-s.md b/docs/c-runtime-library/reference/dupenv-s-wdupenv-s.md index ffa7b6f4418..ba93ac0e8de 100644 --- a/docs/c-runtime-library/reference/dupenv-s-wdupenv-s.md +++ b/docs/c-runtime-library/reference/dupenv-s-wdupenv-s.md @@ -72,16 +72,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tdupenv_s`**|**`_dupenv_s`**|**`_dupenv_s`**|**`_wdupenv_s`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tdupenv_s`** | **`_dupenv_s`** | **`_dupenv_s`** | **`_wdupenv_s`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_dupenv_s`**|``| -|**`_wdupenv_s`**|`` or ``| +| Routine | Required header | +|---|---| +| **`_dupenv_s`** | `` | +| **`_wdupenv_s`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ecvt-s.md b/docs/c-runtime-library/reference/ecvt-s.md index 1505e9e4971..b98c5bdacc6 100644 --- a/docs/c-runtime-library/reference/ecvt-s.md +++ b/docs/c-runtime-library/reference/ecvt-s.md @@ -63,12 +63,12 @@ If there's an invalid parameter, as listed in the following table, this function ### Error conditions -|*`buffer`*|*`sizeInBytes`*|*`value`*|*`count`*|*`dec`*|*`sign`*|Return value|Value in *`buffer`*| -|---------------|--------------------|-------------|-------------|-----------|------------|------------------|-----------------------| -|`NULL`|any|any|any|any|any|`EINVAL`|Not modified.| -|Not `NULL` (points to valid memory)|<=0|any|any|any|any|`EINVAL`|Not modified.| -|any|any|any|any|`NULL`|any|`EINVAL`|Not modified.| -|any|any|any|any|any|`NULL`|`EINVAL`|Not modified.| +| *`buffer`* | *`sizeInBytes`* | *`value`* | *`count`* | *`dec`* | *`sign`* | Return value | Value in *`buffer`* | +|---|---|---|---|---|---|---|---| +| `NULL` | any | any | any | any | any | `EINVAL` | Not modified. | +| Not `NULL` (points to valid memory) | <=0 | any | any | any | any | `EINVAL` | Not modified. | +| any | any | any | any | `NULL` | any | `EINVAL` | Not modified. | +| any | any | any | any | any | `NULL` | `EINVAL` | Not modified. | ## Security issues @@ -92,9 +92,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header|Optional header| -|--------------|---------------------|---------------------| -|**`_ecvt_s`**|\|\| +| Function | Required header | Optional header | +|---|---|---| +| **`_ecvt_s`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ecvt.md b/docs/c-runtime-library/reference/ecvt.md index 4c81db89a48..a9234103f8e 100644 --- a/docs/c-runtime-library/reference/ecvt.md +++ b/docs/c-runtime-library/reference/ecvt.md @@ -61,9 +61,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_ecvt`**|\| +| Function | Required header | +|---|---| +| **`_ecvt`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/endthread-endthreadex.md b/docs/c-runtime-library/reference/endthread-endthreadex.md index de299ec1698..0aaf637b2f7 100644 --- a/docs/c-runtime-library/reference/endthread-endthreadex.md +++ b/docs/c-runtime-library/reference/endthread-endthreadex.md @@ -45,10 +45,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_endthread`**|``| -|**`_endthreadex`**|``| +| Function | Required header | +|---|---| +| **`_endthread`** | `` | +| **`_endthreadex`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/eof.md b/docs/c-runtime-library/reference/eof.md index a49fd4c5057..5940581f404 100644 --- a/docs/c-runtime-library/reference/eof.md +++ b/docs/c-runtime-library/reference/eof.md @@ -39,9 +39,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header|Optional header| -|--------------|---------------------|---------------------| -|**`_eof`**|\|\| +| Function | Required header | Optional header | +|---|---|---| +| **`_eof`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/erf-erff-erfl-erfc-erfcf-erfcl.md b/docs/c-runtime-library/reference/erf-erff-erfl-erfc-erfcf-erfcl.md index 30470f78310..9777814ee30 100644 --- a/docs/c-runtime-library/reference/erf-erff-erfl-erfc-erfcf-erfcl.md +++ b/docs/c-runtime-library/reference/erf-erff-erfl-erfc-erfcf-erfcl.md @@ -76,10 +76,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`erf`**, **`erff`**, **`erfl`**, **`erfc`**, **`erfcf`**, **`erfcl`**|\| -|**`erf`** macro | \ | +| Function | Required header | +|---|---| +| **`erf`**, **`erff`**, **`erfl`**, **`erfc`**, **`erfcf`**, **`erfcl`** | \ | +| **`erf`** macro | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/execl-wexecl.md b/docs/c-runtime-library/reference/execl-wexecl.md index 97c7eaf2fc1..2d3fd94167e 100644 --- a/docs/c-runtime-library/reference/execl-wexecl.md +++ b/docs/c-runtime-library/reference/execl-wexecl.md @@ -46,15 +46,15 @@ List of pointers to the parameters. If successful, these functions don't return to the calling process. A return value of -1 indicates an error, in which case the `errno` global variable is set. -|errno value|Description| -|-----------------|-----------------| -|`E2BIG`|The space required for the arguments and environment settings exceeds 32 KB.| -|`EACCES`|The specified file has a locking or sharing violation.| -|`EINVAL`|Invalid parameter (one or more of the parameters was a null pointer or empty string).| -|`EMFILE`|Too many files open (the specified file must be opened to determine whether it's executable).| -|`ENOENT`|The file or path isn't found.| -|`ENOEXEC`|The specified file isn't executable or has an invalid executable-file format.| -|`ENOMEM`|Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, indicating that the calling process wasn't allocated properly.| +| `errno` value | Description | +|---|---| +| `E2BIG` | The space required for the arguments and environment settings exceeds 32 KB. | +| `EACCES` | The specified file has a locking or sharing violation. | +| `EINVAL` | Invalid parameter (one or more of the parameters was a null pointer or empty string). | +| `EMFILE` | Too many files open (the specified file must be opened to determine whether it's executable). | +| `ENOENT` | The file or path isn't found. | +| `ENOEXEC` | The specified file isn't executable or has an invalid executable-file format. | +| `ENOMEM` | Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, indicating that the calling process wasn't allocated properly. | ## Remarks @@ -64,10 +64,10 @@ The **`_execl`** functions validate their parameters. If either *`cmdname`* or * ## Requirements -|Function|Required header|Optional header| -|--------------|---------------------|---------------------| -|**`_execl`**|\|\| -|**`_wexecl`**|\ or \|\| +| Function | Required header | Optional header | +|---|---|---| +| **`_execl`** | \ | \ | +| **`_wexecl`** | \ or \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/execle-wexecle.md b/docs/c-runtime-library/reference/execle-wexecle.md index a9efce889df..4eebea6a6c2 100644 --- a/docs/c-runtime-library/reference/execle-wexecle.md +++ b/docs/c-runtime-library/reference/execle-wexecle.md @@ -51,15 +51,15 @@ Array of pointers to environment settings. If successful, these functions don't return to the calling process. A return value of -1 indicates an error, in which case the `errno` global variable is set. -|`errno` value|Description| -|-------------------|-----------------| -|`E2BIG`|The space that's required for the arguments and the environment settings exceeds 32 KB.| -|`EACCES`|The specified file has a locking or sharing violation.| -|`EINVAL`|Invalid parameter.| -|`EMFILE`|Too many files are open. (The specified file must be opened to determine whether it's executable.)| -|`ENOENT`|The file or path isn't found.| -|`ENOEXEC`|The specified file isn't executable or has an invalid executable-file format.| -|`ENOMEM`|Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, which indicates that the calling process wasn't allocated correctly.| +| `errno` value | Description | +|---|---| +| `E2BIG` | The space that's required for the arguments and the environment settings exceeds 32 KB. | +| `EACCES` | The specified file has a locking or sharing violation. | +| `EINVAL` | Invalid parameter. | +| `EMFILE` | Too many files are open. (The specified file must be opened to determine whether it's executable.) | +| `ENOENT` | The file or path isn't found. | +| `ENOEXEC` | The specified file isn't executable or has an invalid executable-file format. | +| `ENOMEM` | Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, which indicates that the calling process wasn't allocated correctly. | For more information about these return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -71,10 +71,10 @@ The **`_execle`** functions validate their parameters. If *`cmdname`* or *`arg0` ## Requirements -|Function|Required header|Optional header| -|--------------|---------------------|---------------------| -|**`_execle`**|\|\| -|**`_wexecle`**|\ or \|\| +| Function | Required header | Optional header | +|---|---|---| +| **`_execle`** | \ | \ | +| **`_wexecle`** | \ or \ | \ | For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/execlp-wexeclp.md b/docs/c-runtime-library/reference/execlp-wexeclp.md index b331ccda89d..f10fca130ed 100644 --- a/docs/c-runtime-library/reference/execlp-wexeclp.md +++ b/docs/c-runtime-library/reference/execlp-wexeclp.md @@ -46,15 +46,15 @@ List of pointers to parameters. If successful, these functions don't return to the calling process. A return value of -1 indicates an error, in which case the `errno` global variable is set. -|`errno` value|Description| -|-------------------|-----------------| -|`E2BIG`|The space required for the arguments and environment settings exceeds 32 KB.| -|`EACCES`|The specified file has a locking or sharing violation.| -|`EINVAL`|Invalid parameter.| -|`EMFILE`|Too many files open (the specified file must be opened to determine whether it's executable).| -|`ENOENT`|The file or path not found.| -|`ENOEXEC`|The specified file isn't executable or has an invalid executable-file format.| -|`ENOMEM`|Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, indicating that the calling process wasn't allocated properly.| +| `errno` value | Description | +|---|---| +| `E2BIG` | The space required for the arguments and environment settings exceeds 32 KB. | +| `EACCES` | The specified file has a locking or sharing violation. | +| `EINVAL` | Invalid parameter. | +| `EMFILE` | Too many files open (the specified file must be opened to determine whether it's executable). | +| `ENOENT` | The file or path not found. | +| `ENOEXEC` | The specified file isn't executable or has an invalid executable-file format. | +| `ENOMEM` | Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, indicating that the calling process wasn't allocated properly. | For more information about these and other return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -66,10 +66,10 @@ The **`_execlp`** functions validate their parameters. If *`cmdname`* or *`arg0` ## Requirements -|Function|Required header|Optional header| -|--------------|---------------------|---------------------| -|**`_execlp`**|\|\| -|**`_wexeclp`**|\ or \|\| +| Function | Required header | Optional header | +|---|---|---| +| **`_execlp`** | \ | \ | +| **`_wexeclp`** | \ or \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/execlpe-wexeclpe.md b/docs/c-runtime-library/reference/execlpe-wexeclpe.md index f3e6a7c3b07..486aa1d97c0 100644 --- a/docs/c-runtime-library/reference/execlpe-wexeclpe.md +++ b/docs/c-runtime-library/reference/execlpe-wexeclpe.md @@ -51,15 +51,15 @@ Array of pointers to environment settings. If successful, these functions don't return to the calling process. A return value of -1 indicates an error, in which case the `errno` global variable is set. -|`errno` value|Description| -|-------------------|-----------------| -|`E2BIG`|The space required for the arguments and environment settings exceeds 32 KB.| -|`EACCES`|The specified file has a locking or sharing violation.| -|`EINVAL`|Invalid parameter.| -|`EMFILE`|Too many files open (the specified file must be opened to determine whether it's executable).| -|`ENOENT`|The file or path not found.| -|`ENOEXEC`|The specified file isn't executable or has an invalid executable-file format.| -|`ENOMEM`|Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, indicating that the calling process wasn't allocated properly.| +| `errno` value | Description | +|---|---| +| `E2BIG` | The space required for the arguments and environment settings exceeds 32 KB. | +| `EACCES` | The specified file has a locking or sharing violation. | +| `EINVAL` | Invalid parameter. | +| `EMFILE` | Too many files open (the specified file must be opened to determine whether it's executable). | +| `ENOENT` | The file or path not found. | +| `ENOEXEC` | The specified file isn't executable or has an invalid executable-file format. | +| `ENOMEM` | Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, indicating that the calling process wasn't allocated properly. | For more information about these and other return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -71,10 +71,10 @@ The **`_execlpe`** functions validate their parameters. If either *`cmdname`* or ## Requirements -|Function|Required header|Optional header| -|--------------|---------------------|---------------------| -|**`_execlpe`**|\|\| -|**`_wexeclpe`**|\ or \|\| +| Function | Required header | Optional header | +|---|---|---| +| **`_execlpe`** | \ | \ | +| **`_wexeclpe`** | \ or \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/execv-wexecv.md b/docs/c-runtime-library/reference/execv-wexecv.md index 2f8139dc6cc..b030939ce92 100644 --- a/docs/c-runtime-library/reference/execv-wexecv.md +++ b/docs/c-runtime-library/reference/execv-wexecv.md @@ -42,15 +42,15 @@ Array of pointers to parameters. If successful, these functions don't return to the calling process. A return value of -1 indicates an error, in which case the `errno` global variable is set. -|`errno` value|Description| -|-------------------|-----------------| -|`E2BIG`|The space required for the arguments and environment settings exceeds 32 KB.| -|`EACCES`|The specified file has a locking or sharing violation.| -|`EINVAL`|Invalid parameter.| -|`EMFILE`|Too many files open (the specified file must be opened to determine whether it's executable).| -|`ENOENT`|The file or path not found.| -|`ENOEXEC`|The specified file isn't executable or has an invalid executable-file format.| -|`ENOMEM`|Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, indicating that the calling process wasn't allocated properly.| +| `errno` value | Description | +|---|---| +| `E2BIG` | The space required for the arguments and environment settings exceeds 32 KB. | +| `EACCES` | The specified file has a locking or sharing violation. | +| `EINVAL` | Invalid parameter. | +| `EMFILE` | Too many files open (the specified file must be opened to determine whether it's executable). | +| `ENOENT` | The file or path not found. | +| `ENOEXEC` | The specified file isn't executable or has an invalid executable-file format. | +| `ENOMEM` | Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, indicating that the calling process wasn't allocated properly. | For more information about these and other return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -64,10 +64,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header|Optional header| -|--------------|---------------------|---------------------| -|**`_execv`**|\|\| -|**`_wexecv`**|\ or \|\| +| Function | Required header | Optional header | +|---|---|---| +| **`_execv`** | \ | \ | +| **`_wexecv`** | \ or \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/execve-wexecve.md b/docs/c-runtime-library/reference/execve-wexecve.md index 180bf560dab..e10ac6f1c60 100644 --- a/docs/c-runtime-library/reference/execve-wexecve.md +++ b/docs/c-runtime-library/reference/execve-wexecve.md @@ -47,15 +47,15 @@ Array of pointers to environment settings. If successful, these functions don't return to the calling process. A return value of -1 indicates an error, in which case the `errno` global variable is set. -|`errno` value|Description| -|-------------------|-----------------| -|`E2BIG`|The space required for the arguments and environment settings exceeds 32 KB.| -|`EACCES`|The specified file has a locking or sharing violation.| -|`EINVAL`|Invalid parameter.| -|`EMFILE`|Too many files open (the specified file must be opened to determine whether it's executable).| -|`ENOENT`|The file or path not found.| -|`ENOEXEC`|The specified file isn't executable or has an invalid executable-file format.| -|`ENOMEM`|Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, indicating that the calling process wasn't allocated properly.| +| `errno` value | Description | +|---|---| +| `E2BIG` | The space required for the arguments and environment settings exceeds 32 KB. | +| `EACCES` | The specified file has a locking or sharing violation. | +| `EINVAL` | Invalid parameter. | +| `EMFILE` | Too many files open (the specified file must be opened to determine whether it's executable). | +| `ENOENT` | The file or path not found. | +| `ENOEXEC` | The specified file isn't executable or has an invalid executable-file format. | +| `ENOMEM` | Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, indicating that the calling process wasn't allocated properly. | For more information about these and other return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -75,10 +75,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header|Optional header| -|--------------|---------------------|---------------------| -|**`_execve`**|\|\| -|**`_wexecve`**|\ or \|\| +| Function | Required header | Optional header | +|---|---|---| +| **`_execve`** | \ | \ | +| **`_wexecve`** | \ or \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/execvp-wexecvp.md b/docs/c-runtime-library/reference/execvp-wexecvp.md index 094ec1bf80e..a8218772488 100644 --- a/docs/c-runtime-library/reference/execvp-wexecvp.md +++ b/docs/c-runtime-library/reference/execvp-wexecvp.md @@ -42,15 +42,15 @@ Array of pointers to parameters. If successful, these functions don't return to the calling process. A return value of -1 indicates an error, in which case the `errno` global variable is set. -|`errno` value|Description| -|-------------------|-----------------| -|`E2BIG`|The space required for the arguments and environment settings exceeds 32 KB.| -|`EACCES`|The specified file has a locking or sharing violation.| -|`EINVAL`|Invalid parameter.| -|`EMFILE`|Too many files open (the specified file must be opened to determine whether it's executable).| -|`ENOENT`|The file or path not found.| -|`ENOEXEC`|The specified file isn't executable or has an invalid executable-file format.| -|`ENOMEM`|Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, indicating that the calling process wasn't allocated properly.| +| `errno` value | Description | +|---|---| +| `E2BIG` | The space required for the arguments and environment settings exceeds 32 KB. | +| `EACCES` | The specified file has a locking or sharing violation. | +| `EINVAL` | Invalid parameter. | +| `EMFILE` | Too many files open (the specified file must be opened to determine whether it's executable). | +| `ENOENT` | The file or path not found. | +| `ENOEXEC` | The specified file isn't executable or has an invalid executable-file format. | +| `ENOMEM` | Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, indicating that the calling process wasn't allocated properly. | For more information about these and other return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -70,10 +70,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header|Optional header| -|--------------|---------------------|---------------------| -|**`_execvp`**|\|\| -|**`_wexecvp`**|\ or \|\| +| Function | Required header | Optional header | +|---|---|---| +| **`_execvp`** | \ | \ | +| **`_wexecvp`** | \ or \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/execvpe-wexecvpe.md b/docs/c-runtime-library/reference/execvpe-wexecvpe.md index 74123bcfc46..2dfe5760867 100644 --- a/docs/c-runtime-library/reference/execvpe-wexecvpe.md +++ b/docs/c-runtime-library/reference/execvpe-wexecvpe.md @@ -47,14 +47,14 @@ Array of pointers to environment settings. If successful, these functions don't return to the calling process. A return value of -1 indicates an error, in which case the `errno` global variable is set. -|`errno` value|Description| -|-------------------|-----------------| -|`E2BIG`|The space that's required for the arguments and environment settings exceeds 32 KB.| -|`EACCES`|The specified file has a locking or sharing violation.| -|`EMFILE`|Too many files are open. (The specified file must be opened to determine whether it's executable.)| -|`ENOENT`|The file or path isn't found.| -|`ENOEXEC`|The specified file isn't executable or has an invalid executable-file format.| -|`ENOMEM`|Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, which indicates that the calling process wasn't allocated correctly.| +| `errno` value | Description | +|---|---| +| `E2BIG` | The space that's required for the arguments and environment settings exceeds 32 KB. | +| `EACCES` | The specified file has a locking or sharing violation. | +| `EMFILE` | Too many files are open. (The specified file must be opened to determine whether it's executable.) | +| `ENOENT` | The file or path isn't found. | +| `ENOEXEC` | The specified file isn't executable or has an invalid executable-file format. | +| `ENOMEM` | Not enough memory is available to execute the new process; the available memory has been corrupted; or an invalid block exists, which indicates that the calling process wasn't allocated correctly. | For more information about these and other return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -74,10 +74,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header|Optional header| -|--------------|---------------------|---------------------| -|**`_execvpe`**|\|\| -|**`_wexecvpe`**|\ or \|\| +| Function | Required header | Optional header | +|---|---|---| +| **`_execvpe`** | \ | \ | +| **`_wexecvpe`** | \ or \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/exit-exit-exit.md b/docs/c-runtime-library/reference/exit-exit-exit.md index 8273a2da7f1..7d12f643ba1 100644 --- a/docs/c-runtime-library/reference/exit-exit-exit.md +++ b/docs/c-runtime-library/reference/exit-exit-exit.md @@ -43,14 +43,14 @@ Although the **`exit`**, **`_Exit`** and **`_exit`** calls don't return a value, The **`exit`**, **`_Exit`**, **`_exit`**, **`quick_exit`**, **`_cexit`**, and **`_c_exit`** functions behave as follows. -|Function|Description| -|--------------|-----------------| -|**`exit`**|Performs complete C library termination procedures, terminates the process, and provides the supplied status code to the host environment.| -|**`_Exit`**|Performs minimal C library termination procedures, terminates the process, and provides the supplied status code to the host environment.| -|**`_exit`**|Performs minimal C library termination procedures, terminates the process, and provides the supplied status code to the host environment.| -|**`quick_exit`**|Performs quick C library termination procedures, terminates the process, and provides the supplied status code to the host environment.| -|**`_cexit`**|Performs complete C library termination procedures and returns to the caller. Doesn't terminate the process.| -|**`_c_exit`**|Performs minimal C library termination procedures and returns to the caller. Doesn't terminate the process.| +| Function | Description | +|---|---| +| **`exit`** | Performs complete C library termination procedures, terminates the process, and provides the supplied status code to the host environment. | +| **`_Exit`** | Performs minimal C library termination procedures, terminates the process, and provides the supplied status code to the host environment. | +| **`_exit`** | Performs minimal C library termination procedures, terminates the process, and provides the supplied status code to the host environment. | +| **`quick_exit`** | Performs quick C library termination procedures, terminates the process, and provides the supplied status code to the host environment. | +| **`_cexit`** | Performs complete C library termination procedures and returns to the caller. Doesn't terminate the process. | +| **`_c_exit`** | Performs minimal C library termination procedures and returns to the caller. Doesn't terminate the process. | When you call the **`exit`**, **`_Exit`** or **`_exit`** function, the destructors for any temporary or automatic objects that exist at the time of the call aren't called. An automatic object is a non-static local object defined in a function. A temporary object is an object that's created by the compiler, such as a value returned by a function call. To destroy an automatic object before you call **`exit`**, **`_Exit`**, or **`_exit`**, explicitly call the destructor for the object, as shown here: @@ -69,9 +69,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`exit`**, **`_Exit`**, **`_exit`**|`` or ``| +| Function | Required header | +|---|---| +| **`exit`**, **`_Exit`**, **`_exit`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/exp-expf.md b/docs/c-runtime-library/reference/exp-expf.md index ec64bc51dff..73b3bd3f4a6 100644 --- a/docs/c-runtime-library/reference/exp-expf.md +++ b/docs/c-runtime-library/reference/exp-expf.md @@ -43,12 +43,12 @@ The floating-point value to exponentiate the natural logarithm base *e* by. The **`exp`** functions return the exponential value of the floating-point parameter, *`x`*, if successful. That is, the result is *e**`x`*, where *e* is the base of the natural logarithm. On overflow, the function returns `INF` (infinity) and on underflow, **`exp`** returns 0. -|Input|SEH exception|`Matherr` exception| -|-----------|-------------------|-----------------------| -|± Quiet NaN, indeterminate|None|`_DOMAIN`| -|± Infinity|`INVALID`|`_DOMAIN`| -|x ≥ 7.097827e+002|`INEXACT+OVERFLOW`|`OVERFLOW`| -|X ≤ -7.083964e+002|`INEXACT+UNDERFLOW`|`UNDERFLOW`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± Quiet NaN, indeterminate | None | `_DOMAIN` | +| ± Infinity | `INVALID` | `_DOMAIN` | +| *`x`* ≥ 7.097827e+002 | `INEXACT`+`OVERFLOW` | `OVERFLOW` | +| *`x`* ≤ -7.083964e+002 | `INEXACT`+`UNDERFLOW` | `UNDERFLOW` | The **`exp`** function has an implementation that uses Streaming SIMD Extensions 2 (SSE2). See [`_set_SSE2_enable`](set-sse2-enable.md) for information and restrictions on using the SSE2 implementation. @@ -62,10 +62,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required C header|Required C++ header| -|--------------|---------------------|---| -|**`exp`**, **`expf`**, **`expl`**|``|`` or ``| -|**`exp`** macro| `` || +| Function | Required C header | Required C++ header | +|---|---|---| +| **`exp`**, **`expf`**, **`expl`** | `` | `` or `` | +| **`exp`** macro | `` | | For more compatibility information, see [Compatibility](../compatibility.md). @@ -93,5 +93,5 @@ exp( 2.302585 ) = 10.000000 ## See also [Math and floating-point support](../floating-point-support.md)\ -[`log, logf, log10, log10f`](log-logf-log10-log10f.md)\ +[`log`, `logf`, `log10`, `log10f`](log-logf-log10-log10f.md)\ [`_CIexp`](../ciexp.md) diff --git a/docs/c-runtime-library/reference/exp2-exp2f-exp2l.md b/docs/c-runtime-library/reference/exp2-exp2f-exp2l.md index 49f34864a55..06a3ce4566d 100644 --- a/docs/c-runtime-library/reference/exp2-exp2f-exp2l.md +++ b/docs/c-runtime-library/reference/exp2-exp2f-exp2l.md @@ -48,14 +48,14 @@ The value of the exponent. If successful, returns the base-2 exponent of *`x`*, that is, 2x. Otherwise, it returns one of the following values: -|Issue|Return| -|-----------|------------| -|*`x`* = ±0|1| -|*`x`* = -INFINITY|+0| -|*`x`* = +INFINITY|+INFINITY| -|*`x`* = NaN|NaN| -|Overflow range error|+HUGE_VAL, +HUGE_VALF, or +HUGE_VALL| -|Underflow range error|Correct result, after rounding| +| Issue | Return | +|---|---| +| *`x`* = ±0 | 1 | +| *`x`* = -INFINITY | +0 | +| *`x`* = +INFINITY | +INFINITY | +| *`x`* = NaN | NaN | +| Overflow range error | +HUGE_VAL, +HUGE_VALF, or +HUGE_VALL | +| Underflow range error | Correct result, after rounding | Errors are reported as specified in [`_matherr`](matherr.md). @@ -69,10 +69,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`exp2`**, **`expf2`**, **`expl2`**|\|\| -|**`exp2`** macro | \ || +| Routine | C header | C++ header | +|---|---|---| +| **`exp2`**, **`expf2`**, **`expl2`** | \ | \ | +| **`exp2`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/expand-dbg.md b/docs/c-runtime-library/reference/expand-dbg.md index 721dd328d22..8e826cebfc3 100644 --- a/docs/c-runtime-library/reference/expand-dbg.md +++ b/docs/c-runtime-library/reference/expand-dbg.md @@ -63,9 +63,9 @@ This function validates its parameters. If *`userData`* is a null pointer, or if ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_expand_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_expand_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/expand.md b/docs/c-runtime-library/reference/expand.md index e6afe387b1a..682ff340bce 100644 --- a/docs/c-runtime-library/reference/expand.md +++ b/docs/c-runtime-library/reference/expand.md @@ -56,9 +56,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_expand`**|\| +| Function | Required header | +|---|---| +| **`_expand`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/expm1-expm1f-expm1l.md b/docs/c-runtime-library/reference/expm1-expm1f-expm1l.md index db23e19fd9c..838790997cb 100644 --- a/docs/c-runtime-library/reference/expm1-expm1f-expm1l.md +++ b/docs/c-runtime-library/reference/expm1-expm1f-expm1l.md @@ -52,10 +52,10 @@ If you use the \ `expm1()` macro, the type of the argument determines ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`expm1`**, **`expm1f`**, **`expm1l`**|\| -|**`expm1`** macro | \ | +| Routine | Required header | +|---|---| +| **`expm1`**, **`expm1f`**, **`expm1l`** | \ | +| **`expm1`** macro | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fabs-fabsf-fabsl.md b/docs/c-runtime-library/reference/fabs-fabsf-fabsl.md index 32f78f14ccb..861dc3da5d5 100644 --- a/docs/c-runtime-library/reference/fabs-fabsf-fabsl.md +++ b/docs/c-runtime-library/reference/fabs-fabsf-fabsl.md @@ -44,9 +44,9 @@ Floating-point value. The **`fabs`** functions return the absolute value of the argument *`x`*. There's no error return. -|Input|SEH exception|`Matherr` exception| -|-----------|-------------------|-----------------------| -|± `QNAN`,`IND`|none|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | `_DOMAIN` | ## Remarks @@ -58,10 +58,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required C header|Required C++ header| -|--------------|-----------------------|---------------------------| -|**`fabs`**, **`fabsf`**, **`fabsl`**|``|`` or ``| -|**`fabs`** macro | `` || +| Function | Required C header | Required C++ header | +|---|---|---| +| **`fabs`**, **`fabsf`**, **`fabsl`** | `` | `` or `` | +| **`fabs`** macro | `` | | For more compatibility information, see [Compatibility](../compatibility.md). @@ -72,5 +72,5 @@ See the example for [`abs`](abs-labs-llabs-abs64.md). ## See also [Math and floating-point support](../floating-point-support.md)\ -[`abs, labs, llabs, _abs64`](abs-labs-llabs-abs64.md)\ +[`abs`, `labs`, `llabs`, `_abs64`](abs-labs-llabs-abs64.md)\ [`_cabs`](cabs.md) diff --git a/docs/c-runtime-library/reference/fclose-fcloseall.md b/docs/c-runtime-library/reference/fclose-fcloseall.md index 7a001b4244a..0d14b7eded9 100644 --- a/docs/c-runtime-library/reference/fclose-fcloseall.md +++ b/docs/c-runtime-library/reference/fclose-fcloseall.md @@ -48,10 +48,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fclose`**|``| -|**`_fcloseall`**|``| +| Function | Required header | +|---|---| +| **`fclose`** | `` | +| **`_fcloseall`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fclose-nolock.md b/docs/c-runtime-library/reference/fclose-nolock.md index 2290f33123a..76f542c5060 100644 --- a/docs/c-runtime-library/reference/fclose-nolock.md +++ b/docs/c-runtime-library/reference/fclose-nolock.md @@ -39,9 +39,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fclose_nolock`**|\| +| Function | Required header | +|---|---| +| **`_fclose_nolock`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fcvt-s.md b/docs/c-runtime-library/reference/fcvt-s.md index 55986a3b612..21b5c49baa3 100644 --- a/docs/c-runtime-library/reference/fcvt-s.md +++ b/docs/c-runtime-library/reference/fcvt-s.md @@ -63,12 +63,12 @@ When there's an invalid parameter, as listed in the following table, this functi ### Error conditions -|*`buffer`*|*`sizeInBytes`*|*`value`*|*`count`*|*`dec`*|*`sign`*|Return|Value in *`buffer`*| -|--------------|-------------------|-----------|-----------|---------|----------|------------|-----------------------| -|`NULL`|any|any|any|any|any|`EINVAL`|Not modified.| -|Not `NULL` (points to valid memory)|<=0|any|any|any|any|`EINVAL`|Not modified.| -|any|any|any|any|`NULL`|any|`EINVAL`|Not modified.| -|any|any|any|any|any|`NULL`|`EINVAL`|Not modified.| +| *`buffer`* | *`sizeInBytes`* | *`value`* | *`count`* | *`dec`* | *`sign`* | Return | Value in *`buffer`* | +|---|---|---|---|---|---|---|---| +| `NULL` | any | any | any | any | any | `EINVAL` | Not modified. | +| Not `NULL` (points to valid memory) | <=0 | any | any | any | any | `EINVAL` | Not modified. | +| any | any | any | any | `NULL` | any | `EINVAL` | Not modified. | +| any | any | any | any | any | `NULL` | `EINVAL` | Not modified. | ## Security Issues @@ -92,9 +92,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header|Optional header| -|--------------|---------------------|---------------------| -|**`_fcvt_s`**|\|\| +| Function | Required header | Optional header | +|---|---|---| +| **`_fcvt_s`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fcvt.md b/docs/c-runtime-library/reference/fcvt.md index f7b66bcec5b..0b19cf1a652 100644 --- a/docs/c-runtime-library/reference/fcvt.md +++ b/docs/c-runtime-library/reference/fcvt.md @@ -61,9 +61,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fcvt`**|\| +| Function | Required header | +|---|---| +| **`_fcvt`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fdim-fdimf-fdiml.md b/docs/c-runtime-library/reference/fdim-fdimf-fdiml.md index 7e70a7d1eae..652e9aaf6bb 100644 --- a/docs/c-runtime-library/reference/fdim-fdimf-fdiml.md +++ b/docs/c-runtime-library/reference/fdim-fdimf-fdiml.md @@ -57,18 +57,18 @@ The second value. Returns the positive difference between *`x`* and *`y`*: -|Return value|Scenario| -|------------------|--------------| -|x-y|if x > y| -|0|if x <= y| +| Return value | Scenario | +|---|---| +| `x-y` | if *`x`* > *`y`* | +| 0 | if *`x`* <= *`y`* | Otherwise, may return one of the following errors: -|Issue|Return| -|-----------|------------| -|Overflow range error|+HUGE_VAL, +HUGE_VALF, or +HUGE_VALL| -|Underflow range error|correct value (after rounding)| -|*`x`* or *`y`* is NaN|NaN| +| Issue | Return | +|---|---| +| Overflow range error | +HUGE_VAL, +HUGE_VALF, or +HUGE_VALL | +| Underflow range error | correct value (after rounding) | +| *`x`* or *`y`* is NaN | NaN | Errors are reported as specified in [`_matherr`](matherr.md). @@ -82,10 +82,10 @@ Except for the NaN handling, this function is equivalent to `fmax(x - y, 0)`. ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`fdim`**, **`fdimf`**, **`fdiml`**|\|\| -|**`fdim`** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`fdim`**, **`fdimf`**, **`fdiml`** | \ | \ | +| **`fdim`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/feclearexcept1.md b/docs/c-runtime-library/reference/feclearexcept1.md index c56fd431ee1..de74f7735a4 100644 --- a/docs/c-runtime-library/reference/feclearexcept1.md +++ b/docs/c-runtime-library/reference/feclearexcept1.md @@ -35,22 +35,22 @@ Returns zero if *`excepts`* is zero, or if all the specified exceptions were suc The **`feclearexcept`** function attempts to clear the floating point exception status flags specified by *`excepts`*. The function supports these exception macros, defined in fenv.h: -|Exception Macro|Description| -|---------------------|-----------------| -|`FE_DIVBYZERO`|A singularity or pole error occurred in an earlier floating-point operation; an infinity value was created.| -|`FE_INEXACT`|The function was forced to round the stored result of an earlier floating-point operation.| -|`FE_INVALID`|A domain error occurred in an earlier floating-point operation.| -|`FE_OVERFLOW`|A range error occurred; an earlier floating-point operation result was too large to be represented.| -|`FE_UNDERFLOW`|An earlier floating-point operation result was too small to be represented at full precision; a denormal value was created.| -|`FE_ALL_EXCEPT`|The bitwise OR of all supported floating-point exceptions.| +| Exception macro | Description | +|---|---| +| `FE_DIVBYZERO` | A singularity or pole error occurred in an earlier floating-point operation; an infinity value was created. | +| `FE_INEXACT` | The function was forced to round the stored result of an earlier floating-point operation. | +| `FE_INVALID` | A domain error occurred in an earlier floating-point operation. | +| `FE_OVERFLOW` | A range error occurred; an earlier floating-point operation result was too large to be represented. | +| `FE_UNDERFLOW` | An earlier floating-point operation result was too small to be represented at full precision; a denormal value was created. | +| `FE_ALL_EXCEPT` | The bitwise OR of all supported floating-point exceptions. | The *`excepts`* argument may be zero, or the bitwise OR of one or more of the supported exception macros. The result of any other argument value is undefined. ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`feclearexcept`**|\|\| +| Function | C header | C++ header | +|---|---|---| +| **`feclearexcept`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fegetenv1.md b/docs/c-runtime-library/reference/fegetenv1.md index d45abb89faf..e14e60b558c 100644 --- a/docs/c-runtime-library/reference/fegetenv1.md +++ b/docs/c-runtime-library/reference/fegetenv1.md @@ -39,9 +39,9 @@ To use this function, you must turn off floating-point optimizations that could ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`fegetenv`**|\|\| +| Function | C header | C++ header | +|---|---|---| +| **`fegetenv`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fegetexceptflag2.md b/docs/c-runtime-library/reference/fegetexceptflag2.md index 02db100dc3a..eee0d9ff14a 100644 --- a/docs/c-runtime-library/reference/fegetexceptflag2.md +++ b/docs/c-runtime-library/reference/fegetexceptflag2.md @@ -39,14 +39,14 @@ On success, returns 0. Otherwise, it returns a non-zero value. The **`fegetexceptflag`** function stores the current state of the floating-point exception status flags specified by *`excepts`* in the `fexcept_t` object pointed to by *`pstatus`*. *`pstatus`* must point to a valid `fexcept_t` object, or subsequent behavior is undefined. The **`fegetexceptflag`** function supports these exception macros, defined in \: -|Exception Macro|Description| -|---------------------|-----------------| -|`FE_DIVBYZERO`|A singularity or pole error occurred in an earlier floating-point operation; an infinity value was created.| -|`FE_INEXACT`|The function was forced to round the stored result of an earlier floating-point operation.| -|`FE_INVALID`|A domain error occurred in an earlier floating-point operation.| -|`FE_OVERFLOW`|A range error occurred; an earlier floating-point operation result was too large to be represented.| -|`FE_UNDERFLOW`|An earlier floating-point operation result was too small to be represented at full precision; a denormal value was created.| -|`FE_ALL_EXCEPT`|The bitwise OR of all supported floating-point exceptions.| +| Exception macro | Description | +|---|---| +| `FE_DIVBYZERO` | A singularity or pole error occurred in an earlier floating-point operation; an infinity value was created. | +| `FE_INEXACT` | The function was forced to round the stored result of an earlier floating-point operation. | +| `FE_INVALID` | A domain error occurred in an earlier floating-point operation. | +| `FE_OVERFLOW` | A range error occurred; an earlier floating-point operation result was too large to be represented. | +| `FE_UNDERFLOW` | An earlier floating-point operation result was too small to be represented at full precision; a denormal value was created. | +| `FE_ALL_EXCEPT` | The bitwise OR of all supported floating-point exceptions. | The *`excepts`* argument may be zero, one of the supported floating-point exception macros, or the bitwise OR of two or more of the macros. The effect of any other argument value is undefined. @@ -54,9 +54,9 @@ To use this function, you must turn off floating-point optimizations that could ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`fegetexceptflag`**|\|\| +| Function | C header | C++ header | +|---|---|---| +| **`fegetexceptflag`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fegetround-fesetround2.md b/docs/c-runtime-library/reference/fegetround-fesetround2.md index d37757c2e86..8a6a2741591 100644 --- a/docs/c-runtime-library/reference/fegetround-fesetround2.md +++ b/docs/c-runtime-library/reference/fegetround-fesetround2.md @@ -39,12 +39,12 @@ On success, **`fesetround`** returns 0. Otherwise, a non-zero value is returned. Floating-point operations can use one of several rounding modes. These modes control which direction the results of floating-point operations are rounded toward when the results are stored. Here are the names and behaviors of the floating-point rounding macros defined in \: -|Macro|Description| -|-----------|-----------------| -|`FE_DOWNWARD`|Round towards negative infinity.| -|`FE_TONEAREST`|Round towards the nearest.| -|`FE_TOWARDZERO`|Round towards zero.| -|`FE_UPWARD`|Round towards positive infinity.| +| Macro | Description | +|---|---| +| `FE_DOWNWARD` | Round towards negative infinity. | +| `FE_TONEAREST` | Round towards the nearest. | +| `FE_TOWARDZERO` | Round towards zero. | +| `FE_UPWARD` | Round towards positive infinity. | The default behavior of `FE_TONEAREST` is to round results midway between representable values toward the nearest value with an even (0) least significant bit. @@ -70,9 +70,9 @@ To use these functions, you must turn off floating-point optimizations that coul ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`fegetround`**, **`fesetround`**|\|\| +| Function | C header | C++ header | +|---|---|---| +| **`fegetround`**, **`fesetround`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/feholdexcept2.md b/docs/c-runtime-library/reference/feholdexcept2.md index 700f550f79f..fbf45b3e331 100644 --- a/docs/c-runtime-library/reference/feholdexcept2.md +++ b/docs/c-runtime-library/reference/feholdexcept2.md @@ -41,9 +41,9 @@ To use this function, you must turn off floating-point optimizations that could ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`feholdexcept`**|\|\| +| Function | C header | C++ header | +|---|---|---| +| **`feholdexcept`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/feof.md b/docs/c-runtime-library/reference/feof.md index a4f97756a32..befc424765c 100644 --- a/docs/c-runtime-library/reference/feof.md +++ b/docs/c-runtime-library/reference/feof.md @@ -43,9 +43,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`feof`**|\| +| Function | Required header | +|---|---| +| **`feof`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/feraiseexcept.md b/docs/c-runtime-library/reference/feraiseexcept.md index 3ad83b7f653..90eb2f4f93d 100644 --- a/docs/c-runtime-library/reference/feraiseexcept.md +++ b/docs/c-runtime-library/reference/feraiseexcept.md @@ -34,14 +34,14 @@ If all specified exceptions are raised successfully, returns 0. The **`feraiseexcept`** function attempts to raise the floating-point exceptions specified by *`excepts`*. The **`feraiseexcept`** function supports these exception macros, defined in \: -|Exception Macro|Description| -|---------------------|-----------------| -|`FE_DIVBYZERO`|A singularity or pole error occurred in an earlier floating-point operation; an infinity value was created.| -|`FE_INEXACT`|The function was forced to round the stored result of an earlier floating-point operation.| -|`FE_INVALID`|A domain error occurred in an earlier floating-point operation.| -|`FE_OVERFLOW`|A range error occurred; an earlier floating-point operation result was too large to be represented.| -|`FE_UNDERFLOW`|An earlier floating-point operation result was too small to be represented at full precision; a denormal value was created.| -|`FE_ALL_EXCEPT`|The bitwise OR of all supported floating-point exceptions.| +| Exception Macro | Description | +|---|---| +| `FE_DIVBYZERO` | A singularity or pole error occurred in an earlier floating-point operation; an infinity value was created. | +| `FE_INEXACT` | The function was forced to round the stored result of an earlier floating-point operation. | +| `FE_INVALID` | A domain error occurred in an earlier floating-point operation. | +| `FE_OVERFLOW` | A range error occurred; an earlier floating-point operation result was too large to be represented. | +| `FE_UNDERFLOW` | An earlier floating-point operation result was too small to be represented at full precision; a denormal value was created. | +| `FE_ALL_EXCEPT` | The bitwise OR of all supported floating-point exceptions. | The *`excepts`* argument may be zero, one of the exception macro values, or the bitwise OR of two or more of the supported exception macros. If one of the specified exception macros is `FE_OVERFLOW` or `FE_UNDERFLOW`, the `FE_INEXACT` exception may be raised as a side-effect. @@ -51,9 +51,9 @@ To use this function, you must turn off floating-point optimizations that could ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|`feraiseexcept`|\|\| +| Function | C header | C++ header | +|---|---|---| +| `feraiseexcept` | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ferror.md b/docs/c-runtime-library/reference/ferror.md index b340bb3fc92..eebf0c44e3d 100644 --- a/docs/c-runtime-library/reference/ferror.md +++ b/docs/c-runtime-library/reference/ferror.md @@ -41,9 +41,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`ferror`**|\| +| Function | Required header | +|---|---| +| **`ferror`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fesetenv1.md b/docs/c-runtime-library/reference/fesetenv1.md index b2fa358d81e..9f0535d02c1 100644 --- a/docs/c-runtime-library/reference/fesetenv1.md +++ b/docs/c-runtime-library/reference/fesetenv1.md @@ -41,9 +41,9 @@ To use this function, you must turn off floating-point optimizations that could ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`fesetenv`**|\|\| +| Function | C header | C++ header | +|---|---|---| +| **`fesetenv`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fesetexceptflag2.md b/docs/c-runtime-library/reference/fesetexceptflag2.md index 37bfe491c7b..9ab471a0180 100644 --- a/docs/c-runtime-library/reference/fesetexceptflag2.md +++ b/docs/c-runtime-library/reference/fesetexceptflag2.md @@ -39,14 +39,14 @@ If all the specified exception status flags are set successfully, returns 0. Oth The **`fesetexceptflag`** function sets the state of the floating-point exception status flags specified by *`excepts`* to the corresponding values set in the `fexcept_t` object pointed to by *`pstatus`*. It doesn't raise the exceptions. The *`pstatus`* pointer must point to a valid `fexcept_t` object, or subsequent behavior is undefined. The **`fesetexceptflag`** function supports these exception macro values in *`excepts`*, defined in \: -|Exception Macro|Description| -|---------------------|-----------------| -|`FE_DIVBYZERO`|A singularity or pole error occurred in an earlier floating-point operation; an infinity value was created.| -|`FE_INEXACT`|The function was forced to round the stored result of an earlier floating-point operation.| -|`FE_INVALID`|A domain error occurred in an earlier floating-point operation.| -|`FE_OVERFLOW`|A range error occurred; an earlier floating-point operation result was too large to be represented.| -|`FE_UNDERFLOW`|An earlier floating-point operation result was too small to be represented at full precision; a denormal value was created.| -|`FE_ALL_EXCEPT`|The bitwise OR of all supported floating-point exceptions.| +| Exception Macro | Description | +|---|---| +| `FE_DIVBYZERO` | A singularity or pole error occurred in an earlier floating-point operation; an infinity value was created. | +| `FE_INEXACT` | The function was forced to round the stored result of an earlier floating-point operation. | +| `FE_INVALID` | A domain error occurred in an earlier floating-point operation. | +| `FE_OVERFLOW` | A range error occurred; an earlier floating-point operation result was too large to be represented. | +| `FE_UNDERFLOW` | An earlier floating-point operation result was too small to be represented at full precision; a denormal value was created. | +| `FE_ALL_EXCEPT` | The bitwise OR of all supported floating-point exceptions. | The *`excepts`* argument may be zero, one of the supported floating-point exception macros, or the bitwise OR of two or more of the macros. The effect of any other argument value is undefined. @@ -54,9 +54,9 @@ To use this function, you must turn off floating-point optimizations that could ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`fesetexceptflag`**|\|\| +| Function | C header | C++ header | +|---|---|---| +| **`fesetexceptflag`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fetestexcept1.md b/docs/c-runtime-library/reference/fetestexcept1.md index da143255021..9022c438b82 100644 --- a/docs/c-runtime-library/reference/fetestexcept1.md +++ b/docs/c-runtime-library/reference/fetestexcept1.md @@ -35,14 +35,14 @@ On success, returns a bitmask containing a bitwise OR of the floating-point exce Use the fetestexcept function to determine which exceptions were raised by a floating point operation. Use the *`excepts`* parameter to specify which exception status flags to test. The **`fetestexcept`** function uses these exception macros defined in \ in *`excepts`* and the return value: -|Exception Macro|Description| -|---------------------|-----------------| -|`FE_DIVBYZERO`|A singularity or pole error occurred in an earlier floating-point operation; an infinity value was created.| -|`FE_INEXACT`|The function was forced to round the stored result of an earlier floating-point operation.| -|`FE_INVALID`|A domain error occurred in an earlier floating-point operation.| -|`FE_OVERFLOW`|A range error occurred; an earlier floating-point operation result was too large to be represented.| -|`FE_UNDERFLOW`|An earlier floating-point operation result was too small to be represented at full precision; a denormal value was created.| -|`FE_ALL_EXCEPT`|The bitwise OR of all supported floating-point exceptions.| +| Exception Macro | Description | +|---|---| +| `FE_DIVBYZERO` | A singularity or pole error occurred in an earlier floating-point operation; an infinity value was created. | +| `FE_INEXACT` | The function was forced to round the stored result of an earlier floating-point operation. | +| `FE_INVALID` | A domain error occurred in an earlier floating-point operation. | +| `FE_OVERFLOW` | A range error occurred; an earlier floating-point operation result was too large to be represented. | +| `FE_UNDERFLOW` | An earlier floating-point operation result was too small to be represented at full precision; a denormal value was created. | +| `FE_ALL_EXCEPT` | The bitwise OR of all supported floating-point exceptions. | The specified *`excepts`* argument may be 0, one of the supported floating-point exception macros, or the bitwise OR of two or more of the macros. The effect of any other *`excepts`* argument value is undefined. @@ -50,9 +50,9 @@ To use this function, you must turn off floating-point optimizations that could ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`fetestexcept`**|\|\| +| Function | C header | C++ header | +|---|---|---| +| **`fetestexcept`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/feupdateenv.md b/docs/c-runtime-library/reference/feupdateenv.md index d75e0b057ce..288e355f6be 100644 --- a/docs/c-runtime-library/reference/feupdateenv.md +++ b/docs/c-runtime-library/reference/feupdateenv.md @@ -38,9 +38,9 @@ To use this function, you must turn off floating-point optimizations that could ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`feupdateenv`**|\|\| +| Function | C header | C++ header | +|---|---|---| +| **`feupdateenv`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fflush-nolock.md b/docs/c-runtime-library/reference/fflush-nolock.md index 449c36279aa..c5f76937d0f 100644 --- a/docs/c-runtime-library/reference/fflush-nolock.md +++ b/docs/c-runtime-library/reference/fflush-nolock.md @@ -39,9 +39,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fflush_nolock`**|\| +| Function | Required header | +|---|---| +| **`_fflush_nolock`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fflush.md b/docs/c-runtime-library/reference/fflush.md index 496df3316b4..c91714b9caf 100644 --- a/docs/c-runtime-library/reference/fflush.md +++ b/docs/c-runtime-library/reference/fflush.md @@ -49,9 +49,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fflush`**|``| +| Function | Required header | +|---|---| +| **`fflush`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fgetc-fgetwc.md b/docs/c-runtime-library/reference/fgetc-fgetwc.md index 167546f68a5..fc89e8a7166 100644 --- a/docs/c-runtime-library/reference/fgetc-fgetwc.md +++ b/docs/c-runtime-library/reference/fgetc-fgetwc.md @@ -50,16 +50,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_fgettc`|**`fgetc`**|**`fgetc`**|**`fgetwc`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_fgettc` | **`fgetc`** | **`fgetc`** | **`fgetwc`** | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fgetc`**|\| -|**`fgetwc`**|\ or \| +| Function | Required header | +|---|---| +| **`fgetc`** | \ | +| **`fgetwc`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fgetc-nolock-fgetwc-nolock.md b/docs/c-runtime-library/reference/fgetc-nolock-fgetwc-nolock.md index da391a38201..4df07841515 100644 --- a/docs/c-runtime-library/reference/fgetc-nolock-fgetwc-nolock.md +++ b/docs/c-runtime-library/reference/fgetc-nolock-fgetwc-nolock.md @@ -42,16 +42,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_fgettc_nolock`**|**`_fgetc_nolock`**|**`_fgetc_nolock`**|**`_fgetwc_nolock`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_fgettc_nolock`** | **`_fgetc_nolock`** | **`_fgetc_nolock`** | **`_fgetwc_nolock`** | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fgetc_nolock`**|\| -|**`_fgetwc_nolock`**|\ or \| +| Function | Required header | +|---|---| +| **`_fgetc_nolock`** | \ | +| **`_fgetwc_nolock`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fgetchar-fgetwchar.md b/docs/c-runtime-library/reference/fgetchar-fgetwchar.md index 4d27447758d..90beac6f31e 100644 --- a/docs/c-runtime-library/reference/fgetchar-fgetwchar.md +++ b/docs/c-runtime-library/reference/fgetchar-fgetwchar.md @@ -37,16 +37,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_fgettchar`|**`_fgetchar`**|**`_fgetchar`**|**`_fgetwchar`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_fgettchar` | **`_fgetchar`** | **`_fgetchar`** | **`_fgetwchar`** | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fgetchar`**|\| -|**`_fgetwchar`**|\ or \| +| Function | Required header | +|---|---| +| **`_fgetchar`** | \ | +| **`_fgetwchar`** | \ or \ | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console—`stdin`, `stdout`, and `stderr`—must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fgetpos.md b/docs/c-runtime-library/reference/fgetpos.md index fbc962de825..677017cde88 100644 --- a/docs/c-runtime-library/reference/fgetpos.md +++ b/docs/c-runtime-library/reference/fgetpos.md @@ -43,9 +43,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fgetpos`**|\| +| Function | Required header | +|---|---| +| **`fgetpos`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fgets-fgetws.md b/docs/c-runtime-library/reference/fgets-fgetws.md index de57b94a507..97746be77fc 100644 --- a/docs/c-runtime-library/reference/fgets-fgetws.md +++ b/docs/c-runtime-library/reference/fgets-fgetws.md @@ -58,16 +58,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_fgetts`**|**`fgets`**|**`fgets`**|**`fgetws`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_fgetts`** | **`fgets`** | **`fgets`** | **`fgetws`** | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fgets`**|``| -|**`fgetws`**|`` or ``| +| Function | Required header | +|---|---| +| **`fgets`** | `` | +| **`fgetws`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/filelength-filelengthi64.md b/docs/c-runtime-library/reference/filelength-filelengthi64.md index 3003c87eaa4..2e6a2de2fba 100644 --- a/docs/c-runtime-library/reference/filelength-filelengthi64.md +++ b/docs/c-runtime-library/reference/filelength-filelengthi64.md @@ -40,10 +40,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_filelength`**|\| -|**`_filelengthi64`**|\| +| Function | Required header | +|---|---| +| **`_filelength`** | \ | +| **`_filelengthi64`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fileno.md b/docs/c-runtime-library/reference/fileno.md index b2be83c2103..ee1856c7530 100644 --- a/docs/c-runtime-library/reference/fileno.md +++ b/docs/c-runtime-library/reference/fileno.md @@ -43,9 +43,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fileno`**|``| +| Function | Required header | +|---|---| +| **`_fileno`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/findclose.md b/docs/c-runtime-library/reference/findclose.md index cb65562c22c..2763ab76f9c 100644 --- a/docs/c-runtime-library/reference/findclose.md +++ b/docs/c-runtime-library/reference/findclose.md @@ -37,9 +37,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_findclose`**|\| +| Function | Required header | +|---|---| +| **`_findclose`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/findfirst-functions.md b/docs/c-runtime-library/reference/findfirst-functions.md index b43d557feb5..d6f99c981a6 100644 --- a/docs/c-runtime-library/reference/findfirst-functions.md +++ b/docs/c-runtime-library/reference/findfirst-functions.md @@ -108,44 +108,44 @@ By default, this function's global state is scoped to the application. To change ### Time Type and File Length Type Variations of _findfirst -|Functions|`_USE_32BIT_TIME_T` defined?|Time type|File length type| -|---------------|----------------------------------|---------------|----------------------| -|**`_findfirst`**, **`_wfindfirst`**|Not defined|64-bit|32-bit| -|**`_findfirst`**, **`_wfindfirst`**|Defined|32-bit|32-bit| -|**`_findfirst32`**, **`_wfindfirst32`**|Not affected by the macro definition|32-bit|32-bit| -|**`_findfirst64`**, **`_wfindfirst64`**|Not affected by the macro definition|64-bit|64-bit| -|**`_findfirsti64`**, **`_wfindfirsti64`**|Not defined|64-bit|64-bit| -|**`_findfirsti64`**, **`_wfindfirsti64`**|Defined|32-bit|64-bit| -|**`_findfirst32i64`**, **`_wfindfirst32i64`**|Not affected by the macro definition|32-bit|64-bit| -|**`_findfirst64i32`**, **`_wfindfirst64i32`**|Not affected by the macro definition|64-bit|32-bit| +| Functions | `_USE_32BIT_TIME_T` defined? | Time type | File length type | +|---|---|---|---| +| **`_findfirst`**, **`_wfindfirst`** | Not defined | 64-bit | 32-bit | +| **`_findfirst`**, **`_wfindfirst`** | Defined | 32-bit | 32-bit | +| **`_findfirst32`**, **`_wfindfirst32`** | Not affected by the macro definition | 32-bit | 32-bit | +| **`_findfirst64`**, **`_wfindfirst64`** | Not affected by the macro definition | 64-bit | 64-bit | +| **`_findfirsti64`**, **`_wfindfirsti64`** | Not defined | 64-bit | 64-bit | +| **`_findfirsti64`**, **`_wfindfirsti64`** | Defined | 32-bit | 64-bit | +| **`_findfirst32i64`**, **`_wfindfirst32i64`** | Not affected by the macro definition | 32-bit | 64-bit | +| **`_findfirst64i32`**, **`_wfindfirst64i32`** | Not affected by the macro definition | 64-bit | 32-bit | ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_tfindfirst`**|**`_findfirst`**|**`_findfirst`**|**`_wfindfirst`**| -|**`_tfindfirst32`**|**`_findfirst32`**|**`_findfirst32`**|**`_wfindfirst32`**| -|**`_tfindfirst64`**|**`_findfirst64`**|**`_findfirst64`**|**`_wfindfirst64`**| -|**`_tfindfirsti64`**|**`_findfirsti64`**|**`_findfirsti64`**|**`_wfindfirsti64`**| -|**`_tfindfirst32i64`**|**`_findfirst32i64`**|**`_findfirst32i64`**|**`_wfindfirst32i64`**| -|**`_tfindfirst64i32`**|**`_findfirst64i32`**|**`_findfirst64i32`**|**`_wfindfirst64i32`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tfindfirst`** | **`_findfirst`** | **`_findfirst`** | **`_wfindfirst`** | +| **`_tfindfirst32`** | **`_findfirst32`** | **`_findfirst32`** | **`_wfindfirst32`** | +| **`_tfindfirst64`** | **`_findfirst64`** | **`_findfirst64`** | **`_wfindfirst64`** | +| **`_tfindfirsti64`** | **`_findfirsti64`** | **`_findfirsti64`** | **`_wfindfirsti64`** | +| **`_tfindfirst32i64`** | **`_findfirst32i64`** | **`_findfirst32i64`** | **`_wfindfirst32i64`** | +| **`_tfindfirst64i32`** | **`_findfirst64i32`** | **`_findfirst64i32`** | **`_wfindfirst64i32`** | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_findfirst`**|``| -|**`_findfirst32`**|``| -|**`_findfirst64`**|``| -|**`_findfirsti64`**|``| -|**`_findfirst32i64`**|``| -|**`_findfirst64i32`**|``| -|**`_wfindfirst`**|`` or ``| -|**`_wfindfirst32`**|`` or ``| -|**`_wfindfirst64`**|`` or ``| -|**`_wfindfirsti64`**|`` or ``| -|**`_wfindfirst32i64`**|`` or ``| -|**`_wfindfirst64i32`**|`` or ``| +| Function | Required header | +|---|---| +| **`_findfirst`** | `` | +| **`_findfirst32`** | `` | +| **`_findfirst64`** | `` | +| **`_findfirsti64`** | `` | +| **`_findfirst32i64`** | `` | +| **`_findfirst64i32`** | `` | +| **`_wfindfirst`** | `` or `` | +| **`_wfindfirst32`** | `` or `` | +| **`_wfindfirst64`** | `` or `` | +| **`_wfindfirsti64`** | `` or `` | +| **`_wfindfirst32i64`** | `` or `` | +| **`_wfindfirst64i32`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/findnext-functions.md b/docs/c-runtime-library/reference/findnext-functions.md index 35e0ead5c82..40676361c78 100644 --- a/docs/c-runtime-library/reference/findnext-functions.md +++ b/docs/c-runtime-library/reference/findnext-functions.md @@ -79,8 +79,8 @@ File information buffer. If successful, returns 0. Otherwise, returns -1 and sets `errno` to a value indicating the nature of the failure. Possible error codes are shown in the following table. -|errno value|Condition| -|-|-| +| `errno` value | Condition | +|---|---| | `EINVAL` | Invalid parameter: *`fileinfo`* was `NULL`. Or, the operating system returned an unexpected error. | | `ENOENT` | No more matching files could be found. | | `ENOMEM` | Not enough memory or the file name's length exceeded `MAX_PATH`. | @@ -101,44 +101,44 @@ By default, this function's global state is scoped to the application. To change ### Time Type and File Length Type Variations of _findnext -|Functions|`_USE_32BIT_TIME_T` defined?|Time type|File length type| -|---------------|----------------------------------|---------------|----------------------| -|**`_findnext`**, **`_wfindnext`**|Not defined|64-bit|32-bit| -|**`_findnext`**, **`_wfindnext`**|Defined|32-bit|32-bit| -|**`_findnext32`**, **`_wfindnext32`**|Not affected by the macro definition|32-bit|32-bit| -|**`_findnext64`**, **`_wfindnext64`**|Not affected by the macro definition|64-bit|64-bit| -|**`_findnexti64`**, **`_wfindnexti64`**|Not defined|64-bit|64-bit| -|**`_findnexti64`**, **`_wfindnexti64`**|Defined|32-bit|64-bit| -|**`_findnext32i64`**, **`_wfindnext32i64`**|Not affected by the macro definition|32-bit|64-bit| -|**`_findnext64i32`**, **`_wfindnext64i32`**|Not affected by the macro definition|64-bit|32-bit| +| Functions | `_USE_32BIT_TIME_T` defined? | Time type | File length type | +|---|---|---|---| +| **`_findnext`**, **`_wfindnext`** | Not defined | 64-bit | 32-bit | +| **`_findnext`**, **`_wfindnext`** | Defined | 32-bit | 32-bit | +| **`_findnext32`**, **`_wfindnext32`** | Not affected by the macro definition | 32-bit | 32-bit | +| **`_findnext64`**, **`_wfindnext64`** | Not affected by the macro definition | 64-bit | 64-bit | +| **`_findnexti64`**, **`_wfindnexti64`** | Not defined | 64-bit | 64-bit | +| **`_findnexti64`**, **`_wfindnexti64`** | Defined | 32-bit | 64-bit | +| **`_findnext32i64`**, **`_wfindnext32i64`** | Not affected by the macro definition | 32-bit | 64-bit | +| **`_findnext64i32`**, **`_wfindnext64i32`** | Not affected by the macro definition | 64-bit | 32-bit | ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tfindnext`|**`_findnext`**|**`_findnext`**|**`_wfindnext`**| -|`_tfindnext32`|**`_findnext32`**|**`_findnext32`**|**`_wfindnext32`**| -|`_tfindnext64`|**`_findnext64`**|**`_findnext64`**|**`_wfindnext64`**| -|`_tfindnexti64`|**`_findnexti64`**|**`_findnexti64`**|**`_wfindnexti64`**| -|**`_tfindnext32i64`**|**`_findnext32i64`**|**`_findnext32i64`**|**`_wfindnext32i64`**| -|**`_tfindnext64i32`**|**`_findnext64i32`**|**`_findnext64i32`**|**`_wfindnext64i32`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tfindnext` | **`_findnext`** | **`_findnext`** | **`_wfindnext`** | +| `_tfindnext32` | **`_findnext32`** | **`_findnext32`** | **`_wfindnext32`** | +| `_tfindnext64` | **`_findnext64`** | **`_findnext64`** | **`_wfindnext64`** | +| `_tfindnexti64` | **`_findnexti64`** | **`_findnexti64`** | **`_wfindnexti64`** | +| **`_tfindnext32i64`** | **`_findnext32i64`** | **`_findnext32i64`** | **`_wfindnext32i64`** | +| **`_tfindnext64i32`** | **`_findnext64i32`** | **`_findnext64i32`** | **`_wfindnext64i32`** | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_findnext`**|\| -|**`_findnext32`**|\| -|**`_findnext64`**|\| -|**`_findnexti64`**|\| -|**`_findnext32i64`**|\| -|**`_findnext64i32`**|\| -|**`_wfindnext`**|\ or \| -|**`_wfindnext32`**|\ or \| -|**`_wfindnext64`**|\ or \| -|**`_wfindnexti64`**|\ or \| -|**`_wfindnext32i64`**|\ or \| -|**`_wfindnext64i32`**|\ or \| +| Function | Required header | +|---|---| +| **`_findnext`** | \ | +| **`_findnext32`** | \ | +| **`_findnext64`** | \ | +| **`_findnexti64`** | \ | +| **`_findnext32i64`** | \ | +| **`_findnext64i32`** | \ | +| **`_wfindnext`** | \ or \ | +| **`_wfindnext32`** | \ or \ | +| **`_wfindnext64`** | \ or \ | +| **`_wfindnexti64`** | \ or \ | +| **`_wfindnext32i64`** | \ or \ | +| **`_wfindnext64i32`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/finite-finitef.md b/docs/c-runtime-library/reference/finite-finitef.md index 1c9074943f3..4bc7c14d38a 100644 --- a/docs/c-runtime-library/reference/finite-finitef.md +++ b/docs/c-runtime-library/reference/finite-finitef.md @@ -50,10 +50,10 @@ The `isfinite` macro and the `_finite` and `_finitef` functions return a non-zer ## Requirements -|Function|Required header (C)|Required header (C++)| -|--------------|---------------------------|-------------------------------| -|`_finite`|\ or \|\, \, \, or \| -|`isfinite`, `_finitef`|\|\ or \| +| Function | Required header (C) | Required header (C++) | +|---|---|---| +| `_finite` | \ or \ | \, \, \, or \ | +| `isfinite`, `_finitef` | \ | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/floating-point-ordering.md b/docs/c-runtime-library/reference/floating-point-ordering.md index 987142c2e8d..ece44b97be9 100644 --- a/docs/c-runtime-library/reference/floating-point-ordering.md +++ b/docs/c-runtime-library/reference/floating-point-ordering.md @@ -102,8 +102,8 @@ These comparison operations are implemented as macros when compiled as C, and as ## Requirements -|Function|Required header (C)|Required header (C++)| -|--------------|---------------------------|-------------------------------| +| Function | Required header (C) | Required header (C++) | +|---|---|---| | **`isgreater`**, **`isgreaterequal`**, **`isless`**,
**`islessequal`**, **`islessgreater`**, **`isunordered`** | \ | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/floating-point-primitives.md b/docs/c-runtime-library/reference/floating-point-primitives.md index 14f1346eed9..7be31bf72f6 100644 --- a/docs/c-runtime-library/reference/floating-point-primitives.md +++ b/docs/c-runtime-library/reference/floating-point-primitives.md @@ -34,8 +34,8 @@ Floating-point function argument. These floating-point primitives implement the C versions of the CRT macro [`fpclassify`](fpclassify.md) for floating-point types. The classification of the argument *`x`* is returned as one of these constants, defined in math.h: -|Value|Description| -|-----------|-----------------| +| Value | Description | +|---|---| | `FP_NAN` | A quiet, signaling, or indeterminate NaN | | `FP_INFINITE` | A positive or negative infinity | | `FP_NORMAL` | A positive or negative normalized non-zero value | @@ -109,8 +109,8 @@ Pointer to a floating-point argument. These floating-point primitives implement the C++ versions of the CRT function [`fpclassify`](fpclassify.md) for floating-point types. The argument *`x`* is evaluated and the classification is returned as one of these constants, defined in math.h: -|Value|Description| -|-----------|-----------------| +| Value | Description | +|---|---| | `FP_NAN` | A quiet, signaling, or indeterminate NaN | | `FP_INFINITE` | A positive or negative infinity | | `FP_NORMAL` | A positive or negative normalized non-zero value | diff --git a/docs/c-runtime-library/reference/floor-floorf-floorl.md b/docs/c-runtime-library/reference/floor-floorf-floorl.md index 96eb5828674..cf7f9a8e5da 100644 --- a/docs/c-runtime-library/reference/floor-floorf-floorl.md +++ b/docs/c-runtime-library/reference/floor-floorf-floorl.md @@ -44,9 +44,9 @@ Floating-point value. The **`floor`** functions return a floating-point value that represents the largest integer that is less than or equal to *`x`*. There's no error return. -|Input|SEH Exception|`Matherr` Exception| -|-----------|-------------------|-----------------------| -|± QNAN, IND|none|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | `_DOMAIN` | **`floor`** 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). @@ -60,10 +60,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`floor`**, **`floorf`**, **`floorl`**|\| -|**`floor`** macro | \ | +| Function | Required header | +|---|---| +| **`floor`**, **`floorf`**, **`floorl`** | \ | +| **`floor`** macro | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/flushall.md b/docs/c-runtime-library/reference/flushall.md index 56de2b77e25..995817fda17 100644 --- a/docs/c-runtime-library/reference/flushall.md +++ b/docs/c-runtime-library/reference/flushall.md @@ -38,9 +38,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_flushall`**|\| +| Function | Required header | +|---|---| +| **`_flushall`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fma-fmaf-fmal.md b/docs/c-runtime-library/reference/fma-fmaf-fmal.md index 4fd8f10e9e3..e356faa9bb8 100644 --- a/docs/c-runtime-library/reference/fma-fmaf-fmal.md +++ b/docs/c-runtime-library/reference/fma-fmaf-fmal.md @@ -67,14 +67,14 @@ Returns `(x * y) + z`. The return value is then rounded using the current roundi Otherwise, may return one of the following values: -|Issue|Return| -|-----------|------------| -|*`x`* = INFINITY, *`y`* = 0 or

*`x`* = 0, *`y`* = INFINITY|NaN| -|*`x`* or *`y`* = exact ± INFINITY, *`z`* = INFINITY with the opposite sign|NaN| -|*`x`* or *`y`* = NaN|NaN| -|not (*`x`* = 0, *`y`*= indefinite) and *`z`* = NaN

not (*`x`*=indefinite, *`y`*=0) and *`z`* = NaN|NaN| -|Overflow range error|±HUGE_VAL, ±HUGE_VALF, or ±HUGE_VALL| -|Underflow range error|correct value, after rounding.| +| Issue | Return | +|---|---| +| *`x`* = INFINITY, *`y`* = 0 or

*`x`* = 0, *`y`* = INFINITY | NaN | +| *`x`* or *`y`* = exact ± INFINITY, *`z`* = INFINITY with the opposite sign | NaN | +| *`x`* or *`y`* = NaN | NaN | +| not (*`x`* = 0, *`y`*= indefinite) and *`z`* = NaN

not (*`x`*=indefinite, *`y`*=0) and *`z`* = NaN | NaN | +| Overflow range error | ±`HUGE_VAL`, ±`HUGE_VALF`, or ±`HUGE_VALL` | +| Underflow range error | correct value, after rounding. | Errors are reported as specified in [`_matherr`](matherr.md). @@ -90,10 +90,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`fma`**, **`fmaf`**, **`fmal`**|\|\| -|**`fma`** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`fma`**, **`fmaf`**, **`fmal`** | \ | \ | +| **`fma`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fmax-fmaxf-fmaxl.md b/docs/c-runtime-library/reference/fmax-fmaxf-fmaxl.md index 5af4a5a04f7..ccd942f6729 100644 --- a/docs/c-runtime-library/reference/fmax-fmaxf-fmaxl.md +++ b/docs/c-runtime-library/reference/fmax-fmaxf-fmaxl.md @@ -59,11 +59,11 @@ If successful, returns the larger of *`x`* or *`y`*. The value returned is exact Otherwise, may return one of the following values: -|Issue|Return| -|-----------|------------| -|*`x`* = NaN|*`y`*| -|*`y`* = NaN|*`x`*| -|*`x`* and *`y`* = NaN|NaN| +| Issue | Return | +|---|---| +| *`x`* = NaN | *`y`* | +| *`y`* = NaN | *`x`* | +| *`x`* and *`y`* = NaN | NaN | This function doesn't use the errors specified in [`_matherr`](matherr.md). @@ -75,10 +75,10 @@ If you use the \ `fmax()` macro, the type of the argument determines w ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`fmax`**, **`fmaxf`**, **`fmaxl`**|\|\ or \| -|**`fmax`** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`fmax`**, **`fmaxf`**, **`fmaxl`** | \ | \ or \ | +| **`fmax`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fmin-fminf-fminl.md b/docs/c-runtime-library/reference/fmin-fminf-fminl.md index ae2b2378f3f..e1b2093567d 100644 --- a/docs/c-runtime-library/reference/fmin-fminf-fminl.md +++ b/docs/c-runtime-library/reference/fmin-fminf-fminl.md @@ -57,11 +57,11 @@ The second value to compare. If successful, returns the smaller of *`x`* or *`y`*. -|Input|Result| -|-----------|------------| -|*`x`* is NaN|*`y`*| -|*`y`* is NaN|*`x`*| -|*`x`* and *`y`* are NaN|NaN| +| Input | Result | +|---|---| +| *`x`* is NaN | *`y`* | +| *`y`* is NaN | *`x`* | +| *`x`* and *`y`* are NaN | NaN | The function doesn't cause [`_matherr`](matherr.md) to be invoked, cause any floating-point exceptions, or change the value of `errno`. @@ -73,10 +73,10 @@ If you use the \ `fmin()` macro, the type of the argument determines w ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`fmin`**, **`fminf`**, **`fminl`**|C: \
C++: \ or \| -|**`fmin`** macro | \ | +| Routine | Required header | +|---|---| +| **`fmin`**, **`fminf`**, **`fminl`** | C: \
C++: \ or \ | +| **`fmin`** macro | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fmod-fmodf.md b/docs/c-runtime-library/reference/fmod-fmodf.md index ed9fb993f98..ff310672b7e 100644 --- a/docs/c-runtime-library/reference/fmod-fmodf.md +++ b/docs/c-runtime-library/reference/fmod-fmodf.md @@ -61,10 +61,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fmod`**, **`fmodf`**, **`fmodl`**|``| -|**`fmod`** macro | `` | +| Function | Required header | +|---|---| +| **`fmod`**, **`fmodf`**, **`fmodl`** | `` | +| **`fmod`** macro | `` | For more compatibility information, see [Compatibility](../compatibility.md). @@ -93,7 +93,7 @@ The remainder of -10.00 / 3.00 is -1.000000 ## See also [Math and floating-point support](../floating-point-support.md)\ -[`ceil, ceilf, ceill`](ceil-ceilf-ceill.md)\ -[`fabs, fabsf, fabsl`](fabs-fabsf-fabsl.md)\ -[`floor, floorf, floorl`](floor-floorf-floorl.md)\ +[`ceil`, `ceilf`, `ceill`](ceil-ceilf-ceill.md)\ +[`fabs`, `fabsf`, `fabsl`](fabs-fabsf-fabsl.md)\ +[`floor`, `floorf`, `floorl`](floor-floorf-floorl.md)\ [`_CIfmod`](../cifmod.md) diff --git a/docs/c-runtime-library/reference/fopen-wfopen.md b/docs/c-runtime-library/reference/fopen-wfopen.md index 6d6c52da698..45d86a2d39c 100644 --- a/docs/c-runtime-library/reference/fopen-wfopen.md +++ b/docs/c-runtime-library/reference/fopen-wfopen.md @@ -82,7 +82,7 @@ If *`mode`* is **`a, ccs=encoding`** for some `encoding` value, **`fopen`** firs ### Generic-text routine mappings -| TCHAR.H routine | `_UNICODE` & `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | |--|--|--|--| | **`_tfopen`** | **`fopen`** | **`fopen`** | **`_wfopen`** | diff --git a/docs/c-runtime-library/reference/fpclass-fpclassf.md b/docs/c-runtime-library/reference/fpclass-fpclassf.md index 1d7b3e426a0..839f0220bdc 100644 --- a/docs/c-runtime-library/reference/fpclass-fpclassf.md +++ b/docs/c-runtime-library/reference/fpclass-fpclassf.md @@ -34,18 +34,18 @@ The floating-point value to test. The **`_fpclass`** and **`_fpclassf`** functions return an integer value that indicates the floating-point classification of the argument *`x`*. The classification may have one of the following values, defined in ``. -|Value|Description| -|-----------|-----------------| -|`_FPCLASS_SNAN`|Signaling NaN| -|`_FPCLASS_QNAN`|Quiet NaN| -|`_FPCLASS_NINF`|Negative infinity (`-INF`)| -|`_FPCLASS_NN`|Negative normalized non-zero| -|`_FPCLASS_ND`|Negative denormalized| -|`_FPCLASS_NZ`|Negative zero (-0)| -|`_FPCLASS_PZ`|Positive 0 (+0)| -|`_FPCLASS_PD`|Positive denormalized| -|`_FPCLASS_PN`|Positive normalized non-zero| -|`_FPCLASS_PINF`|Positive infinity (`+INF`)| +| Value | Description | +|---|---| +| `_FPCLASS_SNAN` | Signaling NaN | +| `_FPCLASS_QNAN` | Quiet NaN | +| `_FPCLASS_NINF` | Negative infinity (`-INF`) | +| `_FPCLASS_NN` | Negative normalized non-zero | +| `_FPCLASS_ND` | Negative denormalized | +| `_FPCLASS_NZ` | Negative zero (-0) | +| `_FPCLASS_PZ` | Positive 0 (+0) | +| `_FPCLASS_PD` | Positive denormalized | +| `_FPCLASS_PN` | Positive normalized non-zero | +| `_FPCLASS_PINF` | Positive infinity (`+INF`) | ## Remarks @@ -55,9 +55,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fpclass`**, **`_fpclassf`**|``| +| Function | Required header | +|---|---| +| **`_fpclass`**, **`_fpclassf`** | `` | For more compatibility and conformance information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fpclassify.md b/docs/c-runtime-library/reference/fpclassify.md index b43761c408f..94f55eb792b 100644 --- a/docs/c-runtime-library/reference/fpclassify.md +++ b/docs/c-runtime-library/reference/fpclassify.md @@ -42,13 +42,13 @@ The floating-point value to test. **`fpclassify`** returns an integer value that indicates the floating-point class of the argument *`x`*. This table shows the possible values returned by **`fpclassify`**, defined in \. -|Value|Description| -|-----------|-----------------| -|`FP_NAN`|A quiet, signaling, or indeterminate NaN| -|`FP_INFINITE`|A positive or negative infinity| -|`FP_NORMAL`|A positive or negative normalized non-zero value| -|`FP_SUBNORMAL`|A positive or negative denormalized value| -|`FP_ZERO`|A positive or negative zero value| +| Value | Description | +|---|---| +| `FP_NAN` | A quiet, signaling, or indeterminate NaN | +| `FP_INFINITE` | A positive or negative infinity | +| `FP_NORMAL` | A positive or negative normalized non-zero value | +| `FP_SUBNORMAL` | A positive or negative denormalized value | +| `FP_ZERO` | A positive or negative zero value | ## Remarks @@ -56,9 +56,9 @@ In C, **`fpclassify`** is a macro; in C++, **`fpclassify`** is a function overlo ## Requirements -|Function/Macro|Required header (C)|Required header (C++)| -|---------------------|---------------------------|-------------------------------| -|**`fpclassify`**|\|\ or \| +| Function/Macro | Required header (C) | Required header (C++) | +|---|---|---| +| **`fpclassify`** | \ | \ or \ | The **`fpclassify`** macro and **`fpclassify`** functions conform to the ISO C99 and C++11 specifications. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fpieee-flt.md b/docs/c-runtime-library/reference/fpieee-flt.md index e9bf4a0bcf3..a0c5b419e38 100644 --- a/docs/c-runtime-library/reference/fpieee-flt.md +++ b/docs/c-runtime-library/reference/fpieee-flt.md @@ -45,20 +45,20 @@ The **`_fpieee_flt`** function invokes a user-defined trap handler for IEEE floa The `_FPIEEE_RECORD` structure, defined in Fpieee.h, contains information pertaining to an IEEE floating-point exception. This structure is passed to the user-defined trap handler by **`_fpieee_flt`**. -|_FPIEEE_RECORD field|Description| -|----------------------------|-----------------| -|`RoundingMode`
`Precision`|These **`unsigned int`** fields contain information about the floating-point environment at the time the exception occurred.| -|`Operation`|This **`unsigned int`** field indicates the type of operation that caused the trap. If the type is a comparison (`_FpCodeCompare`), you can supply one of the special `_FPIEEE_COMPARE_RESULT` values (as defined in Fpieee.h) in the **Result.Value** field. The conversion type (`_FpCodeConvert`) indicates that the trap occurred during a floating-point conversion operation. You can look at the `Operand1` and `Result` types to determine the type of conversion being attempted.| -|`Operand1`
`Operand2`
`Result`|These `_FPIEEE_VALUE` structures indicate the types and values of the proposed result and operands. Each structure contains these fields:

`OperandValid` - Flag indicating whether the responding value is valid.
`Format` - Data type of the corresponding value. The format type might be returned even if the corresponding value isn't valid.
`Value` - Result or operand data value.| -|`Cause`
`Enable`
`Status`|`_FPIEEE_EXCEPTION_FLAGS` contains a bit field for each type of floating point exception. There's a correspondence between these fields and the arguments used to mask the exceptions supplied to [`_controlfp`](control87-controlfp-control87-2.md). The exact meaning of each bit depends on context:

`Cause` - Each set bit indicates the particular exception that was raised.
`Enable` - Each set bit indicates that the particular exception is currently unmasked.
`Status` - Each set bit indicates that the particular exception is currently pending, which includes exceptions that haven't been raised because they were masked by `_controlfp`.| +| _FPIEEE_RECORD field | Description | +|---|---| +| `RoundingMode`
`Precision` | These **`unsigned int`** fields contain information about the floating-point environment at the time the exception occurred. | +| `Operation` | This **`unsigned int`** field indicates the type of operation that caused the trap. If the type is a comparison (`_FpCodeCompare`), you can supply one of the special `_FPIEEE_COMPARE_RESULT` values (as defined in Fpieee.h) in the **Result.Value** field. The conversion type (`_FpCodeConvert`) indicates that the trap occurred during a floating-point conversion operation. You can look at the `Operand1` and `Result` types to determine the type of conversion being attempted. | +| `Operand1`
`Operand2`
`Result` | These `_FPIEEE_VALUE` structures indicate the types and values of the proposed result and operands. Each structure contains these fields:

`OperandValid` - Flag indicating whether the responding value is valid.
`Format` - Data type of the corresponding value. The format type might be returned even if the corresponding value isn't valid.
`Value` - Result or operand data value. | +| `Cause`
`Enable`
`Status` | `_FPIEEE_EXCEPTION_FLAGS` contains a bit field for each type of floating point exception. There's a correspondence between these fields and the arguments used to mask the exceptions supplied to [`_controlfp`](control87-controlfp-control87-2.md). The exact meaning of each bit depends on context:

`Cause` - Each set bit indicates the particular exception that was raised.
`Enable` - Each set bit indicates that the particular exception is currently unmasked.
`Status` - Each set bit indicates that the particular exception is currently pending, which includes exceptions that haven't been raised because they were masked by `_controlfp`. | Pending exceptions that are disabled are raised when you enable them. These exceptions can result in undefined behavior when using **`_fpieee_flt`** as an exception filter. Always call [`_clearfp`](clear87-clearfp.md) before enabling floating point exceptions. ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fpieee_flt`**|\| +| Function | Required header | +|---|---| +| **`_fpieee_flt`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fpreset.md b/docs/c-runtime-library/reference/fpreset.md index bf51d55fffa..fd9aa995d8d 100644 --- a/docs/c-runtime-library/reference/fpreset.md +++ b/docs/c-runtime-library/reference/fpreset.md @@ -28,9 +28,9 @@ This function is deprecated when compiling with [/clr (Common Language Runtime C ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fpreset`**|\| +| Function | Required header | +|---|---| +| **`_fpreset`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md b/docs/c-runtime-library/reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md index cbc580a1f14..184d2fc5e9e 100644 --- a/docs/c-runtime-library/reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md +++ b/docs/c-runtime-library/reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md @@ -75,19 +75,19 @@ The versions of these functions with the **`_l`** suffix are identical except th ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_ftprintf`**|**`fprintf`**|**`fprintf`**|**`fwprintf`**| -|**`_ftprintf_l`**|**`_fprintf_l`**|**`_fprintf_l`**|**`_fwprintf_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_ftprintf`** | **`fprintf`** | **`fprintf`** | **`fwprintf`** | +| **`_ftprintf_l`** | **`_fprintf_l`** | **`_fprintf_l`** | **`_fwprintf_l`** | For more information, see [Format specification syntax](../format-specification-syntax-printf-and-wprintf-functions.md). ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fprintf`**, **`_fprintf_l`**|``| -|**`fwprintf`**, **`_fwprintf_l`**|`` or ``| +| Function | Required header | +|---|---| +| **`fprintf`**, **`_fprintf_l`** | `` | +| **`fwprintf`**, **`_fwprintf_l`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fprintf-p-fprintf-p-l-fwprintf-p-fwprintf-p-l.md b/docs/c-runtime-library/reference/fprintf-p-fprintf-p-l-fwprintf-p-fwprintf-p-l.md index 440cb9d8cff..877bf4a16d5 100644 --- a/docs/c-runtime-library/reference/fprintf-p-fprintf-p-l-fwprintf-p-fwprintf-p-l.md +++ b/docs/c-runtime-library/reference/fprintf-p-fprintf-p-l-fwprintf-p-fwprintf-p-l.md @@ -75,19 +75,19 @@ Like the non-secure versions (see [`fprintf`, `_fprintf_l`, `fwprintf`, `_fwprin ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_ftprintf_p`|**`_fprintf_p`**|**`_fprintf_p`**|**`_fwprintf_p`**| -|`_ftprintf_p_l`|**`_fprintf_p_l`**|**`_fprintf_p_l`**|**`_fwprintf_p_l`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_ftprintf_p` | **`_fprintf_p`** | **`_fprintf_p`** | **`_fwprintf_p`** | +| `_ftprintf_p_l` | **`_fprintf_p_l`** | **`_fprintf_p_l`** | **`_fwprintf_p_l`** | For more information, see [Format specification syntax](../format-specification-syntax-printf-and-wprintf-functions.md). ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fprintf_p`**, **`_fprintf_p_l`**|\| -|**`_fwprintf_p`**, **`_fwprintf_p_l`**|\ or \| +| Function | Required header | +|---|---| +| **`_fprintf_p`**, **`_fprintf_p_l`** | \ | +| **`_fwprintf_p`**, **`_fwprintf_p_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md b/docs/c-runtime-library/reference/fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md index 9c9b3b4764e..9cdfdff5fcf 100644 --- a/docs/c-runtime-library/reference/fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md +++ b/docs/c-runtime-library/reference/fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md @@ -76,19 +76,19 @@ Like the non-secure versions (see [`fprintf`, `_fprintf_l`, `fwprintf`, `_fwprin ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_ftprintf_s`**|**`fprintf_s`**|**`fprintf_s`**|**`fwprintf_s`**| -|**`_ftprintf_s_l`**|**`_fprintf_s_l`**|**`_fprintf_s_l`**|**`_fwprintf_s_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_ftprintf_s`** | **`fprintf_s`** | **`fprintf_s`** | **`fwprintf_s`** | +| **`_ftprintf_s_l`** | **`_fprintf_s_l`** | **`_fprintf_s_l`** | **`_fwprintf_s_l`** | For more information, see [Format specification syntax](../format-specification-syntax-printf-and-wprintf-functions.md). ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fprintf_s`**, **`_fprintf_s_l`**|``| -|**`fwprintf_s`**, **`_fwprintf_s_l`**|`` or ``| +| Function | Required header | +|---|---| +| **`fprintf_s`**, **`_fprintf_s_l`** | `` | +| **`fwprintf_s`**, **`_fwprintf_s_l`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fputc-fputwc.md b/docs/c-runtime-library/reference/fputc-fputwc.md index 01a029d6192..ce8ca09ddec 100644 --- a/docs/c-runtime-library/reference/fputc-fputwc.md +++ b/docs/c-runtime-library/reference/fputc-fputwc.md @@ -51,25 +51,25 @@ The versions with the `_nolock` suffix are identical except that they aren't pro Routine-specific remarks follow. -|Routine|Remarks| -|-------------|-------------| -|**`fputc`**|Equivalent to `putc`, but implemented only as a function, rather than as a function and a macro.| -|**`fputwc`**|Wide-character version of `fputc`. Writes *`c`* as a multibyte character or a wide character when *`stream`* is opened in text mode or binary mode, respectively.| +| Routine | Remarks | +|---|---| +| **`fputc`** | Equivalent to `putc`, but implemented only as a function, rather than as a function and a macro. | +| **`fputwc`** | Wide-character version of `fputc`. Writes *`c`* as a multibyte character or a wide character when *`stream`* is opened in text mode or binary mode, respectively. | 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). ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_fputtc`|**`fputc`**|**`fputc`**|**`fputwc`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_fputtc` | **`fputc`** | **`fputc`** | **`fputwc`** | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fputc`**|\| -|**`fputwc`**|\ or \| +| Function | Required header | +|---|---| +| **`fputc`** | \ | +| **`fputwc`** | \ or \ | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console—`stdin`, `stdout`, and `stderr`—must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fputc-nolock-fputwc-nolock.md b/docs/c-runtime-library/reference/fputc-nolock-fputwc-nolock.md index ba671181787..3b3c15fb27e 100644 --- a/docs/c-runtime-library/reference/fputc-nolock-fputwc-nolock.md +++ b/docs/c-runtime-library/reference/fputc-nolock-fputwc-nolock.md @@ -49,16 +49,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_fputtc_nolock`|**`_fputc_nolock`**|**`_fputc_nolock`**|**`_fputwc_nolock`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_fputtc_nolock` | **`_fputc_nolock`** | **`_fputc_nolock`** | **`_fputwc_nolock`** | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fputc_nolock`**|\| -|**`_fputwc_nolock`**|\ or \| +| Function | Required header | +|---|---| +| **`_fputc_nolock`** | \ | +| **`_fputwc_nolock`** | \ or \ | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console—`stdin`, `stdout`, and `stderr`—must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fputchar-fputwchar.md b/docs/c-runtime-library/reference/fputchar-fputwchar.md index 98f388668c9..94c25b5dbe5 100644 --- a/docs/c-runtime-library/reference/fputchar-fputwchar.md +++ b/docs/c-runtime-library/reference/fputchar-fputwchar.md @@ -44,16 +44,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_fputtchar`|**`_fputchar`**|**`_fputchar`**|**`_fputwchar`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_fputtchar` | **`_fputchar`** | **`_fputchar`** | **`_fputwchar`** | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fputchar`**|\| -|**`_fputwchar`**|\ or \| +| Function | Required header | +|---|---| +| **`_fputchar`** | \ | +| **`_fputwchar`** | \ or \ | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console—`stdin`, `stdout`, and `stderr`—must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fputs-fputws.md b/docs/c-runtime-library/reference/fputs-fputws.md index 09ad2f7ce91..ef25b956ee8 100644 --- a/docs/c-runtime-library/reference/fputs-fputws.md +++ b/docs/c-runtime-library/reference/fputs-fputws.md @@ -50,16 +50,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_fputts`**|**`fputs`**|**`fputs`**|**`fputws`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_fputts`** | **`fputs`** | **`fputs`** | **`fputws`** | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fputs`**|\| -|**`fputws`**|\ or \| +| Function | Required header | +|---|---| +| **`fputs`** | \ | +| **`fputws`** | \ or \ | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console—**`stdin`**, **`stdout`**, and **`stderr`**—must be redirected before C runtime functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fread-nolock-s2.md b/docs/c-runtime-library/reference/fread-nolock-s2.md index a6760b02b09..998c0bf14f9 100644 --- a/docs/c-runtime-library/reference/fread-nolock-s2.md +++ b/docs/c-runtime-library/reference/fread-nolock-s2.md @@ -54,9 +54,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fread_nolock_s`**|C: \; C++: \ or \| +| Function | Required header | +|---|---| +| **`_fread_nolock_s`** | C: \; C++: \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fread-nolock.md b/docs/c-runtime-library/reference/fread-nolock.md index cacb5d15d3a..09ec6e79872 100644 --- a/docs/c-runtime-library/reference/fread-nolock.md +++ b/docs/c-runtime-library/reference/fread-nolock.md @@ -51,9 +51,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fread_nolock`**|\| +| Function | Required header | +|---|---| +| **`_fread_nolock`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fread-s.md b/docs/c-runtime-library/reference/fread-s.md index fccf0270e75..5b2d8ed9fde 100644 --- a/docs/c-runtime-library/reference/fread-s.md +++ b/docs/c-runtime-library/reference/fread-s.md @@ -57,9 +57,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fread_s`**|``| +| Function | Required header | +|---|---| +| **`fread_s`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fread.md b/docs/c-runtime-library/reference/fread.md index 0d2bb5ba928..98cdabd1937 100644 --- a/docs/c-runtime-library/reference/fread.md +++ b/docs/c-runtime-library/reference/fread.md @@ -57,9 +57,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fread`**|``| +| Function | Required header | +|---|---| +| **`fread`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/free-dbg.md b/docs/c-runtime-library/reference/free-dbg.md index 4ba649f8aa3..c4312512023 100644 --- a/docs/c-runtime-library/reference/free-dbg.md +++ b/docs/c-runtime-library/reference/free-dbg.md @@ -43,9 +43,9 @@ For information about how memory blocks are allocated, initialized, and managed ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_free_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_free_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/free-locale.md b/docs/c-runtime-library/reference/free-locale.md index 506c6386207..d0baa2be7d2 100644 --- a/docs/c-runtime-library/reference/free-locale.md +++ b/docs/c-runtime-library/reference/free-locale.md @@ -37,9 +37,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|`Routine`|Required header| -|---------------|---------------------| -|**`_free_locale`**|\| +| `Routine` | Required header | +|---|---| +| **`_free_locale`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/free.md b/docs/c-runtime-library/reference/free.md index 7fe93d47c30..7103ac606c2 100644 --- a/docs/c-runtime-library/reference/free.md +++ b/docs/c-runtime-library/reference/free.md @@ -44,9 +44,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`free`**|`` and ``| +| Function | Required header | +|---|---| +| **`free`** | `` and `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/freea.md b/docs/c-runtime-library/reference/freea.md index ee64d9637a5..7b383907e51 100644 --- a/docs/c-runtime-library/reference/freea.md +++ b/docs/c-runtime-library/reference/freea.md @@ -47,9 +47,9 @@ A call to **`_freea`** must accompany all calls to `_malloca`. It's also an erro ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_freea`**|\ and \| +| Function | Required header | +|---|---| +| **`_freea`** | \ and \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/freopen-s-wfreopen-s.md b/docs/c-runtime-library/reference/freopen-s-wfreopen-s.md index 0caf40c87d0..a96b8d570f3 100644 --- a/docs/c-runtime-library/reference/freopen-s-wfreopen-s.md +++ b/docs/c-runtime-library/reference/freopen-s-wfreopen-s.md @@ -13,7 +13,7 @@ helpviewer_keywords: ["_tfreopen_s function", "_wfreopen_s function", "file poin Closes the file currently associated with `oldStream` and reassigns `stream` to the file specified by `fileName`. -These versions of [`freopen, _wfreopen`](freopen-wfreopen.md) have security enhancements, as described in [Security features in the CRT](../security-features-in-the-crt.md). +These versions of [`freopen`, `_wfreopen`](freopen-wfreopen.md) have security enhancements, as described in [Security features in the CRT](../security-features-in-the-crt.md). ## Syntax @@ -51,7 +51,7 @@ The stream to reopen. It's flushed and any files associated with it are closed. Zero on success; otherwise an error code. If an error occurs, the original file is closed, and `NULL` is written to *`stream`* unless *`stream`* is also `NULL` -For more information about error codes, see [`errno, _doserrno, _sys_errlist, and _sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). +For more information about error codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). ## Remarks @@ -65,14 +65,14 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tfreopen_s`**|**`freopen_s`**|**`freopen_s`**|**`_wfreopen_s`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tfreopen_s`** | **`freopen_s`** | **`freopen_s`** | **`_wfreopen_s`** | **`freopen_s`** is typically used to redirect the pre-opened files **`stdin`**, **`stdout`**, and **`stderr`** to files specified by the user. The new file associated with *`stream`* is opened with *`mode`*, which is a character string specifying the type of access requested for the file, as follows: -|*`mode`*|Access| -|-|-| +| *`mode`* | Access | +|---|---| | **`"r"`** | Opens for reading. If the file doesn't exist or can't be found, the **`freopen_s`** call fails. | | **`"w"`** | Opens an empty file for writing. If the given file exists, its contents are destroyed. | | **`"a"`** | Opens for writing at the end of the file (appending) without removing the end-of-file (EOF) marker before new data is written to the file. Creates the file if it doesn't exist. | @@ -88,8 +88,8 @@ The **`"a"`** mode doesn't remove the EOF marker before appending to the file. A When the **`"r+"`**, **`"w+"`**, or **`"a+"`** access type is specified, both reading and writing are allowed (the file is said to be open for "update"). However, when you switch between reading and writing, there must be an intervening [`fsetpos`](fsetpos.md), [`fseek`](fseek-fseeki64.md), or [`rewind`](rewind.md) operation. The current position can be specified for the [`fsetpos`](fsetpos.md) or [`fseek`](fseek-fseeki64.md) operation, if you want. In addition to the above values, one of the following characters may be included in the *`mode`* string to specify the translation mode for new lines. -|*`mode`* modifier|Translation mode| -|-|-| +| *`mode`* modifier | Translation mode | +|---|---| | **`t`** | Open in text (translated) mode. | | **`b`** | Open in binary (untranslated) mode; translations involving carriage-return and line feed characters are suppressed. | @@ -101,10 +101,10 @@ For a discussion of text and binary modes, see [Text and binary mode file I/O](. ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`freopen_s`**|``| -|**`_wfreopen_s`**|`` or ``| +| Function | Required header | +|---|---| +| **`freopen_s`** | `` | +| **`_wfreopen_s`** | `` or `` | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, **`stdin`**, **`stdout`**, and **`stderr`**, must be redirected before C run-time functions can use them in UWP apps. @@ -149,10 +149,10 @@ This will go to the file 'freopen.out' ## See also [`Stream I/O`](../stream-i-o.md)\ -[`freopen, _wfreopen`](freopen-wfreopen.md)\ -[`fclose, _fcloseall`](fclose-fcloseall.md)\ -[`_fdopen, _wfdopen`](fdopen-wfdopen.md)\ +[`freopen`, `_wfreopen`](freopen-wfreopen.md)\ +[`fclose`, `_fcloseall`](fclose-fcloseall.md)\ +[`_fdopen`, `_wfdopen`](fdopen-wfdopen.md)\ [`_fileno`](fileno.md)\ -[`fopen, _wfopen`](fopen-wfopen.md)\ -[`_open, _wopen`](open-wopen.md)\ +[`fopen`, `_wfopen`](fopen-wfopen.md)\ +[`_open`, `_wopen`](open-wopen.md)\ [`_setmode`](setmode.md) diff --git a/docs/c-runtime-library/reference/freopen-wfreopen.md b/docs/c-runtime-library/reference/freopen-wfreopen.md index 880e931ac08..d2e7d011247 100644 --- a/docs/c-runtime-library/reference/freopen-wfreopen.md +++ b/docs/c-runtime-library/reference/freopen-wfreopen.md @@ -11,7 +11,7 @@ helpviewer_keywords: ["_wfreopen function", "file pointers [C++], reassigning", --- # `freopen`, `_wfreopen` -Reassigns a file pointer. More secure versions of the functions are available; see [`freopen_s, _wfreopen_s`](freopen-s-wfreopen-s.md). +Reassigns a file pointer. More secure versions of the functions are available; see [`freopen_s`, `_wfreopen_s`](freopen-s-wfreopen-s.md). ## Syntax @@ -47,7 +47,7 @@ For more information on error codes, see [`errno`, `_doserrno`, `_sys_errlist`, ## Remarks -More secure versions of these functions exist, see [`freopen_s, _wfreopen_s`](freopen-s-wfreopen-s.md). +More secure versions of these functions exist, see [`freopen_s`, `_wfreopen_s`](freopen-s-wfreopen-s.md). The **`freopen`** function closes the file currently associated with *`stream`* and reassigns *`stream`* to the file specified by *`path`*. **`_wfreopen`** is a wide-character version of **`_freopen`**; the *`path`* and *`mode`* arguments to **`_wfreopen`** are wide-character strings. **`_wfreopen`** and **`_freopen`** behave identically otherwise. @@ -61,8 +61,8 @@ By default, this function's global state is scoped to the application. To change **`freopen`** is typically used to redirect the pre-opened files **`stdin`**, **`stdout`**, and **`stderr`** to files specified by the user. The new file associated with *`stream`* is opened with *`mode`*, which is a character string specifying the type of access requested for the file, as follows: -|*`mode`*|Access| -|-|-| +| *`mode`* | Access | +|---|---| | **`"r"`** | Opens for reading. If the file doesn't exist or can't be found, the **`freopen`** call fails. | | **`"w"`** | Opens an empty file for writing. If the given file exists, its contents are destroyed. | | **`"a"`** | Opens for writing at the end of the file (appending) without removing the end-of-file (EOF) marker before new data is written to the file. Creates the file if it doesn't exist. | @@ -78,8 +78,8 @@ The **`"a"`** mode doesn't remove the EOF marker before appending to the file. A When the **`"r+"`**, **`"w+"`**, or **`"a+"`** access type is specified, both reading and writing are allowed (the file is said to be open for "update"). However, when you switch between reading and writing, there must be an intervening [`fsetpos`](fsetpos.md), [`fseek`](fseek-fseeki64.md), or [`rewind`](rewind.md) operation. The current position can be specified for the [`fsetpos`](fsetpos.md) or [`fseek`](fseek-fseeki64.md) operation, if you want. In addition to the above values, one of the following characters may be included in the *`mode`* string to specify the translation mode for new lines. -|*`mode`* modifier|Translation mode| -|-|-| +| *`mode`* modifier | Translation mode | +|---|---| | **`t`** | Open in text (translated) mode. | | **`b`** | Open in binary (untranslated) mode; translations involving carriage-return and line feed characters are suppressed. | @@ -91,10 +91,10 @@ For a discussion of text and binary modes, see [Text and binary mode file I/O](. ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`freopen`**|``| -|**`_wfreopen`**|`` or ``| +| Function | Required header | +|---|---| +| **`freopen`** | `` | +| **`_wfreopen`** | `` or `` | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, **`stdin`**, **`stdout`**, and **`stderr`**, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). @@ -136,9 +136,9 @@ This will go to the file 'freopen.out' ## See also [Stream I/O](../stream-i-o.md)\ -[`fclose, _fcloseall`](fclose-fcloseall.md)\ -[`_fdopen, _wfdopen`](fdopen-wfdopen.md)\ +[`fclose`, `_fcloseall`](fclose-fcloseall.md)\ +[`_fdopen`, `_wfdopen`](fdopen-wfdopen.md)\ [`_fileno`](fileno.md)\ -[`fopen, _wfopen`](fopen-wfopen.md)\ -[`_open, _wopen`](open-wopen.md)\ +[`fopen`, `_wfopen`](fopen-wfopen.md)\ +[`_open`, `_wopen`](open-wopen.md)\ [`_setmode`](setmode.md)\ diff --git a/docs/c-runtime-library/reference/frexp.md b/docs/c-runtime-library/reference/frexp.md index fe0165bc8b4..23e08e2fc63 100644 --- a/docs/c-runtime-library/reference/frexp.md +++ b/docs/c-runtime-library/reference/frexp.md @@ -67,10 +67,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`frexp`**, **`frexpf`**, **`frexpl`**|\| -|**`frexp`** macro | \ | +| Function | Required header | +|---|---| +| **`frexp`**, **`frexpf`**, **`frexpl`** | \ | +| **`frexp`** macro | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fscanf-fscanf-l-fwscanf-fwscanf-l.md b/docs/c-runtime-library/reference/fscanf-fscanf-l-fwscanf-fwscanf-l.md index bfa267d3127..29f4769612d 100644 --- a/docs/c-runtime-library/reference/fscanf-fscanf-l-fwscanf-fwscanf-l.md +++ b/docs/c-runtime-library/reference/fscanf-fscanf-l-fwscanf-fwscanf-l.md @@ -70,19 +70,19 @@ The versions of these functions with the **`_l`** suffix are identical except th ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_ftscanf`**|**`fscanf`**|**`fscanf`**|**`fwscanf`**| -|**`_ftscanf_l`**|**`_fscanf_l`**|**`_fscanf_l`**|**`_fwscanf_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_ftscanf`** | **`fscanf`** | **`fscanf`** | **`fwscanf`** | +| **`_ftscanf_l`** | **`_fscanf_l`** | **`_fscanf_l`** | **`_fwscanf_l`** | For more information, see [Format specification fields: `scanf` and `wscanf` functions](../format-specification-fields-scanf-and-wscanf-functions.md). ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fscanf`**, **`_fscanf_l`**|``| -|**`fwscanf`**, **`_fwscanf_l`**|`` or ``| +| Function | Required header | +|---|---| +| **`fscanf`**, **`_fscanf_l`** | `` | +| **`fwscanf`**, **`_fwscanf_l`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fscanf-s-fscanf-s-l-fwscanf-s-fwscanf-s-l.md b/docs/c-runtime-library/reference/fscanf-s-fscanf-s-l-fwscanf-s-fwscanf-s-l.md index c017c5c89ad..79b64e9b002 100644 --- a/docs/c-runtime-library/reference/fscanf-s-fscanf-s-l-fwscanf-s-fwscanf-s-l.md +++ b/docs/c-runtime-library/reference/fscanf-s-fscanf-s-l-fwscanf-s-fwscanf-s-l.md @@ -74,17 +74,17 @@ The versions of these functions that have the **`_l`** suffix are identical exce ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_ftscanf_s`**|**`fscanf_s`**|**`fscanf_s`**|**`fwscanf_s`**| -|**`_ftscanf_s_l`**|**`_fscanf_s_l`**|**`_fscanf_s_l`**|**`_fwscanf_s_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_ftscanf_s`** | **`fscanf_s`** | **`fscanf_s`** | **`fwscanf_s`** | +| **`_ftscanf_s_l`** | **`_fscanf_s_l`** | **`_fscanf_s_l`** | **`_fwscanf_s_l`** | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fscanf_s`**, **`_fscanf_s_l`**|``| -|**`fwscanf_s`**, **`_fwscanf_s_l`**|`` or ``| +| Function | Required header | +|---|---| +| **`fscanf_s`**, **`_fscanf_s_l`** | `` | +| **`fwscanf_s`**, **`_fwscanf_s_l`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fseek-fseeki64.md b/docs/c-runtime-library/reference/fseek-fseeki64.md index b21bdb4027e..4fea189c608 100644 --- a/docs/c-runtime-library/reference/fseek-fseeki64.md +++ b/docs/c-runtime-library/reference/fseek-fseeki64.md @@ -48,8 +48,8 @@ If successful, **`fseek`** and **`_fseeki64`** returns 0. Otherwise, it returns The **`fseek`** and **`_fseeki64`** functions moves the file pointer (if any) associated with *`stream`* to a new location that is *`offset`* bytes from *`origin`*. The next operation on the stream takes place at the new location. On a stream open for update, the next operation can be either a read or a write. The argument *`origin`* must be one of the following constants, defined in `STDIO.H`: -|origin value|Meaning| -|-|-| +| origin value | Meaning | +|---|---| | `SEEK_CUR` | Current position of file pointer. | | `SEEK_END` | End of file. | | `SEEK_SET` | Beginning of file. | @@ -74,10 +74,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fseek`**|``| -|**`_fseeki64`**|``| +| Function | Required header | +|---|---| +| **`fseek`** | `` | +| **`_fseeki64`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fseek-nolock-fseeki64-nolock.md b/docs/c-runtime-library/reference/fseek-nolock-fseeki64-nolock.md index 9c00a31c3c2..d02e3f1a6f2 100644 --- a/docs/c-runtime-library/reference/fseek-nolock-fseeki64-nolock.md +++ b/docs/c-runtime-library/reference/fseek-nolock-fseeki64-nolock.md @@ -52,9 +52,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fseek_nolock`**, **`_fseeki64_nolock`**|\| +| Function | Required header | +|---|---| +| **`_fseek_nolock`**, **`_fseeki64_nolock`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fsetpos.md b/docs/c-runtime-library/reference/fsetpos.md index 75faa7d5ffa..426ff227d47 100644 --- a/docs/c-runtime-library/reference/fsetpos.md +++ b/docs/c-runtime-library/reference/fsetpos.md @@ -45,9 +45,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fsetpos`**|\| +| Function | Required header | +|---|---| +| **`fsetpos`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fsopen-wfsopen.md b/docs/c-runtime-library/reference/fsopen-wfsopen.md index b2d2caf9fea..f4ad05cd347 100644 --- a/docs/c-runtime-library/reference/fsopen-wfsopen.md +++ b/docs/c-runtime-library/reference/fsopen-wfsopen.md @@ -52,54 +52,54 @@ The **`_fsopen`** function opens the file specified by *`filename`* as a stream The character string *`mode`* specifies the type of access requested for the file, as shown in the following table. -|Term|Definition| -|----------|----------------| -|**"`r`"**|Opens for reading. If the file doesn't exist or can't be found, the **`_fsopen`** call fails.| -|**"`w`"**|Opens an empty file for writing. If the given file exists, its contents are destroyed.| -|**"`a`"**|Opens for writing at the end of the file (appending); creates the file first if it doesn't exist.| -|**"`r+`"**|Opens for both reading and writing. (The file must exist.)| -|**"`w+`"**|Opens an empty file for both reading and writing. If the given file exists, its contents are destroyed.| -|**"`a+`"**|Opens for reading and appending; creates the file first if it doesn't exist.| +| Term | Definition | +|---|---| +| **"`r`"** | Opens for reading. If the file doesn't exist or can't be found, the **`_fsopen`** call fails. | +| **"`w`"** | Opens an empty file for writing. If the given file exists, its contents are destroyed. | +| **"`a`"** | Opens for writing at the end of the file (appending); creates the file first if it doesn't exist. | +| **"`r+`"** | Opens for both reading and writing. (The file must exist.) | +| **"`w+`"** | Opens an empty file for both reading and writing. If the given file exists, its contents are destroyed. | +| **"`a+`"** | Opens for reading and appending; creates the file first if it doesn't exist. | Use the **"`w`"** and **"`w+`"** types with care, as they can destroy existing files. When a file is opened with the **"`a`"** or **"`a+`"** access type, all write operations occur at the end of the file. The file pointer can be repositioned using [`fseek`](fseek-fseeki64.md) or [`rewind`](rewind.md), but it's always moved back to the end of the file before any write operation is carried out. Thus, existing data can't be overwritten. When the **"`r+`"**, **"`w+`"**, or **"`a+`"** access type is specified, both reading and writing are allowed (the file is said to be open for update). However, when switching between reading and writing, there must be an intervening [`fsetpos`](fsetpos.md), [`fseek`](fseek-fseeki64.md), or [`rewind`](rewind.md) operation. The current position can be specified for the [`fsetpos`](fsetpos.md) or [`fseek`](fseek-fseeki64.md) operation, if desired. In addition to the above values, one of the following characters can be included in *`mode`* to specify the translation mode for new lines, and for file management. -|Term|Definition| -|----------|----------------| -|**`t`**|Opens a file in text (translated) mode. In this mode, carriage return-line feed (CR-LF) combinations are translated into single line feeds (LF) on input and LF characters are translated to CR-LF combinations on output. Also, CTRL+Z is interpreted as an end-of-file character on input. In files opened for reading or reading/writing, **`_fsopen`** checks for a CTRL+Z at the end of the file and removes it, if possible. It's removed because using [`fseek`](fseek-fseeki64.md) and [`ftell`](ftell-ftelli64.md) to move within a file that ends with a CTRL+Z might cause [`fseek`](fseek-fseeki64.md) to behave improperly near the end of the file.| -|**`b`**|Opens a file in binary (untranslated) mode; the above translations are suppressed.| -|**`S`**|Specifies that caching is optimized for, but not restricted to, sequential access from disk.| -|**`R`**|Specifies that caching is optimized for, but not restricted to, random access from disk.| -|**`T`**|Specifies a file as temporary. If possible, it isn't flushed to disk.| -|**`D`**|Specifies a file as temporary. It's deleted when the last file pointer is closed.| +| Term | Definition | +|---|---| +| **`t`** | Opens a file in text (translated) mode. In this mode, carriage return-line feed (CR-LF) combinations are translated into single line feeds (LF) on input and LF characters are translated to CR-LF combinations on output. Also, CTRL+Z is interpreted as an end-of-file character on input. In files opened for reading or reading/writing, **`_fsopen`** checks for a CTRL+Z at the end of the file and removes it, if possible. It's removed because using [`fseek`](fseek-fseeki64.md) and [`ftell`](ftell-ftelli64.md) to move within a file that ends with a CTRL+Z might cause [`fseek`](fseek-fseeki64.md) to behave improperly near the end of the file. | +| **`b`** | Opens a file in binary (untranslated) mode; the above translations are suppressed. | +| **`S`** | Specifies that caching is optimized for, but not restricted to, sequential access from disk. | +| **`R`** | Specifies that caching is optimized for, but not restricted to, random access from disk. | +| **`T`** | Specifies a file as temporary. If possible, it isn't flushed to disk. | +| **`D`** | Specifies a file as temporary. It's deleted when the last file pointer is closed. | If **`t`** or **`b`** isn't given in *`mode`*, the translation mode is defined by the default-mode variable **`_fmode`**. If **`t`** or **`b`** is prefixed to the argument, the function fails and returns `NULL`. For a discussion of text and binary modes, see [Text and binary mode file I/O](../text-and-binary-mode-file-i-o.md). The argument *`shflag`* is a constant expression consisting of one of the following manifest constants, defined in `Share.h`. -|Term|Definition| -|----------|----------------| -|`_SH_COMPAT`|Sets Compatibility mode for 16-bit applications.| -|`_SH_DENYNO`|Permits read and write access.| -|`_SH_DENYRD`|Denies read access to the file.| -|`_SH_DENYRW`|Denies read and write access to the file.| -|`_SH_DENYWR`|Denies write access to the file.| +| Term | Definition | +|---|---| +| `_SH_COMPAT` | Sets Compatibility mode for 16-bit applications. | +| `_SH_DENYNO` | Permits read and write access. | +| `_SH_DENYRD` | Denies read access to the file. | +| `_SH_DENYRW` | Denies read and write access to the file. | +| `_SH_DENYWR` | Denies write access to the file. | 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). ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_tfsopen`**|**`_fsopen`**|**`_fsopen`**|**`_wfsopen`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tfsopen`** | **`_fsopen`** | **`_fsopen`** | **`_wfsopen`** | ## Requirements -|Function|Required header|Optional headers| -|--------------|---------------------|----------------------| -|**`_fsopen`**|``|``

For manifest constant for *`shflag`* parameter.| -|**`_wfsopen`**|`` or ``|``

For manifest constant for *`shflag`* parameter.| +| Function | Required header | Optional headers | +|---|---|---| +| **`_fsopen`** | `` | ``

For manifest constant for *`shflag`* parameter. | +| **`_wfsopen`** | `` or `` | ``

For manifest constant for *`shflag`* parameter. | ## Example diff --git a/docs/c-runtime-library/reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md b/docs/c-runtime-library/reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md index abe3539a44a..961eaaa776a 100644 --- a/docs/c-runtime-library/reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md +++ b/docs/c-runtime-library/reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md @@ -58,8 +58,8 @@ Returns 0 if the file-status information is obtained. A return value of -1 indic The **`_fstat`** function obtains information about the open file associated with *`fd`* and stores it in the structure pointed to by *`buffer`*. The **`_stat`** structure, defined in `SYS\Stat.h`, contains the following fields. -|Field|Meaning| -|-|-| +| Field | Meaning | +|---|---| | **`st_atime`** | Time of the last file access. | | **`st_ctime`** | Time of the creation of the file. | | **`st_dev`** | If a device, *`fd`*; otherwise 0. | @@ -83,27 +83,27 @@ By default, this function's global state is scoped to the application. To change ### Time type and file length type variations of `_stat` -|Functions|`_USE_32BIT_TIME_T` defined?|Time type|File length type| -|---------------|------------------------------------|---------------|----------------------| -|**`_fstat`**|Not defined|64-bit|32-bit| -|**`_fstat`**|Defined|32-bit|32-bit| -|**`_fstat32`**|Not affected by the macro definition|32-bit|32-bit| -|**`_fstat64`**|Not affected by the macro definition|64-bit|64-bit| -|**`_fstati64`**|Not defined|64-bit|64-bit| -|**`_fstati64`**|Defined|32-bit|64-bit| -|**`_fstat32i64`**|Not affected by the macro definition|32-bit|64-bit| -|**`_fstat64i32`**|Not affected by the macro definition|64-bit|32-bit| +| Functions | `_USE_32BIT_TIME_T` defined? | Time type | File length type | +|---|---|---|---| +| **`_fstat`** | Not defined | 64-bit | 32-bit | +| **`_fstat`** | Defined | 32-bit | 32-bit | +| **`_fstat32`** | Not affected by the macro definition | 32-bit | 32-bit | +| **`_fstat64`** | Not affected by the macro definition | 64-bit | 64-bit | +| **`_fstati64`** | Not defined | 64-bit | 64-bit | +| **`_fstati64`** | Defined | 32-bit | 64-bit | +| **`_fstat32i64`** | Not affected by the macro definition | 32-bit | 64-bit | +| **`_fstat64i32`** | Not affected by the macro definition | 64-bit | 32-bit | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fstat`**|`` and ``| -|**`_fstat32`**|`` and ``| -|**`_fstat64`**|`` and ``| -|**`_fstati64`**|`` and ``| -|**`_fstat32i64`**|`` and ``| -|**`_fstat64i32`**|`` and ``| +| Function | Required header | +|---|---| +| **`_fstat`** | `` and `` | +| **`_fstat32`** | `` and `` | +| **`_fstat64`** | `` and `` | +| **`_fstati64`** | `` and `` | +| **`_fstat32i64`** | `` and `` | +| **`_fstat64i32`** | `` and `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ftell-ftelli64.md b/docs/c-runtime-library/reference/ftell-ftelli64.md index 76e778a9b4c..b718409f612 100644 --- a/docs/c-runtime-library/reference/ftell-ftelli64.md +++ b/docs/c-runtime-library/reference/ftell-ftelli64.md @@ -49,10 +49,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header|Optional headers| -|--------------|---------------------|----------------------| -|**`ftell`**|``|``| -|**`_ftelli64`**|``|``| +| Function | Required header | Optional headers | +|---|---|---| +| **`ftell`** | `` | `` | +| **`_ftelli64`** | `` | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ftell-nolock-ftelli64-nolock.md b/docs/c-runtime-library/reference/ftell-nolock-ftelli64-nolock.md index 8faaf2b2363..a1fa48e03fc 100644 --- a/docs/c-runtime-library/reference/ftell-nolock-ftelli64-nolock.md +++ b/docs/c-runtime-library/reference/ftell-nolock-ftelli64-nolock.md @@ -42,10 +42,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header|Optional header| -|--------------|---------------------|---------------------| -|**`ftell_nolock`**|\|\| -|**`_ftelli64_nolock`**|\|\| +| Function | Required header | Optional header | +|---|---|---| +| **`ftell_nolock`** | \ | \ | +| **`_ftelli64_nolock`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ftime-ftime32-ftime64.md b/docs/c-runtime-library/reference/ftime-ftime32-ftime64.md index 40cc0b856f9..e85f7d3946d 100644 --- a/docs/c-runtime-library/reference/ftime-ftime32-ftime64.md +++ b/docs/c-runtime-library/reference/ftime-ftime32-ftime64.md @@ -31,12 +31,12 @@ Pointer to a `_timeb`, `__timeb32`, or `__timeb64` structure. The **`_ftime`** function gets the current local time and stores it in the structure pointed to by *`timeptr`*. The `_timeb`, `__timeb32`, and `__timeb64` structures are defined in \. They contain four fields, which are listed in the following table. -|Field|Description| -|-|-| -|`dstflag`|Nonzero if daylight savings time is currently in effect for the local time zone. (See [`_tzset`](tzset.md) for an explanation of how daylight savings time is determined.)| -|`millitm`|Fraction of a second in milliseconds.| -|`time`|Time in seconds since midnight (00:00:00), January 1, 1970, coordinated universal time (UTC).| -|`timezone`|Difference in minutes, moving westward, between UTC and local time. The value of `timezone` is set from the value of the global variable `_timezone` (see `_tzset`).| +| Field | Description | +|---|---| +| `dstflag` | Nonzero if daylight savings time is currently in effect for the local time zone. (See [`_tzset`](tzset.md) for an explanation of how daylight savings time is determined.) | +| `millitm` | Fraction of a second in milliseconds. | +| `time` | Time in seconds since midnight (00:00:00), January 1, 1970, coordinated universal time (UTC). | +| `timezone` | Difference in minutes, moving westward, between UTC and local time. The value of `timezone` is set from the value of the global variable `_timezone` (see `_tzset`). | The **`_ftime64`** function, which uses the `__timeb64` structure, allows file-creation dates to be expressed up through 23:59:59, December 31, 3000, UTC; whereas **`_ftime32`** only represents dates through 23:59:59 January 18, 2038, UTC. Midnight, January 1, 1970, is the lower bound of the date range for all these functions. @@ -48,11 +48,11 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_ftime`**|\ and \| -|**`_ftime32`**|\ and \| -|**`_ftime64`**|\ and \| +| Function | Required header | +|---|---| +| **`_ftime`** | \ and \ | +| **`_ftime32`** | \ and \ | +| **`_ftime64`** | \ and \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ftime-s-ftime32-s-ftime64-s.md b/docs/c-runtime-library/reference/ftime-s-ftime32-s-ftime64-s.md index 845b76287d4..3d585662c9a 100644 --- a/docs/c-runtime-library/reference/ftime-s-ftime32-s-ftime64-s.md +++ b/docs/c-runtime-library/reference/ftime-s-ftime32-s-ftime64-s.md @@ -35,12 +35,12 @@ Zero if successful, an error code on failure. If *`timeptr`* is `NULL`, the retu The **`_ftime_s`** function gets the current local time and stores it in the structure pointed to by *`timeptr`*. The `_timeb`, `__timeb32`, and `__timeb64` structures are defined in SYS\Timeb.h. They contain four fields, which are listed in the following table. -|Field|Description| -|-|-| -|`dstflag`|Nonzero if daylight savings time is currently in effect for the local time zone. (See [`_tzset`](tzset.md) for an explanation of how daylight savings time is determined.)| -|`millitm`|Fraction of a second in milliseconds.| -|`time`|Time in seconds since midnight (00:00:00), January 1, 1970, coordinated universal time (UTC).| -|`timezone`|Difference in minutes, moving westward, between UTC and local time. The value of `timezone` is set from the value of the global variable `_timezone` (see `_tzset`).| +| Field | Description | +|---|---| +| `dstflag` | Nonzero if daylight savings time is currently in effect for the local time zone. (See [`_tzset`](tzset.md) for an explanation of how daylight savings time is determined.) | +| `millitm` | Fraction of a second in milliseconds. | +| `time` | Time in seconds since midnight (00:00:00), January 1, 1970, coordinated universal time (UTC). | +| `timezone` | Difference in minutes, moving westward, between UTC and local time. The value of `timezone` is set from the value of the global variable `_timezone` (see `_tzset`). | The **`_ftime64_s`** function, which uses the `__timeb64` structure, allows file-creation dates to be expressed up through 23:59:59, December 31, 3000, UTC; whereas **`_ftime32_s`** only represents dates through 23:59:59 January 18, 2038, UTC. Midnight, January 1, 1970, is the lower bound of the date range for all these functions. @@ -52,11 +52,11 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_ftime_s`**|\ and \| -|**`_ftime32_s`**|\ and \| -|**`_ftime64_s`**|\ and \| +| Function | Required header | +|---|---| +| **`_ftime_s`** | \ and \ | +| **`_ftime32_s`** | \ and \ | +| **`_ftime64_s`** | \ and \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fullpath-dbg-wfullpath-dbg.md b/docs/c-runtime-library/reference/fullpath-dbg-wfullpath-dbg.md index c85e23bad42..40e95fd7f63 100644 --- a/docs/c-runtime-library/reference/fullpath-dbg-wfullpath-dbg.md +++ b/docs/c-runtime-library/reference/fullpath-dbg-wfullpath-dbg.md @@ -67,16 +67,16 @@ You don't need to call these functions explicitly in most cases. Instead, you ca ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tfullpath_dbg`|**`_fullpath_dbg`**|**`_fullpath_dbg`**|**`_wfullpath_dbg`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tfullpath_dbg` | **`_fullpath_dbg`** | **`_fullpath_dbg`** | **`_wfullpath_dbg`** | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fullpath_dbg`**|\| -|**`_wfullpath_dbg`**|\| +| Function | Required header | +|---|---| +| **`_fullpath_dbg`** | \ | +| **`_wfullpath_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fullpath-wfullpath.md b/docs/c-runtime-library/reference/fullpath-wfullpath.md index dffd579a822..603eedb796d 100644 --- a/docs/c-runtime-library/reference/fullpath-wfullpath.md +++ b/docs/c-runtime-library/reference/fullpath-wfullpath.md @@ -67,18 +67,18 @@ This function invokes the invalid parameter handler, as described in [Parameter ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE and _MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_tfullpath`**|**`_fullpath`**|**`_fullpath`**|**`_wfullpath`**| +| `Tchar.h` routine | `_UNICODE and _MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tfullpath`** | **`_fullpath`** | **`_fullpath`** | **`_wfullpath`** | If the *`absPath`* buffer is `NULL`, **`_fullpath`** calls [`malloc`](malloc.md) to allocate a buffer and ignores the *`maxLength`* argument. It's the caller's responsibility to deallocate this buffer (using [`free`](free.md)) as appropriate. If the *`relPath`* argument specifies a disk drive, the current directory of this drive is combined with the path. ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fullpath`**|``| -|**`_wfullpath`**|`` or ``| +| Function | Required header | +|---|---| +| **`_fullpath`** | `` | +| **`_wfullpath`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/futime-futime32-futime64.md b/docs/c-runtime-library/reference/futime-futime32-futime64.md index 4ee03c73ee5..19bdda0f5bb 100644 --- a/docs/c-runtime-library/reference/futime-futime32-futime64.md +++ b/docs/c-runtime-library/reference/futime-futime32-futime64.md @@ -53,11 +53,11 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header|Optional header| -|--------------|---------------------|---------------------| -|**`_futime`**|\|\| -|**`_futime32`**|\|\| -|**`_futime64`**|\|\| +| Function | Required header | Optional header | +|---|---|---| +| **`_futime`** | \ | \ | +| **`_futime32`** | \ | \ | +| **`_futime64`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fwide.md b/docs/c-runtime-library/reference/fwide.md index 0c65c9d1a12..f21511e1069 100644 --- a/docs/c-runtime-library/reference/fwide.md +++ b/docs/c-runtime-library/reference/fwide.md @@ -41,8 +41,8 @@ The current version of this function doesn't conform to the C Standard. ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fwide`**|\| +| Function | Required header | +|---|---| +| **`fwide`** | \ | For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fwrite-nolock.md b/docs/c-runtime-library/reference/fwrite-nolock.md index 4f724bd1c32..040c0fa3931 100644 --- a/docs/c-runtime-library/reference/fwrite-nolock.md +++ b/docs/c-runtime-library/reference/fwrite-nolock.md @@ -51,9 +51,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`_fwrite_nolock`**|\| +| Function | Required header | +|---|---| +| **`_fwrite_nolock`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/fwrite.md b/docs/c-runtime-library/reference/fwrite.md index a3bef86c3b6..bc282b26f25 100644 --- a/docs/c-runtime-library/reference/fwrite.md +++ b/docs/c-runtime-library/reference/fwrite.md @@ -55,9 +55,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`fwrite`**|``| +| Function | Required header | +|---|---| +| **`fwrite`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/gcvt-s.md b/docs/c-runtime-library/reference/gcvt-s.md index 6704123a3ff..21ed61d8863 100644 --- a/docs/c-runtime-library/reference/gcvt-s.md +++ b/docs/c-runtime-library/reference/gcvt-s.md @@ -51,11 +51,11 @@ Zero if successful. If a failure occurs due to an invalid parameter (see the fol ### Error conditions -|*`buffer`*|*`sizeInBytes`*|*`value`*|*`digits`*|Return|Value in *`buffer`*| -|--------------|-------------------|-------------|--------------|------------|-----------------------| -|`NULL`|any|any|any|`EINVAL`|Not modified.| -|Not `NULL` (points to valid memory)|zero|any|any|`EINVAL`|Not modified.| -|Not `NULL` (points to valid memory)|any|any|>= *`sizeInBytes`*|`EINVAL`|Not modified.| +| *`buffer`* | *`sizeInBytes`* | *`value`* | *`digits`* | Return | Value in *`buffer`* | +|---|---|---|---|---|---| +| `NULL` | any | any | any | `EINVAL` | Not modified. | +| Not `NULL` (points to valid memory) | zero | any | any | `EINVAL` | Not modified. | +| Not `NULL` (points to valid memory) | any | any | >= *`sizeInBytes`* | `EINVAL` | Not modified. | **Security Issues** @@ -73,9 +73,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_gcvt_s`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_gcvt_s`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/gcvt.md b/docs/c-runtime-library/reference/gcvt.md index 34d33c93306..afce6bd52b1 100644 --- a/docs/c-runtime-library/reference/gcvt.md +++ b/docs/c-runtime-library/reference/gcvt.md @@ -51,9 +51,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_gcvt`**|\| +| Routine | Required header | +|---|---| +| **`_gcvt`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-current-locale.md b/docs/c-runtime-library/reference/get-current-locale.md index 46555231fb6..d2a771773bf 100644 --- a/docs/c-runtime-library/reference/get-current-locale.md +++ b/docs/c-runtime-library/reference/get-current-locale.md @@ -32,9 +32,9 @@ The previous name of this function, **`__get_current_locale`** (with two leading ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_get_current_locale`**|\| +| Routine | Required header | +|---|---| +| **`_get_current_locale`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-daylight.md b/docs/c-runtime-library/reference/get-daylight.md index a151f481e83..06aa8f72d3f 100644 --- a/docs/c-runtime-library/reference/get-daylight.md +++ b/docs/c-runtime-library/reference/get-daylight.md @@ -41,9 +41,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_get_daylight`**|\| +| Routine | Required header | +|---|---| +| **`_get_daylight`** | \ | For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-doserrno.md b/docs/c-runtime-library/reference/get-doserrno.md index 65f39d4bf8c..0a00fb3aa30 100644 --- a/docs/c-runtime-library/reference/get-doserrno.md +++ b/docs/c-runtime-library/reference/get-doserrno.md @@ -43,9 +43,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_get_doserrno`**|\, \ (C++)|\, \ (C++)| +| Routine | Required header | Optional header | +|---|---|---| +| **`_get_doserrno`** | \, \ (C++) | \, \ (C++) | **`_get_doserrno`** is a Microsoft extension. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-dstbias.md b/docs/c-runtime-library/reference/get-dstbias.md index 39f88eb0ff0..b7930545586 100644 --- a/docs/c-runtime-library/reference/get-dstbias.md +++ b/docs/c-runtime-library/reference/get-dstbias.md @@ -40,9 +40,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_get_dstbias`**|``| +| Routine | Required header | +|---|---| +| **`_get_dstbias`** | `` | For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-errno.md b/docs/c-runtime-library/reference/get-errno.md index 1dd02217962..2419e12ebfa 100644 --- a/docs/c-runtime-library/reference/get-errno.md +++ b/docs/c-runtime-library/reference/get-errno.md @@ -65,9 +65,9 @@ fyi, ENOENT = 2 ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_get_errno`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_get_errno`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-fma3-enable-set-fma3-enable.md b/docs/c-runtime-library/reference/get-fma3-enable-set-fma3-enable.md index b3f3e7bd113..13cf4ff6ab1 100644 --- a/docs/c-runtime-library/reference/get-fma3-enable-set-fma3-enable.md +++ b/docs/c-runtime-library/reference/get-fma3-enable-set-fma3-enable.md @@ -40,9 +40,9 @@ The FMA3 implementations use different algorithms. Slight differences in the res The **`_set_FMA3_enable`** and **`_get_FMA3_enable`** functions are only available in the X64 versions of the CRT. -|Routine|Required header| -|-------------|---------------------| -|**`_set_FMA3_enable`**, **`_get_FMA3_enable`**| C: \
C++: \ or \| +| Routine | Required header | +|---|---| +| **`_set_FMA3_enable`**, **`_get_FMA3_enable`** | C: \
C++: \ or \ | The **`_set_FMA3_enable`** and **`_get_FMA3_enable`** functions are Microsoft-specific. For compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-fmode.md b/docs/c-runtime-library/reference/get-fmode.md index 49096bf1b91..f1e1b9e7c74 100644 --- a/docs/c-runtime-library/reference/get-fmode.md +++ b/docs/c-runtime-library/reference/get-fmode.md @@ -39,9 +39,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_get_fmode`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_get_fmode`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-heap-handle.md b/docs/c-runtime-library/reference/get-heap-handle.md index b0e01a8825b..7907798affd 100644 --- a/docs/c-runtime-library/reference/get-heap-handle.md +++ b/docs/c-runtime-library/reference/get-heap-handle.md @@ -32,9 +32,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_get_heap_handle`**|\| +| Routine | Required header | +|---|---| +| **`_get_heap_handle`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-invalid-parameter-handler-get-thread-local-invalid-parameter-handler.md b/docs/c-runtime-library/reference/get-invalid-parameter-handler-get-thread-local-invalid-parameter-handler.md index 0618508f99e..c48982d6423 100644 --- a/docs/c-runtime-library/reference/get-invalid-parameter-handler-get-thread-local-invalid-parameter-handler.md +++ b/docs/c-runtime-library/reference/get-invalid-parameter-handler-get-thread-local-invalid-parameter-handler.md @@ -47,9 +47,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_get_invalid_parameter_handler`**, **`_get_thread_local_invalid_parameter_handler`**|C: \

C++: \ or \| +| Routine | Required header | +|---|---| +| **`_get_invalid_parameter_handler`**, **`_get_thread_local_invalid_parameter_handler`** | C: \

C++: \ or \ | The **`_get_invalid_parameter_handler`** and **`_get_thread_local_invalid_parameter_handler`** functions are Microsoft-specific. For compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-osfhandle.md b/docs/c-runtime-library/reference/get-osfhandle.md index 43f15939b3f..ce0b47ed952 100644 --- a/docs/c-runtime-library/reference/get-osfhandle.md +++ b/docs/c-runtime-library/reference/get-osfhandle.md @@ -43,9 +43,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_get_osfhandle`**|``| +| Routine | Required header | +|---|---| +| **`_get_osfhandle`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-pgmptr.md b/docs/c-runtime-library/reference/get-pgmptr.md index 73664cd3122..af8da3fd3de 100644 --- a/docs/c-runtime-library/reference/get-pgmptr.md +++ b/docs/c-runtime-library/reference/get-pgmptr.md @@ -39,9 +39,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_get_pgmptr`**|\| +| Routine | Required header | +|---|---| +| **`_get_pgmptr`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-printf-count-output.md b/docs/c-runtime-library/reference/get-printf-count-output.md index 2b2e5a7a04b..dfa9d742786 100644 --- a/docs/c-runtime-library/reference/get-printf-count-output.md +++ b/docs/c-runtime-library/reference/get-printf-count-output.md @@ -32,9 +32,9 @@ If **`%n`** isn't supported (the default), any **`%n`** found in the format stri ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_get_printf_count_output`**|\| +| Routine | Required header | +|---|---| +| **`_get_printf_count_output`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-purecall-handler-set-purecall-handler.md b/docs/c-runtime-library/reference/get-purecall-handler-set-purecall-handler.md index c2bcf550368..bd6a5227d7a 100644 --- a/docs/c-runtime-library/reference/get-purecall-handler-set-purecall-handler.md +++ b/docs/c-runtime-library/reference/get-purecall-handler-set-purecall-handler.md @@ -45,9 +45,9 @@ To restore the default behavior, call **`_set_purecall_handler`** by using a **` ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_get_purecall_handler`**, **`_set_purecall_handler`**|\ or \| +| Routine | Required header | +|---|---| +| **`_get_purecall_handler`**, **`_set_purecall_handler`** | \ or \ | For compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-terminate.md b/docs/c-runtime-library/reference/get-terminate.md index 06f46f701d8..913a9b5a641 100644 --- a/docs/c-runtime-library/reference/get-terminate.md +++ b/docs/c-runtime-library/reference/get-terminate.md @@ -30,9 +30,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_get_terminate`**|\| +| Routine | Required header | +|---|---| +| **`_get_terminate`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-timezone.md b/docs/c-runtime-library/reference/get-timezone.md index 6e77af1d97f..9322fb57903 100644 --- a/docs/c-runtime-library/reference/get-timezone.md +++ b/docs/c-runtime-library/reference/get-timezone.md @@ -41,9 +41,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_get_timezone`**|\| +| Routine | Required header | +|---|---| +| **`_get_timezone`** | \ | For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-tzname.md b/docs/c-runtime-library/reference/get-tzname.md index 58742d17871..931a43b560d 100644 --- a/docs/c-runtime-library/reference/get-tzname.md +++ b/docs/c-runtime-library/reference/get-tzname.md @@ -38,11 +38,11 @@ The size of the *`timeZoneName`* character string in bytes. *`index`*\ The *`index`* of one of the two time zone names to retrieve. -|*`index`*|Contents of *`timeZoneName`*|*`timeZoneName`* default value| -|-|-|-| -|0|Time zone name|`"PST"`| -|1|Daylight standard time zone name|`"PDT"`| -|> 1 or < 0|`errno` set to `EINVAL`|not modified| +| *`index`* | Contents of *`timeZoneName`* | *`timeZoneName`* default value | +|---|---|---| +| 0 | Time zone name | `"PST"` | +| 1 | Daylight standard time zone name | `"PDT"` | +| > 1 or < 0 | `errno` set to `EINVAL` | not modified | Unless explicitly updated during runtime, `"PST"` is returned for the standard time zone and `"PDT"` for the daylight standard time zone. For more information, see the [Remarks](#remarks). @@ -56,13 +56,13 @@ If either *`timeZoneName`* is `NULL`, or *`sizeInBytes`* is zero or less than ze ### Error conditions -|*`pReturnValue`*|*`timeZoneName`*|*`sizeInBytes`*|*`index`*|Return value|Contents of *`timeZoneName`*| -|--------------------|--------------------|-------------------|-------------|------------------|--------------------------------| -|size of TZ name|`NULL`|0|0 or 1|0|not modified| -|size of TZ name|any|> 0|0 or 1|0|TZ name| -|not modified|`NULL`|> 0|any|`EINVAL`|not modified| -|not modified|any|zero|any|`EINVAL`|not modified| -|not modified|any|> 0|> 1|`EINVAL`|not modified| +| *`pReturnValue`* | *`timeZoneName`* | *`sizeInBytes`* | *`index`* | Return value | Contents of *`timeZoneName`* | +|---|---|---|---|---|---| +| size of TZ name | `NULL` | 0 | 0 or 1 | 0 | not modified | +| size of TZ name | any | > 0 | 0 or 1 | 0 | TZ name | +| not modified | `NULL` | > 0 | any | `EINVAL` | not modified | +| not modified | any | zero | any | `EINVAL` | not modified | +| not modified | any | > 0 | > 1 | `EINVAL` | not modified | ## Remarks @@ -133,9 +133,9 @@ The current Daylight standard time zone name is Pacific Daylight Time. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`_get_tzname`|``| +| Routine | Required header | +|---|---| +| `_get_tzname` | `` | For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-unexpected.md b/docs/c-runtime-library/reference/get-unexpected.md index 0b2d3861a52..a69899156c4 100644 --- a/docs/c-runtime-library/reference/get-unexpected.md +++ b/docs/c-runtime-library/reference/get-unexpected.md @@ -26,9 +26,9 @@ Returns a pointer to the function registered by [`set_unexpected`](set-unexpecte ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_get_unexpected`**|\| +| Routine | Required header | +|---|---| +| **`_get_unexpected`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/get-wpgmptr.md b/docs/c-runtime-library/reference/get-wpgmptr.md index 33ef9ffe44b..16ff4c2809e 100644 --- a/docs/c-runtime-library/reference/get-wpgmptr.md +++ b/docs/c-runtime-library/reference/get-wpgmptr.md @@ -39,9 +39,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_get_wpgmptr`**|\| +| Routine | Required header | +|---|---| +| **`_get_wpgmptr`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getc-getwc.md b/docs/c-runtime-library/reference/getc-getwc.md index 8f263439fcf..264d25c4c10 100644 --- a/docs/c-runtime-library/reference/getc-getwc.md +++ b/docs/c-runtime-library/reference/getc-getwc.md @@ -44,25 +44,25 @@ These functions lock the calling thread and are therefore thread-safe. For a non Routine-specific remarks follow. -|Routine|Remarks| -|-------------|-------------| -|**`getc`**|Same as `fgetc`, but implemented as a function and as a macro.| -|**`getwc`**|Wide-character version of **`getc`**. Reads a multibyte character or a wide character according to whether *`stream`* is opened in text mode or binary mode.| +| Routine | Remarks | +|---|---| +| **`getc`** | Same as `fgetc`, but implemented as a function and as a macro. | +| **`getwc`** | Wide-character version of **`getc`**. Reads a multibyte character or a wide character according to whether *`stream`* is opened in text mode or binary mode. | 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). ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_gettc`|**`getc`**|**`getc`**|**`getwc`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_gettc` | **`getc`** | **`getc`** | **`getwc`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`getc`**|\| -|**`getwc`**|\ or \| +| Routine | Required header | +|---|---| +| **`getc`** | \ | +| **`getwc`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getc-nolock-getwc-nolock.md b/docs/c-runtime-library/reference/getc-nolock-getwc-nolock.md index 43152fa2c26..b7be9f9b3bb 100644 --- a/docs/c-runtime-library/reference/getc-nolock-getwc-nolock.md +++ b/docs/c-runtime-library/reference/getc-nolock-getwc-nolock.md @@ -42,16 +42,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_gettc_nolock`|**`getc_nolock`**|**`getc_nolock`**|**`getwc_nolock`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_gettc_nolock` | **`getc_nolock`** | **`getc_nolock`** | **`getwc_nolock`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`getc_nolock`**|\| -|**`getwc_nolock`**|\ or \| +| Routine | Required header | +|---|---| +| **`getc_nolock`** | \ | +| **`getwc_nolock`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getch-getwch.md b/docs/c-runtime-library/reference/getch-getwch.md index 305d8d3209e..6ee68fe8138 100644 --- a/docs/c-runtime-library/reference/getch-getwch.md +++ b/docs/c-runtime-library/reference/getch-getwch.md @@ -37,16 +37,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_gettch`**|**`_getch`**|**`_getch`**|**`_getwch`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_gettch`** | **`_getch`** | **`_getch`** | **`_getwch`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getch`**|``| -|**`_getwch`**|`` or ``| +| Routine | Required header | +|---|---| +| **`_getch`** | `` | +| **`_getwch`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getch-nolock-getwch-nolock.md b/docs/c-runtime-library/reference/getch-nolock-getwch-nolock.md index dff0950a800..4f862938e32 100644 --- a/docs/c-runtime-library/reference/getch-nolock-getwch-nolock.md +++ b/docs/c-runtime-library/reference/getch-nolock-getwch-nolock.md @@ -36,16 +36,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_gettch_nolock`|**`_getch_nolock`**|**`_getch_nolock`**|**`_getwch_nolock`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_gettch_nolock` | **`_getch_nolock`** | **`_getch_nolock`** | **`_getwch_nolock`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getch_nolock`**|\| -|**`_getwch_nolock`**|\ or \| +| Routine | Required header | +|---|---| +| **`_getch_nolock`** | \ | +| **`_getwch_nolock`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getchar-getwchar.md b/docs/c-runtime-library/reference/getchar-getwchar.md index 4bbd7fd77d8..93b2c8bd894 100644 --- a/docs/c-runtime-library/reference/getchar-getwchar.md +++ b/docs/c-runtime-library/reference/getchar-getwchar.md @@ -36,16 +36,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_gettchar`|**`getchar`**|**`getchar`**|**`getwchar`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_gettchar` | **`getchar`** | **`getchar`** | **`getwchar`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`getchar`**|``| -|**`getwchar`**|`` or ``| +| Routine | Required header | +|---|---| +| **`getchar`** | `` | +| **`getwchar`** | `` or `` | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, **`stdin`**, **`stdout`**, and **`stderr`**, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getchar-nolock-getwchar-nolock.md b/docs/c-runtime-library/reference/getchar-nolock-getwchar-nolock.md index a055f9d40f8..aaf8bcf23a5 100644 --- a/docs/c-runtime-library/reference/getchar-nolock-getwchar-nolock.md +++ b/docs/c-runtime-library/reference/getchar-nolock-getwchar-nolock.md @@ -31,16 +31,16 @@ See [`getchar`, `getwchar`](getchar-getwchar.md). ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_gettchar_nolock`|**`_getchar_nolock`**|**`_getchar_nolock`**|**`_getwchar_nolock`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_gettchar_nolock` | **`_getchar_nolock`** | **`_getchar_nolock`** | **`_getwchar_nolock`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getchar_nolock`**|\| -|**`_getwchar_nolock`**|\ or \| +| Routine | Required header | +|---|---| +| **`_getchar_nolock`** | \ | +| **`_getwchar_nolock`** | \ or \ | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getche-getwche.md b/docs/c-runtime-library/reference/getche-getwche.md index 8cf704d3542..992f90e0424 100644 --- a/docs/c-runtime-library/reference/getche-getwche.md +++ b/docs/c-runtime-library/reference/getche-getwche.md @@ -38,16 +38,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_gettche`|**`_getche`**|**`_getche`**|**`_getwche`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_gettche` | **`_getche`** | **`_getche`** | **`_getwche`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getche`**|\| -|**`_getwche`**|\ or \| +| Routine | Required header | +|---|---| +| **`_getche`** | \ | +| **`_getwche`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getche-nolock-getwche-nolock.md b/docs/c-runtime-library/reference/getche-nolock-getwche-nolock.md index 3e0b90c28e7..2f3adeef107 100644 --- a/docs/c-runtime-library/reference/getche-nolock-getwche-nolock.md +++ b/docs/c-runtime-library/reference/getche-nolock-getwche-nolock.md @@ -36,16 +36,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_gettche_nolock`|**`_getche_nolock`**|**`_getch_nolock`**|**`_getwche_nolock`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_gettche_nolock` | **`_getche_nolock`** | **`_getch_nolock`** | **`_getwche_nolock`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getche_nolock`**|\| -|**`_getwche_nolock`**|\ or \| +| Routine | Required header | +|---|---| +| **`_getche_nolock`** | \ | +| **`_getwche_nolock`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getcwd-dbg-wgetcwd-dbg.md b/docs/c-runtime-library/reference/getcwd-dbg-wgetcwd-dbg.md index 6c9914cf50d..d156f0fd4a4 100644 --- a/docs/c-runtime-library/reference/getcwd-dbg-wgetcwd-dbg.md +++ b/docs/c-runtime-library/reference/getcwd-dbg-wgetcwd-dbg.md @@ -64,16 +64,16 @@ You don't need to call these functions explicitly in most cases. Instead, you ca ## Generic-text routine mapping -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tgetcwd_dbg`|**`_getcwd_dbg`**|**`_getcwd_dbg`**|**`_wgetcwd_dbg`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tgetcwd_dbg` | **`_getcwd_dbg`** | **`_getcwd_dbg`** | **`_wgetcwd_dbg`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getcwd_dbg`**|\| -|**`_wgetcwd_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_getcwd_dbg`** | \ | +| **`_wgetcwd_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getcwd-wgetcwd.md b/docs/c-runtime-library/reference/getcwd-wgetcwd.md index 17d387d392b..5ab2048a8fc 100644 --- a/docs/c-runtime-library/reference/getcwd-wgetcwd.md +++ b/docs/c-runtime-library/reference/getcwd-wgetcwd.md @@ -55,16 +55,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_tgetcwd`**|**`_getcwd`**|**`_getcwd`**|**`_wgetcwd`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tgetcwd`** | **`_getcwd`** | **`_getcwd`** | **`_wgetcwd`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getcwd`**|``| -|**`_wgetcwd`**|`` or ``| +| Routine | Required header | +|---|---| +| **`_getcwd`** | `` | +| **`_wgetcwd`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getdcwd-dbg-wgetdcwd-dbg.md b/docs/c-runtime-library/reference/getdcwd-dbg-wgetdcwd-dbg.md index 986fb3b96b8..1ecae36fedd 100644 --- a/docs/c-runtime-library/reference/getdcwd-dbg-wgetdcwd-dbg.md +++ b/docs/c-runtime-library/reference/getdcwd-dbg-wgetdcwd-dbg.md @@ -67,16 +67,16 @@ You don't need to call these functions explicitly in most cases. Instead, you ca ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_tgetdcwd_dbg`**|**`_getdcwd_dbg`**|**`_getdcwd_dbg`**|**`_wgetdcwd_dbg`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tgetdcwd_dbg`** | **`_getdcwd_dbg`** | **`_getdcwd_dbg`** | **`_wgetdcwd_dbg`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getdcwd_dbg`**|\| -|**`_wgetdcwd_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_getdcwd_dbg`** | \ | +| **`_wgetdcwd_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getdcwd-nolock-wgetdcwd-nolock.md b/docs/c-runtime-library/reference/getdcwd-nolock-wgetdcwd-nolock.md index e3ff76b5df5..1ee8358edb0 100644 --- a/docs/c-runtime-library/reference/getdcwd-nolock-wgetdcwd-nolock.md +++ b/docs/c-runtime-library/reference/getdcwd-nolock-wgetdcwd-nolock.md @@ -53,16 +53,16 @@ See [`_getdcwd`, `_wgetdcwd`](getdcwd-wgetdcwd.md). ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_tgetdcwd_nolock`**|**`_getdcwd_nolock`**|**`_getdcwd_nolock`**|**`_wgetdcwd_nolock`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tgetdcwd_nolock`** | **`_getdcwd_nolock`** | **`_getdcwd_nolock`** | **`_wgetdcwd_nolock`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getdcwd_nolock`**|\| -|**`_wgetdcwd_nolock`**|\ or \| +| Routine | Required header | +|---|---| +| **`_getdcwd_nolock`** | \ | +| **`_wgetdcwd_nolock`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getdcwd-wgetdcwd.md b/docs/c-runtime-library/reference/getdcwd-wgetdcwd.md index 5ce5846696c..009fad783e3 100644 --- a/docs/c-runtime-library/reference/getdcwd-wgetdcwd.md +++ b/docs/c-runtime-library/reference/getdcwd-wgetdcwd.md @@ -68,16 +68,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tgetdcwd`|**`_getdcwd`**|**`_getdcwd`**|**`_wgetdcwd`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tgetdcwd` | **`_getdcwd`** | **`_getdcwd`** | **`_wgetdcwd`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getdcwd`**|\| -|**`_wgetdcwd`**|\ or \| +| Routine | Required header | +|---|---| +| **`_getdcwd`** | \ | +| **`_wgetdcwd`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getdiskfree.md b/docs/c-runtime-library/reference/getdiskfree.md index c6dd6d6f5b5..3ce8b8b1f69 100644 --- a/docs/c-runtime-library/reference/getdiskfree.md +++ b/docs/c-runtime-library/reference/getdiskfree.md @@ -56,9 +56,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getdiskfree`**|``| +| Routine | Required header | +|---|---| +| **`_getdiskfree`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getdrive.md b/docs/c-runtime-library/reference/getdrive.md index c758863bd2b..4f99801a17e 100644 --- a/docs/c-runtime-library/reference/getdrive.md +++ b/docs/c-runtime-library/reference/getdrive.md @@ -33,9 +33,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getdrive`**|\| +| Routine | Required header | +|---|---| +| **`_getdrive`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getdrives.md b/docs/c-runtime-library/reference/getdrives.md index 5b9b55e126a..9c4096d9260 100644 --- a/docs/c-runtime-library/reference/getdrives.md +++ b/docs/c-runtime-library/reference/getdrives.md @@ -33,9 +33,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getdrives`**|\| +| Routine | Required header | +|---|---| +| **`_getdrives`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getenv-s-wgetenv-s.md b/docs/c-runtime-library/reference/getenv-s-wgetenv-s.md index cb9b0390d35..8ef12be1988 100644 --- a/docs/c-runtime-library/reference/getenv-s-wgetenv-s.md +++ b/docs/c-runtime-library/reference/getenv-s-wgetenv-s.md @@ -66,11 +66,11 @@ Zero if successful; otherwise, an error code on failure. ### Error conditions -|*`pReturnValue`*|*`buffer`*|*`numberOfElements`*|*`varname`*|Return Value| -|--------------------|--------------|------------------------|---------------|------------------| -|`NULL`|any|any|any|`EINVAL`| -|any|`NULL`|>0|any|`EINVAL`| -|any|any|any|`NULL`|`EINVAL`| +| *`pReturnValue`* | *`buffer`* | *`numberOfElements`* | *`varname`* | Return Value | +|---|---|---|---|---| +| `NULL` | any | any | any | `EINVAL` | +| any | `NULL` | >0 | any | `EINVAL` | +| any | any | any | `NULL` | `EINVAL` | Any of these error conditions invokes an invalid parameter handler, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, the functions set `errno` to `EINVAL` and return `EINVAL`. @@ -100,18 +100,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tgetenv_s`**|**`getenv_s`**|**`getenv_s`**|**`_wgetenv_s`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tgetenv_s` | **`getenv_s`** | **`getenv_s`** | **`_wgetenv_s`** | To check or change the value of the **`TZ`** environment variable, use **`getenv_s`**, **`_putenv`**, and **`_tzset`**, as required. For more information about **`TZ`**, see [`_tzset`](tzset.md) and [`_daylight`, `_dstbias`, `_timezone`, and `_tzname`](../daylight-dstbias-timezone-and-tzname.md). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`getenv_s`**|``| -|**`_wgetenv_s`**|`` or ``| +| Routine | Required header | +|---|---| +| **`getenv_s`** | `` | +| **`_wgetenv_s`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getenv-wgetenv.md b/docs/c-runtime-library/reference/getenv-wgetenv.md index 5771f2487b7..d2d5ff386d1 100644 --- a/docs/c-runtime-library/reference/getenv-wgetenv.md +++ b/docs/c-runtime-library/reference/getenv-wgetenv.md @@ -62,18 +62,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tgetenv`**|**`getenv`**|**`getenv`**|**`_wgetenv`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tgetenv`** | **`getenv`** | **`getenv`** | **`_wgetenv`** | To check or change the value of the **`TZ`** environment variable, use **`getenv`**, **`_putenv`** and **`_tzset`** as necessary. For more information about **`TZ`**, see [`_tzset`](tzset.md) and [`_daylight`, `timezone`, and `_tzname`](../daylight-dstbias-timezone-and-tzname.md). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`getenv`**|``| -|**`_wgetenv`**|`` or ``| +| Routine | Required header | +|---|---| +| **`getenv`** | `` | +| **`_wgetenv`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getmaxstdio.md b/docs/c-runtime-library/reference/getmaxstdio.md index 79236d75b3c..1be8cfb47ca 100644 --- a/docs/c-runtime-library/reference/getmaxstdio.md +++ b/docs/c-runtime-library/reference/getmaxstdio.md @@ -30,9 +30,9 @@ Use [`_setmaxstdio`](setmaxstdio.md) to configure the number of simultaneously o ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getmaxstdio`**|\| +| Routine | Required header | +|---|---| +| **`_getmaxstdio`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getmbcp.md b/docs/c-runtime-library/reference/getmbcp.md index f2f7c9836dc..09993aa9faf 100644 --- a/docs/c-runtime-library/reference/getmbcp.md +++ b/docs/c-runtime-library/reference/getmbcp.md @@ -30,9 +30,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getmbcp`**|\| +| Routine | Required header | +|---|---| +| **`_getmbcp`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getpid.md b/docs/c-runtime-library/reference/getpid.md index bc7fcdbfe2c..06357dc8d40 100644 --- a/docs/c-runtime-library/reference/getpid.md +++ b/docs/c-runtime-library/reference/getpid.md @@ -32,9 +32,9 @@ The **`_getpid`** function obtains the process ID from the system. The process I ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getpid`**|``| +| Routine | Required header | +|---|---| +| **`_getpid`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/gets-s-getws-s.md b/docs/c-runtime-library/reference/gets-s-getws-s.md index 80fd57fd376..dd730bf63e9 100644 --- a/docs/c-runtime-library/reference/gets-s-getws-s.md +++ b/docs/c-runtime-library/reference/gets-s-getws-s.md @@ -63,16 +63,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_getts_s`**|**`gets_s`**|**`gets_s`**|**`_getws_s`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_getts_s` | **`gets_s`** | **`gets_s`** | **`_getws_s`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`gets_s`**|``| -|**`_getws_s`**|`` or ``| +| Routine | Required header | +|---|---| +| **`gets_s`** | `` | +| **`_getws_s`** | `` or `` | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, **`stdin`**, **`stdout`**, and **`stderr`**, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/getw.md b/docs/c-runtime-library/reference/getw.md index bfa1a0d0fe1..8ee907eb036 100644 --- a/docs/c-runtime-library/reference/getw.md +++ b/docs/c-runtime-library/reference/getw.md @@ -39,9 +39,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_getw`**|\| +| Routine | Required header | +|---|---| +| **`_getw`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/gmtime-gmtime32-gmtime64.md b/docs/c-runtime-library/reference/gmtime-gmtime32-gmtime64.md index 91842ff425c..2763c690464 100644 --- a/docs/c-runtime-library/reference/gmtime-gmtime32-gmtime64.md +++ b/docs/c-runtime-library/reference/gmtime-gmtime32-gmtime64.md @@ -30,17 +30,17 @@ Pointer to the stored time. The time is represented as seconds elapsed since mid A pointer to a structure of type [`tm`](../standard-types.md). The fields of the returned structure hold the evaluated value of the *`sourceTime`* argument in UTC rather than in local time. Each of the structure fields is of type `int`, as follows: -|Field|Description| -|-|-| -|`tm_sec`|Seconds after minute (0 - 59).| -|`tm_min`|Minutes after hour (0 - 59).| -|`tm_hour`|Hours since midnight (0 - 23).| -|`tm_mday`|Day of month (1 - 31).| -|`tm_mon`|Month (0 - 11; January = 0).| -|`tm_year`|Year (current year minus 1900).| -|`tm_wday`|Day of week (0 - 6; Sunday = 0).| -|`tm_yday`|Day of year (0 - 365; January 1 = 0).| -|`tm_isdst`|Always 0 for **`gmtime`**.| +| Field | Description | +|---|---| +| `tm_sec` | Seconds after minute (0 - 59). | +| `tm_min` | Minutes after hour (0 - 59). | +| `tm_hour` | Hours since midnight (0 - 23). | +| `tm_mday` | Day of month (1 - 31). | +| `tm_mon` | Month (0 - 11; January = 0). | +| `tm_year` | Year (current year minus 1900). | +| `tm_wday` | Day of week (0 - 6; Sunday = 0). | +| `tm_yday` | Day of year (0 - 365; January 1 = 0). | +| `tm_isdst` | Always 0 for **`gmtime`**. | Both the 32-bit and 64-bit versions of **`gmtime`**, [`mktime`](mktime-mktime32-mktime64.md), [`mkgmtime`](mkgmtime-mkgmtime32-mkgmtime64.md), and [`localtime`](localtime-localtime32-localtime64.md) all use one common `tm` structure per thread for the conversion. Each call to one of these functions destroys the result of any previous call. If *`sourceTime`* represents a date before midnight, January 1, 1970, **`gmtime`** returns `NULL`. There's no error return. @@ -61,9 +61,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required C header|Required C++ header| -|-------------|---------------------|-| -|**`gmtime`**, **`_gmtime32`**, **`_gmtime64`**|``| `` or ``| +| Routine | Required C header | Required C++ header | +|---|---|---| +| **`gmtime`**, **`_gmtime32`**, **`_gmtime64`** | `` | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/gmtime-s-gmtime32-s-gmtime64-s.md b/docs/c-runtime-library/reference/gmtime-s-gmtime32-s-gmtime64-s.md index 6c47df07b63..4ebe48c07c3 100644 --- a/docs/c-runtime-library/reference/gmtime-s-gmtime32-s-gmtime64-s.md +++ b/docs/c-runtime-library/reference/gmtime-s-gmtime32-s-gmtime64-s.md @@ -44,11 +44,11 @@ Zero if successful. The return value is an error code if there's a failure. Erro ### Error conditions -|*`tmDest`*|*`sourceTime`*|Return|Value in *`tmDest`*| -|-----------|------------|------------|--------------------| -|`NULL`|any|`EINVAL`|Not modified.| -|Not `NULL` (points to valid memory)|`NULL`|`EINVAL`|All fields set to -1.| -|Not `NULL`|< 0|`EINVAL`|All fields set to -1.| +| *`tmDest`* | *`sourceTime`* | Return | Value in *`tmDest`* | +|---|---|---|---| +| `NULL` | any | `EINVAL` | Not modified. | +| Not `NULL` (points to valid memory) | `NULL` | `EINVAL` | All fields set to -1. | +| Not `NULL` | < 0 | `EINVAL` | All fields set to -1. | The first two error conditions invoke the invalid parameter handler, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions set `errno` to `EINVAL` and return `EINVAL`. @@ -61,17 +61,17 @@ The **`_gmtime32_s`** function breaks down the *`sourceTime`* value and stores i Each of the structure fields is of type **`int`**, as shown in the following table. -|Field|Description| -|-|-| -|**`tm_sec`**|Seconds after minute (0 - 59).| -|**`tm_min`**|Minutes after hour (0 - 59).| -|**`tm_hour`**|Hours since midnight (0 - 23).| -|**`tm_mday`**|Day of month (1 - 31).| -|**`tm_mon`**|Month (0 - 11; January = 0).| -|**`tm_year`**|Year (current year minus 1900).| -|**`tm_wday`**|Day of week (0 - 6; Sunday = 0).| -|**`tm_yday`**|Day of year (0 - 365; January 1 = 0).| -|**`tm_isdst`**|Always 0 for **`gmtime_s`**.| +| Field | Description | +|---|---| +| **`tm_sec`** | Seconds after minute (0 - 59). | +| **`tm_min`** | Minutes after hour (0 - 59). | +| **`tm_hour`** | Hours since midnight (0 - 23). | +| **`tm_mday`** | Day of month (1 - 31). | +| **`tm_mon`** | Month (0 - 11; January = 0). | +| **`tm_year`** | Year (current year minus 1900). | +| **`tm_wday`** | Day of week (0 - 6; Sunday = 0). | +| **`tm_yday`** | Day of year (0 - 365; January 1 = 0). | +| **`tm_isdst`** | Always 0 for **`gmtime_s`**. | **`_gmtime64_s`**, which uses the **`__time64_t`** structure, allows dates to be expressed up through 23:59:59, December 31, 3000, UTC; whereas **`gmtime32_s`** only represent dates through 23:59:59 January 18, 2038, UTC. Midnight, January 1, 1970, is the lower bound of the date range for both these functions. @@ -81,9 +81,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required C header|Required C++ header| -|-------------|---------------------|-| -|**`gmtime_s`**, **`_gmtime32_s`**, **`_gmtime64_s`**|``|`` or ``| +| Routine | Required C header | Required C++ header | +|---|---|---| +| **`gmtime_s`**, **`_gmtime32_s`**, **`_gmtime64_s`** | `` | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/heapchk.md b/docs/c-runtime-library/reference/heapchk.md index fb487381911..890c193e7a4 100644 --- a/docs/c-runtime-library/reference/heapchk.md +++ b/docs/c-runtime-library/reference/heapchk.md @@ -24,8 +24,8 @@ int _heapchk( void ); **`_heapchk`** returns one of the following integer manifest constants defined in Malloc.h. -|Return value|Condition| -|-|-| +| Return value | Condition | +|---|---| | `_HEAPBADBEGIN` | Initial header information is bad or can't be found. | | `_HEAPBADNODE` | Bad node has been found or heap is damaged. | | `_HEAPBADPTR` | Pointer into heap isn't valid. | @@ -42,9 +42,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_heapchk`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_heapchk`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/heapmin.md b/docs/c-runtime-library/reference/heapmin.md index a9d3cb38b39..37c689f89ca 100644 --- a/docs/c-runtime-library/reference/heapmin.md +++ b/docs/c-runtime-library/reference/heapmin.md @@ -34,9 +34,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_heapmin`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_heapmin`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/heapwalk.md b/docs/c-runtime-library/reference/heapwalk.md index 3f5d618ffca..451669de78c 100644 --- a/docs/c-runtime-library/reference/heapwalk.md +++ b/docs/c-runtime-library/reference/heapwalk.md @@ -32,14 +32,14 @@ Buffer to contain heap information. **`_heapwalk`** returns one of the following integer manifest constants defined in Malloc.h. -|Return value|Meaning| -|-|-| -|`_HEAPBADBEGIN`| Initial header information invalid or not found.| -|`_HEAPBADNODE`| Heap damaged or bad node found.| -|`_HEAPBADPTR`| The `_pentry` field of the `_HEAPINFO` structure doesn't contain a valid pointer into the heap or *`entryinfo`* is a null pointer.| -|`_HEAPEND`| End of the heap reached successfully.| -|`_HEAPEMPTY`| Heap not initialized.| -|`_HEAPOK`| No errors so far; *`entryinfo`* is updated with information about the next heap entry.| +| Return value | Meaning | +|---|---| +| `_HEAPBADBEGIN` | Initial header information invalid or not found. | +| `_HEAPBADNODE` | Heap damaged or bad node found. | +| `_HEAPBADPTR` | The `_pentry` field of the `_HEAPINFO` structure doesn't contain a valid pointer into the heap or *`entryinfo`* is a null pointer. | +| `_HEAPEND` | End of the heap reached successfully. | +| `_HEAPEMPTY` | Heap not initialized. | +| `_HEAPOK` | No errors so far; *`entryinfo`* is updated with information about the next heap entry. | In addition, if an error occurs, **`_heapwalk`** sets `errno` to `ENOSYS`. @@ -47,11 +47,11 @@ In addition, if an error occurs, **`_heapwalk`** sets `errno` to `ENOSYS`. The **`_heapwalk`** function helps debug heap-related problems in programs. The function walks through the heap, traversing one entry per call, and returns a pointer to a structure of type `_HEAPINFO` that contains information about the next heap entry. The `_HEAPINFO` type, defined in Malloc.h, contains the following elements. -|Field|Meaning| -|-|-| -|`int *_pentry`|Heap entry pointer.| -|`size_t _size`|Size of the heap entry.| -|`int _useflag`|Flag that indicates whether the heap entry is in use.| +| Field | Meaning | +|---|---| +| `int *_pentry` | Heap entry pointer. | +| `size_t _size` | Size of the heap entry. | +| `int _useflag` | Flag that indicates whether the heap entry is in use. | A call to **`_heapwalk`** that returns `_HEAPOK` stores the size of the entry in the `_size` field and sets the `_useflag` field to either `_FREEENTRY` or `_USEDENTRY` (both are constants defined in Malloc.h). To obtain this information about the first entry in the heap, pass **`_heapwalk`** a pointer to a `_HEAPINFO` structure whose `_pentry` member is `NULL`. If the operating system doesn't support **`_heapwalk`**, the function returns `_HEAPEND` and sets `errno` to `ENOSYS`. @@ -59,9 +59,9 @@ This function validates its parameter. If *`entryinfo`* is a null pointer, the i ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_heapwalk`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_heapwalk`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/hypot-hypotf-hypotl-hypot-hypotf-hypotl.md b/docs/c-runtime-library/reference/hypot-hypotf-hypotl-hypot-hypotf-hypotl.md index 571a5c4270d..2735780fa84 100644 --- a/docs/c-runtime-library/reference/hypot-hypotf-hypotl-hypot-hypotf-hypotl.md +++ b/docs/c-runtime-library/reference/hypot-hypotf-hypotl-hypot-hypotf-hypotl.md @@ -67,10 +67,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`hypot`**, **`hypotf`**, **`hypotl`**, **`_hypot`**, **`_hypotf`**, **`_hypotl`**|\| -|**`hypot`** macro | \ | +| Routine | Required header | +|---|---| +| **`hypot`**, **`hypotf`**, **`hypotl`**, **`_hypot`**, **`_hypotf`**, **`_hypotl`** | \ | +| **`hypot`** macro | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ilogb-ilogbf-ilogbl2.md b/docs/c-runtime-library/reference/ilogb-ilogbf-ilogbl2.md index ee132bbca83..b75d22d40bb 100644 --- a/docs/c-runtime-library/reference/ilogb-ilogbf-ilogbl2.md +++ b/docs/c-runtime-library/reference/ilogb-ilogbf-ilogbl2.md @@ -51,10 +51,10 @@ If successful, these functions return the base-2 exponent of *`x`* as a **`signe Otherwise, the functions return one of the following values, defined in \: -|Input|Result| -|-----------|------------| -|±0|`FP_ILOGB0`| -|± INF, ± NAN, IND|`FP_ILOGBNAN`| +| Input | Result | +|---|---| +| ±0 | `FP_ILOGB0` | +| ± INF, ± NAN, IND | `FP_ILOGBNAN` | Errors are reported as specified in [`_matherr`](matherr.md). @@ -68,10 +68,10 @@ Calling this function is similar to calling the equivalent `logb` function, then ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`ilogb`**, **`ilogbf`**, **`ilogbl`**|\|\| -|**`ilogb`** macro | \ || +| Routine | C header | C++ header | +|---|---|---| +| **`ilogb`**, **`ilogbf`**, **`ilogbl`** | \ | \ | +| **`ilogb`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/imaxabs.md b/docs/c-runtime-library/reference/imaxabs.md index 2aa92d08e72..ee9fa1fc50f 100644 --- a/docs/c-runtime-library/reference/imaxabs.md +++ b/docs/c-runtime-library/reference/imaxabs.md @@ -36,9 +36,9 @@ The **`imaxabs`** function returns the absolute value of the argument. There's n ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`imaxabs`**|\| +| Routine | Required header | +|---|---| +| **`imaxabs`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/imaxdiv.md b/docs/c-runtime-library/reference/imaxdiv.md index 52ddde6a3ab..23e748400d7 100644 --- a/docs/c-runtime-library/reference/imaxdiv.md +++ b/docs/c-runtime-library/reference/imaxdiv.md @@ -41,9 +41,9 @@ The **`imaxdiv`** function divides *`numer`* by *`denom`* and thereby computes t ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`imaxdiv`**|\| +| Routine | Required header | +|---|---| +| **`imaxdiv`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/invalid-parameter-functions.md b/docs/c-runtime-library/reference/invalid-parameter-functions.md index dc622c64725..fc6b6bb5d0c 100644 --- a/docs/c-runtime-library/reference/invalid-parameter-functions.md +++ b/docs/c-runtime-library/reference/invalid-parameter-functions.md @@ -73,9 +73,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header| -|--------------|------------------| -|**`_invalid_parameter`**, **`_invalid_parameter_noinfo`**, **`_invalid_parameter_noinfo_noreturn`**, **`_invoke_watson`**|``| +| Function | Required header | +|---|---| +| **`_invalid_parameter`**, **`_invalid_parameter_noinfo`**, **`_invalid_parameter_noinfo_noreturn`**, **`_invoke_watson`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isalnum-iswalnum-isalnum-l-iswalnum-l.md b/docs/c-runtime-library/reference/isalnum-iswalnum-isalnum-l-iswalnum-l.md index 9ea3734f867..289bddbf5f9 100644 --- a/docs/c-runtime-library/reference/isalnum-iswalnum-isalnum-l-iswalnum-l.md +++ b/docs/c-runtime-library/reference/isalnum-iswalnum-isalnum-l-iswalnum-l.md @@ -41,10 +41,10 @@ The behavior of **`isalnum`** and **`_isalnum_l`** is undefined if *`c`* isn't E ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_istalnum`|**`isalnum`**|[`_ismbcalnum`](ismbcalnum-functions.md)|**`iswalnum`**| -|**`_istalnum_l`**|**`_isalnum_l`**|**`_ismbcalnum_l`**|**`_iswalnum_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istalnum` | **`isalnum`** | [`_ismbcalnum`](ismbcalnum-functions.md) | **`iswalnum`** | +| **`_istalnum_l`** | **`_isalnum_l`** | **`_ismbcalnum_l`** | **`_iswalnum_l`** | ## Remarks @@ -52,12 +52,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`isalnum`**|\| -|**`iswalnum`**|\ or \| -|**`_isalnum_l`**|\| -|**`_iswalnum_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`isalnum`** | \ | +| **`iswalnum`** | \ or \ | +| **`_isalnum_l`** | \ | +| **`_iswalnum_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isalpha-iswalpha-isalpha-l-iswalpha-l.md b/docs/c-runtime-library/reference/isalpha-iswalpha-isalpha-l-iswalpha-l.md index 506385feb21..451b47ae8db 100644 --- a/docs/c-runtime-library/reference/isalpha-iswalpha-isalpha-l-iswalpha-l.md +++ b/docs/c-runtime-library/reference/isalpha-iswalpha-isalpha-l-iswalpha-l.md @@ -51,10 +51,10 @@ The behavior of **`isalpha`** and **`_isalpha_l`** is undefined if *`c`* isn't E ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_istalpha`|**`isalpha`**|**`_ismbcalpha`**|**`iswalpha`**| -|`_istalpha_l`|**`_isalpha_l`**|**`_ismbcalpha_l`**|**`_iswalpha_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istalpha` | **`isalpha`** | **`_ismbcalpha`** | **`iswalpha`** | +| `_istalpha_l` | **`_isalpha_l`** | **`_ismbcalpha_l`** | **`_iswalpha_l`** | ## Remarks @@ -62,12 +62,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`isalpha`**|\| -|**`iswalpha`**|\ or \| -|**`_isalpha_l`**|\| -|**`_iswalpha_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`isalpha`** | \ | +| **`iswalpha`** | \ or \ | +| **`_isalpha_l`** | \ | +| **`_iswalpha_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isascii-isascii-iswascii.md b/docs/c-runtime-library/reference/isascii-isascii-iswascii.md index 9ed6c8ebd38..5152d043509 100644 --- a/docs/c-runtime-library/reference/isascii-isascii-iswascii.md +++ b/docs/c-runtime-library/reference/isascii-isascii-iswascii.md @@ -46,16 +46,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_istascii`**|**`__isascii`**|**`__isascii`**|**`iswascii`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_istascii`** | **`__isascii`** | **`__isascii`** | **`iswascii`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`isascii`**, **`__isascii`**|C: \

C++: \ or \| -|**`iswascii`**|C: \, \, or \

C++: \, \, \, \, or \| +| Routine | Required header | +|---|---| +| **`isascii`**, **`__isascii`** | C: \

C++: \ or \ | +| **`iswascii`** | C: \, \, or \

C++: \, \, \, \, or \ | The **`isascii`**, **`__isascii`**, and **`iswascii`** functions are Microsoft-specific. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isatty.md b/docs/c-runtime-library/reference/isatty.md index 561cfdf7bbb..bb8f397e669 100644 --- a/docs/c-runtime-library/reference/isatty.md +++ b/docs/c-runtime-library/reference/isatty.md @@ -39,9 +39,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_isatty`**|\| +| Routine | Required header | +|---|---| +| **`_isatty`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isblank-iswblank-isblank-l-iswblank-l.md b/docs/c-runtime-library/reference/isblank-iswblank-isblank-l-iswblank-l.md index b9f965b7a36..c985b77ffeb 100644 --- a/docs/c-runtime-library/reference/isblank-iswblank-isblank-l-iswblank-l.md +++ b/docs/c-runtime-library/reference/isblank-iswblank-isblank-l-iswblank-l.md @@ -50,10 +50,10 @@ The behavior of **`isblank`** and **`_isblank_l`** is undefined if *`c`* isn't E ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_istblank`|**`isblank`**|[`_ismbcblank`](ismbcgraph-functions.md)|**`iswblank`**| -|**`_istblank_l`**|**`_isblank_l`**|[`_ismbcblank_l`](ismbcgraph-functions.md)|**`_iswblank_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istblank` | **`isblank`** | [`_ismbcblank`](ismbcgraph-functions.md) | **`iswblank`** | +| **`_istblank_l`** | **`_isblank_l`** | [`_ismbcblank_l`](ismbcgraph-functions.md) | **`_iswblank_l`** | ## Remarks @@ -61,12 +61,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`isblank`**|\| -|**`iswblank`**|\ or \| -|**`_isblank_l`**|\| -|**`_iswblank_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`isblank`** | \ | +| **`iswblank`** | \ or \ | +| **`_isblank_l`** | \ | +| **`_iswblank_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/iscntrl-iswcntrl-iscntrl-l-iswcntrl-l.md b/docs/c-runtime-library/reference/iscntrl-iswcntrl-iscntrl-l-iswcntrl-l.md index fce55a2d8dd..0ae562406af 100644 --- a/docs/c-runtime-library/reference/iscntrl-iswcntrl-iscntrl-l-iswcntrl-l.md +++ b/docs/c-runtime-library/reference/iscntrl-iswcntrl-iscntrl-l-iswcntrl-l.md @@ -51,10 +51,10 @@ The behavior of **`iscntrl`** and **`_iscntrl_l`** is undefined if *`c`* isn't E ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_istcntrl`|**`iscntrl`**|**`iscntrl`**|**`iswcntrl`**| -|`_istcntrl_l`|**`_iscntrl_l`**|**`_iscntrl_l`**|**`_iswcntrl_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istcntrl` | **`iscntrl`** | **`iscntrl`** | **`iswcntrl`** | +| `_istcntrl_l` | **`_iscntrl_l`** | **`_iscntrl_l`** | **`_iswcntrl_l`** | ## Remarks @@ -62,12 +62,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`iscntrl`**|\| -|**`iswcntrl`**|\ or \| -|**`_iscntrl_l`**|\| -|**`_iswcntrl_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`iscntrl`** | \ | +| **`iswcntrl`** | \ or \ | +| **`_iscntrl_l`** | \ | +| **`_iswcntrl_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/iscsym-functions.md b/docs/c-runtime-library/reference/iscsym-functions.md index 3174d455a86..d61385de39e 100644 --- a/docs/c-runtime-library/reference/iscsym-functions.md +++ b/docs/c-runtime-library/reference/iscsym-functions.md @@ -69,9 +69,9 @@ For backward compatibility, **`iscsym`** and **`iscsymf`** are defined as macros ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`iscsym`**, **`iscsymf`**, **`__iscsym`**, **`__iswcsym`**, **`__iscsymf`**, **`__iswcsymf`**, **`_iscsym_l`**, **`_iswcsym_l`**, **`_iscsymf_l`**, **`_iswcsymf_l`**|C: \

C++: \ or \| +| Routine | Required header | +|---|---| +| **`iscsym`**, **`iscsymf`**, **`__iscsym`**, **`__iswcsym`**, **`__iscsymf`**, **`__iswcsymf`**, **`_iscsym_l`**, **`_iswcsym_l`**, **`_iscsymf_l`**, **`_iswcsymf_l`** | C: \

C++: \ or \ | The **`iscsym`**, **`iscsymf`**, **`__iscsym`**, **`__iswcsym`**, **`__iscsymf`**, **`__iswcsymf`**, **`_iscsym_l`**, **`_iswcsym_l`**, **`_iscsymf_l`**, and **`_iswcsymf_l`** routines are Microsoft-specific. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isctype-iswctype-isctype-l-iswctype-l.md b/docs/c-runtime-library/reference/isctype-iswctype-isctype-l-iswctype-l.md index cdfa2250501..d199cab373e 100644 --- a/docs/c-runtime-library/reference/isctype-iswctype-isctype-l-iswctype-l.md +++ b/docs/c-runtime-library/reference/isctype-iswctype-isctype-l-iswctype-l.md @@ -56,10 +56,10 @@ The behavior of **`_isctype`** and **`_isctype_l`** is undefined if *`c`* isn't ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|n/a|**`_isctype`**|n/a|**`_iswctype`**| -|n/a|**`_isctype_l`**|n/a|**`_iswctype_l`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| n/a | **`_isctype`** | n/a | **`_iswctype`** | +| n/a | **`_isctype_l`** | n/a | **`_iswctype_l`** | ## Remarks @@ -67,12 +67,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_isctype`**|\| -|**`iswctype`**|\ or \| -|**`_isctype_l`**|\| -|**`_iswctype_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`_isctype`** | \ | +| **`iswctype`** | \ or \ | +| **`_isctype_l`** | \ | +| **`_iswctype_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isdigit-iswdigit-isdigit-l-iswdigit-l.md b/docs/c-runtime-library/reference/isdigit-iswdigit-isdigit-l-iswdigit-l.md index 303368824e1..bcdd4ebde78 100644 --- a/docs/c-runtime-library/reference/isdigit-iswdigit-isdigit-l-iswdigit-l.md +++ b/docs/c-runtime-library/reference/isdigit-iswdigit-isdigit-l-iswdigit-l.md @@ -51,10 +51,10 @@ The behavior of **`isdigit`** and **`_isdigit_l`** is undefined if *`c`* isn't E ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_istdigit`|**`isdigit`**|[`_ismbcdigit`](ismbcalnum-functions.md)|**`iswdigit`**| -|`_istdigit_l`|**`_isdigit_l`**|[`_ismbcdigit_l`](ismbcalnum-functions.md)|**`_iswdigit_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istdigit` | **`isdigit`** | [`_ismbcdigit`](ismbcalnum-functions.md) | **`iswdigit`** | +| `_istdigit_l` | **`_isdigit_l`** | [`_ismbcdigit_l`](ismbcalnum-functions.md) | **`_iswdigit_l`** | ## Remarks @@ -62,12 +62,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`isdigit`**|\| -|**`iswdigit`**|\ or \| -|**`_isdigit_l`**|\| -|**`_iswdigit_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`isdigit`** | \ | +| **`iswdigit`** | \ or \ | +| **`_isdigit_l`** | \ | +| **`_iswdigit_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isgraph-iswgraph-isgraph-l-iswgraph-l.md b/docs/c-runtime-library/reference/isgraph-iswgraph-isgraph-l-iswgraph-l.md index d10a8b8182f..131d8f2de34 100644 --- a/docs/c-runtime-library/reference/isgraph-iswgraph-isgraph-l-iswgraph-l.md +++ b/docs/c-runtime-library/reference/isgraph-iswgraph-isgraph-l-iswgraph-l.md @@ -48,10 +48,10 @@ The behavior of **`isgraph`** and **`_isgraph_l`** is undefined if *`c`* isn't E ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_istgraph`|**`isgraph`**|[`_ismbcgraph`](ismbcgraph-functions.md)|**`iswgraph`**| -|**`_istgraph_l`**|**`_isgraph_l`**|[`_ismbcgraph_l`](ismbcgraph-functions.md)|**`_iswgraph_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istgraph` | **`isgraph`** | [`_ismbcgraph`](ismbcgraph-functions.md) | **`iswgraph`** | +| **`_istgraph_l`** | **`_isgraph_l`** | [`_ismbcgraph_l`](ismbcgraph-functions.md) | **`_iswgraph_l`** | ## Remarks @@ -59,12 +59,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`isgraph`**|\| -|**`iswgraph`**|\ or \| -|**`_isgraph_l`**|\| -|**`_iswgraph_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`isgraph`** | \ | +| **`iswgraph`** | \ or \ | +| **`_isgraph_l`** | \ | +| **`_iswgraph_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isinf.md b/docs/c-runtime-library/reference/isinf.md index 9821ae201c6..50165ca0ea1 100644 --- a/docs/c-runtime-library/reference/isinf.md +++ b/docs/c-runtime-library/reference/isinf.md @@ -37,9 +37,9 @@ The floating-point value to test. ## Requirements -|Function|Required header (C)|Required header (C++)| -|--------------|---------------------------|-------------------------------| -|**`isinf`**|\|\ or \| +| Function | Required header (C) | Required header (C++) | +|---|---|---| +| **`isinf`** | \ | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isleadbyte-isleadbyte-l.md b/docs/c-runtime-library/reference/isleadbyte-isleadbyte-l.md index 8ce14bd45c6..8a21d64c8b5 100644 --- a/docs/c-runtime-library/reference/isleadbyte-isleadbyte-l.md +++ b/docs/c-runtime-library/reference/isleadbyte-isleadbyte-l.md @@ -45,16 +45,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_istleadbyte`**|Always returns false|**`_isleadbyte`**|Always returns false| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_istleadbyte`** | Always returns false | **`_isleadbyte`** | Always returns false | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`isleadbyte`**|\| -|**`_isleadbyte_l`**|\| +| Routine | Required header | +|---|---| +| **`isleadbyte`** | \ | +| **`_isleadbyte_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/islower-iswlower-islower-l-iswlower-l.md b/docs/c-runtime-library/reference/islower-iswlower-islower-l-iswlower-l.md index f1c0bed43f6..035a24dc0ab 100644 --- a/docs/c-runtime-library/reference/islower-iswlower-islower-l-iswlower-l.md +++ b/docs/c-runtime-library/reference/islower-iswlower-islower-l-iswlower-l.md @@ -51,10 +51,10 @@ The behavior of **`islower`** and **`_islower_l`** is undefined if *`c`* isn't E ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_istlower`|**`islower`**|[`_ismbclower`](ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md)|**`iswlower`**| -|**`_istlower_l`**|`_islower _l`|[`_ismbclower_l`](ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md)|**`_liswlower_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istlower` | **`islower`** | [`_ismbclower`](ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md) | **`iswlower`** | +| **`_istlower_l`** | `_islower _l` | [`_ismbclower_l`](ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md) | **`_liswlower_l`** | ## Remarks @@ -62,12 +62,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`islower`**|\| -|**`iswlower`**|\ or \| -|**`_islower_l`**|\| -|**`_swlower_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`islower`** | \ | +| **`iswlower`** | \ or \ | +| **`_islower_l`** | \ | +| **`_swlower_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbbalnum-ismbbalnum-l.md b/docs/c-runtime-library/reference/ismbbalnum-ismbbalnum-l.md index 7bb46276ba7..f8109c2c602 100644 --- a/docs/c-runtime-library/reference/ismbbalnum-ismbbalnum-l.md +++ b/docs/c-runtime-library/reference/ismbbalnum-ismbbalnum-l.md @@ -49,10 +49,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbbalnum`**|\| -|**`_ismbbalnum_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbbalnum`** | \ | +| **`_ismbbalnum_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbbalpha-ismbbalpha-l.md b/docs/c-runtime-library/reference/ismbbalpha-ismbbalpha-l.md index 9453bbd4bb8..c5dfbf4845b 100644 --- a/docs/c-runtime-library/reference/ismbbalpha-ismbbalpha-l.md +++ b/docs/c-runtime-library/reference/ismbbalpha-ismbbalpha-l.md @@ -47,10 +47,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbbalpha`**|\| -|**`_ismbbalpha_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbbalpha`** | \ | +| **`_ismbbalpha_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbbblank-ismbbblank-l.md b/docs/c-runtime-library/reference/ismbbblank-ismbbblank-l.md index 82283c65be4..2a7ded14c50 100644 --- a/docs/c-runtime-library/reference/ismbbblank-ismbbblank-l.md +++ b/docs/c-runtime-library/reference/ismbbblank-ismbbblank-l.md @@ -45,10 +45,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbbblank`**|\| -|**`_ismbbblank_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbbblank`** | \ | +| **`_ismbbblank_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbbgraph-ismbbgraph-l.md b/docs/c-runtime-library/reference/ismbbgraph-ismbbgraph-l.md index 9a280150d49..ed067a9dfe9 100644 --- a/docs/c-runtime-library/reference/ismbbgraph-ismbbgraph-l.md +++ b/docs/c-runtime-library/reference/ismbbgraph-ismbbgraph-l.md @@ -48,10 +48,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbbgraph`**|\| -|**`_ismbbgraph_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbbgraph`** | \ | +| **`_ismbbgraph_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbbkalnum-ismbbkalnum-l.md b/docs/c-runtime-library/reference/ismbbkalnum-ismbbkalnum-l.md index c0049a03003..c07a0a7e006 100644 --- a/docs/c-runtime-library/reference/ismbbkalnum-ismbbkalnum-l.md +++ b/docs/c-runtime-library/reference/ismbbkalnum-ismbbkalnum-l.md @@ -44,10 +44,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbbkalnum`**|\| -|**`_ismbbkalnum_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbbkalnum`** | \ | +| **`_ismbbkalnum_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbbkana-ismbbkana-l.md b/docs/c-runtime-library/reference/ismbbkana-ismbbkana-l.md index ada9f31353c..bf40105541a 100644 --- a/docs/c-runtime-library/reference/ismbbkana-ismbbkana-l.md +++ b/docs/c-runtime-library/reference/ismbbkana-ismbbkana-l.md @@ -44,10 +44,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbbkana`**|\| -|**`_ismbbkana_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbbkana`** | \ | +| **`_ismbbkana_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbbkprint-ismbbkprint-l.md b/docs/c-runtime-library/reference/ismbbkprint-ismbbkprint-l.md index 3a0de73110b..91f20098bfe 100644 --- a/docs/c-runtime-library/reference/ismbbkprint-ismbbkprint-l.md +++ b/docs/c-runtime-library/reference/ismbbkprint-ismbbkprint-l.md @@ -44,10 +44,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbbkprint`**|\| -|**`_ismbbkprint_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbbkprint`** | \ | +| **`_ismbbkprint_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbbkpunct-ismbbkpunct-l.md b/docs/c-runtime-library/reference/ismbbkpunct-ismbbkpunct-l.md index ecc1d508e5c..6597598987f 100644 --- a/docs/c-runtime-library/reference/ismbbkpunct-ismbbkpunct-l.md +++ b/docs/c-runtime-library/reference/ismbbkpunct-ismbbkpunct-l.md @@ -44,10 +44,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbbkpunct`**|\| -|**`_ismbbkpunct_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbbkpunct`** | \ | +| **`_ismbbkpunct_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbblead-ismbblead-l.md b/docs/c-runtime-library/reference/ismbblead-ismbblead-l.md index 0bc1a3ca649..bb9aee6846d 100644 --- a/docs/c-runtime-library/reference/ismbblead-ismbblead-l.md +++ b/docs/c-runtime-library/reference/ismbblead-ismbblead-l.md @@ -52,16 +52,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_istlead`|Always returns false|**`_ismbblead`**|Always returns false| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istlead` | Always returns false | **`_ismbblead`** | Always returns false | ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_ismbblead`**|\ or \|\,* \, \| -|**`_ismbblead_l`**|\ or \|\,* \, \| +| Routine | Required header | Optional header | +|---|---|---| +| **`_ismbblead`** | \ or \ | \,* \, \ | +| **`_ismbblead_l`** | \ or \ | \,* \, \ | \* For manifest constants for the test conditions. diff --git a/docs/c-runtime-library/reference/ismbbprint-ismbbprint-l.md b/docs/c-runtime-library/reference/ismbbprint-ismbbprint-l.md index f56b895fdcb..ab7b42dfc3c 100644 --- a/docs/c-runtime-library/reference/ismbbprint-ismbbprint-l.md +++ b/docs/c-runtime-library/reference/ismbbprint-ismbbprint-l.md @@ -48,10 +48,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbbprint`**|\| -|**`_ismbbprint_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbbprint`** | \ | +| **`_ismbbprint_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbbpunct-ismbbpunct-l.md b/docs/c-runtime-library/reference/ismbbpunct-ismbbpunct-l.md index 48d95652e49..51e8242c0c9 100644 --- a/docs/c-runtime-library/reference/ismbbpunct-ismbbpunct-l.md +++ b/docs/c-runtime-library/reference/ismbbpunct-ismbbpunct-l.md @@ -44,10 +44,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbbpunct`**|\| -|**`_ismbbpunct_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbbpunct`** | \ | +| **`_ismbbpunct_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbbtrail-ismbbtrail-l.md b/docs/c-runtime-library/reference/ismbbtrail-ismbbtrail-l.md index 07d70f01939..46db4299b67 100644 --- a/docs/c-runtime-library/reference/ismbbtrail-ismbbtrail-l.md +++ b/docs/c-runtime-library/reference/ismbbtrail-ismbbtrail-l.md @@ -46,10 +46,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_ismbbtrail`**|\ or \|\,* \, \| -|**`_ismbbtrail_l`**|\ or \|\,* \, \| +| Routine | Required header | Optional header | +|---|---|---| +| **`_ismbbtrail`** | \ or \ | \,* \, \ | +| **`_ismbbtrail_l`** | \ or \ | \,* \, \ | \* For manifest constants for the test conditions. diff --git a/docs/c-runtime-library/reference/ismbcalnum-functions.md b/docs/c-runtime-library/reference/ismbcalnum-functions.md index 666f069a43f..911263dc38a 100644 --- a/docs/c-runtime-library/reference/ismbcalnum-functions.md +++ b/docs/c-runtime-library/reference/ismbcalnum-functions.md @@ -67,21 +67,21 @@ Each of these routines tests a given multibyte character for a given condition. The versions of these functions with the `_l` suffix are identical except that they use the locale passed in instead of the current locale for their locale-dependent behavior. For more information, see [Locale](../locale.md). -|Routine|Test condition|Code page 932 example| -|-------------|--------------------|---------------------------| -|**`_ismbcalnum`**, **`_ismbcalnum_l`**|Alphanumeric|Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII English letter: See examples for **`_ismbcdigit`** and **`_ismbcalpha`**.| -|**`_ismbcalpha`**, **`_ismbcalpha_l`**|Alphabetic|Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII English letter: 0x41<=*`c`*<=0x5A or 0x61<=*`c`*<=0x7A; or a katakana letter: 0xA6<=*`c`*<=0xDF.| -|**`_ismbcdigit`**, **`_ismbcdigit_l`**|Digit|Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII digit: 0x30<=*`c`*<=0x39.| +| Routine | Test condition | Code page 932 example | +|---|---|---| +| **`_ismbcalnum`**, **`_ismbcalnum_l`** | Alphanumeric | Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII English letter: See examples for **`_ismbcdigit`** and **`_ismbcalpha`**. | +| **`_ismbcalpha`**, **`_ismbcalpha_l`** | Alphabetic | Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII English letter: 0x41<=*`c`*<=0x5A or 0x61<=*`c`*<=0x7A; or a katakana letter: 0xA6<=*`c`*<=0xDF. | +| **`_ismbcdigit`**, **`_ismbcdigit_l`** | Digit | Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII digit: 0x30<=*`c`*<=0x39. | 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). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbcalnum`**, **`_ismbcalnum_l`**|\| -|**`_ismbcalpha`**, **`_ismbcalpha_l`**|\| -|**`_ismbcdigit`**, **`_ismbcdigit_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbcalnum`**, **`_ismbcalnum_l`** | \ | +| **`_ismbcalpha`**, **`_ismbcalpha_l`** | \ | +| **`_ismbcdigit`**, **`_ismbcdigit_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbcgraph-functions.md b/docs/c-runtime-library/reference/ismbcgraph-functions.md index 89488e4ce5d..ec49f28bbe7 100644 --- a/docs/c-runtime-library/reference/ismbcgraph-functions.md +++ b/docs/c-runtime-library/reference/ismbcgraph-functions.md @@ -75,30 +75,30 @@ The versions of these functions are identical, except that the ones that have th Each of these functions tests a given multibyte character for a given condition. -|Routine|Test condition|Code page 932 example| -|-------------|--------------------|---------------------------| -|**`_ismbcgraph`**|Graphic|Returns nonzero if and only if *`c`* is a single-byte representation of any ASCII or katakana printable character except a white space ( ).| -|**`_ismbcprint`**|Printable|Returns nonzero if and only if *`c`* is a single-byte representation of any ASCII or katakana printable character including a white space ( ).| -|**`_ismbcpunct`**|Punctuation|Returns nonzero if and only if *`c`* is a single-byte representation of any ASCII or katakana punctuation character.| -|**`_ismbcblank`**|Space or horizontal tab|Returns nonzero if and only if *`c`* is a space or horizontal tab character: *`c`*=0x20 or *`c`*=0x09.| -|**`_ismbcspace`**|White space|Returns nonzero if and only if *`c`* is a white-space character: *`c`*=0x20 or 0x09<=*`c`*<=0x0D.| +| Routine | Test condition | Code page 932 example | +|---|---|---| +| **`_ismbcgraph`** | Graphic | Returns nonzero if and only if *`c`* is a single-byte representation of any ASCII or katakana printable character except a white space. | +| **`_ismbcprint`** | Printable | Returns nonzero if and only if *`c`* is a single-byte representation of any ASCII or katakana printable character including a white space. | +| **`_ismbcpunct`** | Punctuation | Returns nonzero if and only if *`c`* is a single-byte representation of any ASCII or katakana punctuation character. | +| **`_ismbcblank`** | Space or horizontal tab | Returns nonzero if and only if *`c`* is a space or horizontal tab character: *`c`*=0x20 or *`c`*=0x09. | +| **`_ismbcspace`** | White space | Returns nonzero if and only if *`c`* is a white-space character: *`c`*=0x20 or 0x09<=*`c`*<=0x0D. | 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). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbcgraph`**|\| -|**`_ismbcgraph_l`**|\| -|**`_ismbcprint`**|\| -|**`_ismbcprint_l`**|\| -|**`_ismbcpunct`**|\| -|**`_ismbcpunct_l`**|\| -|**`_ismbcblank`**|\| -|**`_ismbcblank_l`**|\| -|**`_ismbcspace`**|\| -|**`_ismbcspace_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbcgraph`** | \ | +| **`_ismbcgraph_l`** | \ | +| **`_ismbcprint`** | \ | +| **`_ismbcprint_l`** | \ | +| **`_ismbcpunct`** | \ | +| **`_ismbcpunct_l`** | \ | +| **`_ismbcblank`** | \ | +| **`_ismbcblank_l`** | \ | +| **`_ismbcspace`** | \ | +| **`_ismbcspace_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md b/docs/c-runtime-library/reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md index 0b60c808c4c..92f0cc687a0 100644 --- a/docs/c-runtime-library/reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md +++ b/docs/c-runtime-library/reference/ismbchira-ismbchira-l-ismbckata-ismbckata-l.md @@ -54,12 +54,12 @@ Each of these functions tests a given multibyte character for a given condition. The versions of these functions with the `_l` suffix are identical except that they use the locale passed in instead of the current locale for their locale-dependent behavior. For more information, see [Locale](../locale.md). -|Routine|Test condition (code page 932 only)| -|-------------|-------------------------------------------| -|**`_ismbchira`**|Double-byte Hiragana: 0x829F<=*`c`*<=0x82F1.| -|**`_ismbchira_l`**|Double-byte Hiragana: 0x829F<=*`c`*<=0x82F1.| -|**`_ismbckata`**|Double-byte katakana: 0x8340<=*`c`*<=0x8396.| -|**`_ismbckata_l`**|Double-byte katakana: 0x8340<=*`c`*<=0x8396.| +| Routine | Test condition (code page 932 only) | +|---|---| +| **`_ismbchira`** | Double-byte Hiragana: 0x829F<=*`c`*<=0x82F1. | +| **`_ismbchira_l`** | Double-byte Hiragana: 0x829F<=*`c`*<=0x82F1. | +| **`_ismbckata`** | Double-byte katakana: 0x8340<=*`c`*<=0x8396. | +| **`_ismbckata_l`** | Double-byte katakana: 0x8340<=*`c`*<=0x8396. | **End Code Page 932 Specific** @@ -67,12 +67,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbchira`**|\| -|**`_ismbchira_l`**|\| -|**`_ismbckata`**|\| -|**`_ismbckata_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbchira`** | \ | +| **`_ismbchira_l`** | \ | +| **`_ismbckata`** | \ | +| **`_ismbckata_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md b/docs/c-runtime-library/reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md index 640f00a0bf6..a1e21c0bf27 100644 --- a/docs/c-runtime-library/reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md +++ b/docs/c-runtime-library/reference/ismbcl0-ismbcl0-l-ismbcl1-ismbcl1-l-ismbcl2-ismbcl2-l.md @@ -61,14 +61,14 @@ Each of these functions tests a given multibyte character for a given condition. The output value is affected by the setting of the `LC_CTYPE` category setting of the locale. For more information, see [`setlocale`](setlocale-wsetlocale.md). The versions of these functions without the `_l` suffix use the current locale for this locale-dependent behavior; the versions with the `_l` suffix are identical except that they use the locale parameter passed in instead. For more information, see [Locale](../locale.md). -|Routine|Test condition (code page 932 only)| -|-------------|-------------------------------------------| -|**`_ismbcl0`**|JIS non-Kanji: 0x8140<=*`c`*<=0x889E.| -|**`_ismbcl0_l`**|JIS non-Kanji: 0x8140<=*`c`*<=0x889E.| -|**`_ismbcl1`**|JIS level-1: 0x889F<=*`c`*<=0x9872.| -|**`_ismbcl1_l`**|JIS level-1: 0x889F<=*`c`*<=0x9872.| -|**`_ismbcl2`**|JIS level-2: 0x989F<=*`c`*<=0xEAA4.| -|**`_ismbcl2_l`**|JIS level-2: 0x989F<=*`c`*<=0xEAA4.| +| Routine | Test condition (code page 932 only) | +|---|---| +| **`_ismbcl0`** | JIS non-Kanji: 0x8140<=*`c`*<=0x889E. | +| **`_ismbcl0_l`** | JIS non-Kanji: 0x8140<=*`c`*<=0x889E. | +| **`_ismbcl1`** | JIS level-1: 0x889F<=*`c`*<=0x9872. | +| **`_ismbcl1_l`** | JIS level-1: 0x889F<=*`c`*<=0x9872. | +| **`_ismbcl2`** | JIS level-2: 0x989F<=*`c`*<=0xEAA4. | +| **`_ismbcl2_l`** | JIS level-2: 0x989F<=*`c`*<=0xEAA4. | The functions check that the specified value *`c`* matches the test conditions described above, but don't check that *`c`* is a valid multibyte character. If the lower byte is in the ranges 0x00 - 0x3F, 0x7F, or 0xFD - 0xFF, these functions return a nonzero value, indicating that the character satisfies the test condition. Use [`_ismbbtrail`](ismbbtrail-ismbbtrail-l.md) to test whether the multibyte character is defined. @@ -78,14 +78,14 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbcl0`**|\| -|**`_ismbcl0_l`**|\| -|**`_ismbcl1`**|\| -|**`_ismbcl1_l`**|\| -|**`_ismbcl2`**|\| -|**`_ismbcl2_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbcl0`** | \ | +| **`_ismbcl0_l`** | \ | +| **`_ismbcl1`** | \ | +| **`_ismbcl1_l`** | \ | +| **`_ismbcl2`** | \ | +| **`_ismbcl2_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md b/docs/c-runtime-library/reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md index 6f00540f62a..72b5c3a87d4 100644 --- a/docs/c-runtime-library/reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md +++ b/docs/c-runtime-library/reference/ismbclegal-ismbclegal-l-ismbcsymbol-ismbcsymbol-l.md @@ -54,26 +54,26 @@ Each of these functions tests a given multibyte character for a given condition. The versions of these functions with the `_l` suffix are identical except that they use the locale passed in instead of the current locale for their locale-dependent behavior. For more information, see [Locale](../locale.md). -|Routine|Test condition|Code page 932 example| -|-------------|--------------------|---------------------------| -|**`_ismbclegal`**|Valid multibyte|Returns nonzero if and only if the first byte of *`c`* is within ranges 0x81 - 0x9F or 0xE0 - 0xFC, while the second byte is within ranges 0x40 - 0x7E or 0x80 - FC.| -|**`_ismbcsymbol`**|Multibyte symbol|Returns nonzero if and only if 0x8141<=*`c`*<=0x81AC.| +| Routine | Test condition | Code page 932 example | +|---|---|---| +| **`_ismbclegal`** | Valid multibyte | Returns nonzero if and only if the first byte of *`c`* is within ranges 0x81 - 0x9F or 0xE0 - 0xFC, while the second byte is within ranges 0x40 - 0x7E or 0x80 - FC. | +| **`_ismbcsymbol`** | Multibyte symbol | Returns nonzero if and only if 0x8141<=*`c`*<=0x81AC. | 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). ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_istlegal`|Always returns false|**`_ismbclegal`**|Always returns false.| -|`_istlegal_l`|Always returns false|**`_ismbclegal_l`**|Always returns false.| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istlegal` | Always returns false | **`_ismbclegal`** | Always returns false. | +| `_istlegal_l` | Always returns false | **`_ismbclegal_l`** | Always returns false. | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbclegal`**, **`_ismbclegal_l`**|\| -|**`_ismbcsymbol`**, **`_ismbcsymbol_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbclegal`**, **`_ismbclegal_l`** | \ | +| **`_ismbcsymbol`**, **`_ismbcsymbol_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md b/docs/c-runtime-library/reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md index 54bced01c98..1c647abafce 100644 --- a/docs/c-runtime-library/reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md +++ b/docs/c-runtime-library/reference/ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md @@ -54,23 +54,23 @@ Each of these functions tests a given multibyte character for a given condition. The versions of these functions with the `_l` suffix are identical except that they use the locale passed in instead of the current locale for their locale-dependent behavior. For more information, see [Locale](../locale.md). -|Routine|Test condition|Code page 932 example| -|-------------|--------------------|---------------------------| -|**`_ismbclower`**|Lowercase alphabetic|Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII lowercase English letter: 0x61<=*`c`*<=0x7A.| -|**`_ismbclower_l`**|Lowercase alphabetic|Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII lowercase English letter: 0x61<=*`c`*<=0x7A.| -|**`_ismbcupper`**|Uppercase alphabetic|Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII uppercase English letter: 0x41<=*`c`*<=0x5A.| -|**`_ismbcupper_l`**|Uppercase alphabetic|Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII uppercase English letter: 0x41<=*`c`*<=0x5A.| +| Routine | Test condition | Code page 932 example | +|---|---|---| +| **`_ismbclower`** | Lowercase alphabetic | Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII lowercase English letter: 0x61<=*`c`*<=0x7A. | +| **`_ismbclower_l`** | Lowercase alphabetic | Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII lowercase English letter: 0x61<=*`c`*<=0x7A. | +| **`_ismbcupper`** | Uppercase alphabetic | Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII uppercase English letter: 0x41<=*`c`*<=0x5A. | +| **`_ismbcupper_l`** | Uppercase alphabetic | Returns nonzero if and only if *`c`* is a single-byte representation of an ASCII uppercase English letter: 0x41<=*`c`*<=0x5A. | 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). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ismbclower`**|\| -|**`_ismbclower_l`**|\| -|**`_ismbcupper`**|\| -|**`_ismbcupper_l`**|\| +| Routine | Required header | +|---|---| +| **`_ismbclower`** | \ | +| **`_ismbclower_l`** | \ | +| **`_ismbcupper`** | \ | +| **`_ismbcupper_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ismbslead-ismbstrail-ismbslead-l-ismbstrail-l.md b/docs/c-runtime-library/reference/ismbslead-ismbstrail-ismbslead-l-ismbstrail-l.md index ab32d203d8e..30d1caf0cbe 100644 --- a/docs/c-runtime-library/reference/ismbslead-ismbstrail-ismbslead-l-ismbstrail-l.md +++ b/docs/c-runtime-library/reference/ismbslead-ismbstrail-ismbslead-l-ismbstrail-l.md @@ -65,12 +65,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_ismbslead`**|\ or \|\,* \, \| -|**`_ismbstrail`**|\ or \|\,* \, \| -|**`_ismbslead_l`**|\ or \|\,* \, \| -|**`_ismbstrail_l`**|\ or \|\,* \, \| +| Routine | Required header | Optional header | +|---|---|---| +| **`_ismbslead`** | \ or \ | \,* \, \ | +| **`_ismbstrail`** | \ or \ | \,* \, \ | +| **`_ismbslead_l`** | \ or \ | \,* \, \ | +| **`_ismbstrail_l`** | \ or \ | \,* \, \ | \* For manifest constants for the test conditions. diff --git a/docs/c-runtime-library/reference/isnan-isnan-isnanf.md b/docs/c-runtime-library/reference/isnan-isnan-isnanf.md index 1746eec4b54..c0815b33fcd 100644 --- a/docs/c-runtime-library/reference/isnan-isnan-isnanf.md +++ b/docs/c-runtime-library/reference/isnan-isnan-isnanf.md @@ -56,10 +56,10 @@ The **`_isnan`** and **`_isnanf`** functions are Microsoft-specific. The **`_isn ## Requirements -|Routine|Required header (C)|Required header (C++)| -|-------------|---------------------------|-------------------------------| -|**`isnan`**, **`_isnanf`**|\|\ or \| -|**`_isnan`**|\|\ or \| +| Routine | Required header (C) | Required header (C++) | +|---|---|---| +| **`isnan`**, **`_isnanf`** | \ | \ or \ | +| **`_isnan`** | \ | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isnormal.md b/docs/c-runtime-library/reference/isnormal.md index ac98c1747d6..2ca56bdc5cd 100644 --- a/docs/c-runtime-library/reference/isnormal.md +++ b/docs/c-runtime-library/reference/isnormal.md @@ -37,9 +37,9 @@ The floating-point value to test. ## Requirements -|Function|Required header (C)|Required header (C++)| -|--------------|---------------------------|-------------------------------| -|**`isnormal`**|\|\ or \| +| Function | Required header (C) | Required header (C++) | +|---|---|---| +| **`isnormal`** | \ | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isprint-iswprint-isprint-l-iswprint-l.md b/docs/c-runtime-library/reference/isprint-iswprint-isprint-l-iswprint-l.md index 313f0bec6ae..4c0eb17f102 100644 --- a/docs/c-runtime-library/reference/isprint-iswprint-isprint-l-iswprint-l.md +++ b/docs/c-runtime-library/reference/isprint-iswprint-isprint-l-iswprint-l.md @@ -51,9 +51,9 @@ The behavior of **`isprint`** and **`_isprint_l`** is undefined if *`c`* isn't E ### Generic-text routine mappings -|TCHAR.H routine|_UNICODE & _MBCS not defined|_MBCS defined|_unicode defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_istprint`|**`isprint`**|[`_ismbcprint`](ismbcgraph-functions.md)|**`iswprint`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istprint` | **`isprint`** | [`_ismbcprint`](ismbcgraph-functions.md) | **`iswprint`** | ## Remarks @@ -61,12 +61,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`isprint`**|\| -|**`iswprint`**|\ or \| -|**`_isprint_l`**|\| -|**`_iswprint_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`isprint`** | \ | +| **`iswprint`** | \ or \ | +| **`_isprint_l`** | \ | +| **`_iswprint_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ispunct-iswpunct-ispunct-l-iswpunct-l.md b/docs/c-runtime-library/reference/ispunct-iswpunct-ispunct-l-iswpunct-l.md index 93e1be531c8..db513d1b82a 100644 --- a/docs/c-runtime-library/reference/ispunct-iswpunct-ispunct-l-iswpunct-l.md +++ b/docs/c-runtime-library/reference/ispunct-iswpunct-ispunct-l-iswpunct-l.md @@ -51,9 +51,9 @@ The behavior of **`ispunct`** and **`_ispunct_l`** is undefined if *`c`* isn't E ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_istpunct`|**`ispunct`**|[`_ismbcpunct`](ismbcgraph-functions.md)|**`iswpunct`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istpunct` | **`ispunct`** | [`_ismbcpunct`](ismbcgraph-functions.md) | **`iswpunct`** | ## Remarks @@ -61,12 +61,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`ispunct`**|\| -|**`iswpunct`**|\ or \| -|**`_ispunct_l`**|\| -|**`_iswpunct_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`ispunct`** | \ | +| **`iswpunct`** | \ or \ | +| **`_ispunct_l`** | \ | +| **`_iswpunct_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isspace-iswspace-isspace-l-iswspace-l.md b/docs/c-runtime-library/reference/isspace-iswspace-isspace-l-iswspace-l.md index a963d152e65..f10a7acc45b 100644 --- a/docs/c-runtime-library/reference/isspace-iswspace-isspace-l-iswspace-l.md +++ b/docs/c-runtime-library/reference/isspace-iswspace-isspace-l-iswspace-l.md @@ -51,9 +51,9 @@ The behavior of **`isspace`** and **`_isspace_l`** is undefined if *`c`* isn't E ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**_** **`istspace`**|**`isspace`**|[`_ismbcspace`](ismbcgraph-functions.md)|**`iswspace`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istspace` | **`isspace`** | [`_ismbcspace`](ismbcgraph-functions.md) | **`iswspace`** | ## Remarks @@ -61,12 +61,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`isspace`**|\| -|**`iswspace`**|\ or \| -|**`_isspace_l`**|\| -|**`_iswspace_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`isspace`** | \ | +| **`iswspace`** | \ or \ | +| **`_isspace_l`** | \ | +| **`_iswspace_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isupper-isupper-l-iswupper-iswupper-l.md b/docs/c-runtime-library/reference/isupper-isupper-l-iswupper-iswupper-l.md index cb79a444a40..2961ee478ce 100644 --- a/docs/c-runtime-library/reference/isupper-isupper-l-iswupper-iswupper-l.md +++ b/docs/c-runtime-library/reference/isupper-isupper-l-iswupper-iswupper-l.md @@ -51,10 +51,10 @@ The behavior of **`isupper`** and **`_isupper_l`** is undefined if *`c`* isn't E ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_istupper`|**`isupper`**|[`_ismbcupper`](ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md)|**`iswupper`**| -|`_istupper_l`|**`_isupper_l`**|[`_ismbclower`, `_ismbclower_l`, `_ismbcupper`, `_ismbcupper_l`](ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md)|**`_iswupper_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istupper` | **`isupper`** | [`_ismbcupper`](ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md) | **`iswupper`** | +| `_istupper_l` | **`_isupper_l`** | [`_ismbclower`, `_ismbclower_l`, `_ismbcupper`, `_ismbcupper_l`](ismbclower-ismbclower-l-ismbcupper-ismbcupper-l.md) | **`_iswupper_l`** | ## Remarks @@ -62,12 +62,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`isupper`**|\| -|**`_isupper_l`**|\| -|**`iswupper`**|\ or \| -|**`_iswupper_l`**|\| +| Routine | Required header | +|---|---| +| **`isupper`** | \ | +| **`_isupper_l`** | \ | +| **`iswupper`** | \ or \ | +| **`_iswupper_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/isxdigit-iswxdigit-isxdigit-l-iswxdigit-l.md b/docs/c-runtime-library/reference/isxdigit-iswxdigit-isxdigit-l-iswxdigit-l.md index dae952bca37..e0bc3f12504 100644 --- a/docs/c-runtime-library/reference/isxdigit-iswxdigit-isxdigit-l-iswxdigit-l.md +++ b/docs/c-runtime-library/reference/isxdigit-iswxdigit-isxdigit-l-iswxdigit-l.md @@ -53,9 +53,9 @@ The behavior of **`isxdigit`** and **`_isxdigit_l`** is undefined if *`c`* isn't ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_istxdigit`|**`isxdigit`**|**`isxdigit`**|**`iswxdigit`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_istxdigit` | **`isxdigit`** | **`isxdigit`** | **`iswxdigit`** | ## Remarks @@ -63,12 +63,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`isxdigit`**|\| -|**`iswxdigit`**|\ or \| -|**`_isxdigit_l`**|\| -|**`_iswxdigit_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`isxdigit`** | \ | +| **`iswxdigit`** | \ or \ | +| **`_isxdigit_l`** | \ | +| **`_iswxdigit_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/itoa-itow.md b/docs/c-runtime-library/reference/itoa-itow.md index 56b91011d78..0893e3bafcc 100644 --- a/docs/c-runtime-library/reference/itoa-itow.md +++ b/docs/c-runtime-library/reference/itoa-itow.md @@ -121,13 +121,13 @@ To help you create secure buffers for conversions, the CRT includes some conveni To use one of these macros in a string conversion function, declare your conversion buffer of the appropriate character type and use the macro value for the integer type and base as the buffer dimension. This table lists the macros that are appropriate for each function for the listed bases: -|Functions|radix|Macros| -|-|-|-| -|**`_itoa`**, **`_itow`**|16
10
8
2|`_MAX_ITOSTR_BASE16_COUNT`
`_MAX_ITOSTR_BASE10_COUNT`
`_MAX_ITOSTR_BASE8_COUNT`
`_MAX_ITOSTR_BASE2_COUNT`| -|**`_ltoa`**, **`_ltow`**|16
10
8
2|`_MAX_LTOSTR_BASE16_COUNT`
`_MAX_LTOSTR_BASE10_COUNT`
`_MAX_LTOSTR_BASE8_COUNT`
`_MAX_LTOSTR_BASE2_COUNT`| -|**`_ultoa`**, **`_ultow`**|16
10
8
2|`_MAX_ULTOSTR_BASE16_COUNT`
`_MAX_ULTOSTR_BASE10_COUNT`
`_MAX_ULTOSTR_BASE8_COUNT`
`_MAX_ULTOSTR_BASE2_COUNT`| -|**`_i64toa`**, **`_i64tow`**|16
10
8
2|`_MAX_I64TOSTR_BASE16_COUNT`
`_MAX_I64TOSTR_BASE10_COUNT`
`_MAX_I64TOSTR_BASE8_COUNT`
`_MAX_I64TOSTR_BASE2_COUNT`| -|**`_ui64toa`**, **`_ui64tow`**|16
10
8
2|`_MAX_U64TOSTR_BASE16_COUNT`
`_MAX_U64TOSTR_BASE10_COUNT`
`_MAX_U64TOSTR_BASE8_COUNT`
`_MAX_U64TOSTR_BASE2_COUNT`| +| Functions | radix | Macros | +|---|---|---| +| **`_itoa`**, **`_itow`** | 16
10
8
2 | `_MAX_ITOSTR_BASE16_COUNT`
`_MAX_ITOSTR_BASE10_COUNT`
`_MAX_ITOSTR_BASE8_COUNT`
`_MAX_ITOSTR_BASE2_COUNT` | +| **`_ltoa`**, **`_ltow`** | 16
10
8
2 | `_MAX_LTOSTR_BASE16_COUNT`
`_MAX_LTOSTR_BASE10_COUNT`
`_MAX_LTOSTR_BASE8_COUNT`
`_MAX_LTOSTR_BASE2_COUNT` | +| **`_ultoa`**, **`_ultow`** | 16
10
8
2 | `_MAX_ULTOSTR_BASE16_COUNT`
`_MAX_ULTOSTR_BASE10_COUNT`
`_MAX_ULTOSTR_BASE8_COUNT`
`_MAX_ULTOSTR_BASE2_COUNT` | +| **`_i64toa`**, **`_i64tow`** | 16
10
8
2 | `_MAX_I64TOSTR_BASE16_COUNT`
`_MAX_I64TOSTR_BASE10_COUNT`
`_MAX_I64TOSTR_BASE8_COUNT`
`_MAX_I64TOSTR_BASE2_COUNT` | +| **`_ui64toa`**, **`_ui64tow`** | 16
10
8
2 | `_MAX_U64TOSTR_BASE16_COUNT`
`_MAX_U64TOSTR_BASE10_COUNT`
`_MAX_U64TOSTR_BASE8_COUNT`
`_MAX_U64TOSTR_BASE2_COUNT` | This example uses a conversion count macro to define a buffer large enough to contain an **`unsigned long long`** in base 2: @@ -143,21 +143,21 @@ int main() ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_itot`**|**`_itoa`**|**`_itoa`**|**`_itow`**| -|**`_ltot`**|**`_ltoa`**|**`_ltoa`**|**`_ltow`**| -|**`_ultot`**|**`_ultoa`**|**`_ultoa`**|**`_ultow`**| -|**`_i64tot`**|**`_i64toa`**|**`_i64toa`**|**`_i64tow`**| -|**`_ui64tot`**|**`_ui64toa`**|**`_ui64toa`**|**`_ui64tow`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_itot` | **`_itoa`** | **`_itoa`** | **`_itow`** | +| `_ltot` | **`_ltoa`** | **`_ltoa`** | **`_ltow`** | +| `_ultot` | **`_ultoa`** | **`_ultoa`** | **`_ultow`** | +| `_i64tot` | **`_i64toa`** | **`_i64toa`** | **`_i64tow`** | +| `_ui64tot` | **`_ui64toa`** | **`_ui64toa`** | **`_ui64tow`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`itoa`**, **`ltoa`**, **`ultoa`**|``| -|**`_itoa`**, **`_ltoa`**, **`_ultoa`**, **`_i64toa`**, **`_ui64toa`**|``| -|**`_itow`**, **`_ltow`**, **`_ultow`**, **`_i64tow`**, **`_ui64tow`**|`` or ``| +| Routine | Required header | +|---|---| +| **`itoa`**, **`ltoa`**, **`ultoa`** | `` | +| **`_itoa`**, **`_ltoa`**, **`_ultoa`**, **`_i64toa`**, **`_ui64toa`** | `` | +| **`_itow`**, **`_ltow`**, **`_ultow`**, **`_i64tow`**, **`_ui64tow`** | `` or `` | These functions and macros are Microsoft-specific. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/itoa-s-itow-s.md b/docs/c-runtime-library/reference/itoa-s-itow-s.md index 71d2fbba7da..0ba71238a6f 100644 --- a/docs/c-runtime-library/reference/itoa-s-itow-s.md +++ b/docs/c-runtime-library/reference/itoa-s-itow-s.md @@ -77,12 +77,12 @@ Zero if successful; an error code on failure. If any of the following conditions ### Error conditions -|value|buffer|size|radix|Return| -|-----------|------------|----------------------|-----------|------------| -|any|`NULL`|any|any|`EINVAL`| -|any|any|<=0|any|`EINVAL`| -|any|any|<= length of the result string required|any|`EINVAL`| -|any|any|any|*`radix`* < 2 or *`radix`* > 36|`EINVAL`| +| value | buffer | size | radix | Return | +|---|---|---|---|---| +| any | `NULL` | any | any | `EINVAL` | +| any | any | <=0 | any | `EINVAL` | +| any | any | <= length of the result string required | any | `EINVAL` | +| any | any | any | *`radix`* < 2 or *`radix`* > 36 | `EINVAL` | ### Security issues @@ -102,20 +102,20 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_itot_s`**|**`_itoa_s`**|**`_itoa_s`**|**`_itow_s`**| -|**`_ltot_s`**|**`_ltoa_s`**|**`_ltoa_s`**|**`_ltow_s`**| -|**`_ultot_s`**|**`_ultoa_s`**|**`_ultoa_s`**|**`_ultow_s`**| -|**`_i64tot_s`**|**`_i64toa_s`**|**`_i64toa_s`**|**`_i64tow_s`**| -|**`_ui64tot_s`**|**`_ui64toa_s`**|**`_ui64toa_s`**|**`_ui64tow_s`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_itot_s` | **`_itoa_s`** | **`_itoa_s`** | **`_itow_s`** | +| `_ltot_s` | **`_ltoa_s`** | **`_ltoa_s`** | **`_ltow_s`** | +| `_ultot_s` | **`_ultoa_s`** | **`_ultoa_s`** | **`_ultow_s`** | +| `_i64tot_s` | **`_i64toa_s`** | **`_i64toa_s`** | **`_i64tow_s`** | +| `_ui64tot_s` | **`_ui64toa_s`** | **`_ui64toa_s`** | **`_ui64tow_s`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_itoa_s`**, **`_ltoa_s`**, **`_ultoa_s`**, **`_i64toa_s`**, **`_ui64toa_s`**|``| -|**`_itow_s`**, **`_ltow_s`**, **`_ultow_s`**, **`_i64tow_s`**, **`_ui64tow_s`**|`` or ``| +| Routine | Required header | +|---|---| +| **`_itoa_s`**, **`_ltoa_s`**, **`_ultoa_s`**, **`_i64toa_s`**, **`_ui64toa_s`** | `` | +| **`_itow_s`**, **`_ltow_s`**, **`_ultow_s`**, **`_i64tow_s`**, **`_ui64tow_s`** | `` or `` | These functions are Microsoft-specific. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/kbhit.md b/docs/c-runtime-library/reference/kbhit.md index 154f8df3f41..da7eed80558 100644 --- a/docs/c-runtime-library/reference/kbhit.md +++ b/docs/c-runtime-library/reference/kbhit.md @@ -36,9 +36,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_kbhit`**|``| +| Routine | Required header | +|---|---| +| **`_kbhit`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ldexp.md b/docs/c-runtime-library/reference/ldexp.md index cca3aa42b08..345eadd4984 100644 --- a/docs/c-runtime-library/reference/ldexp.md +++ b/docs/c-runtime-library/reference/ldexp.md @@ -65,10 +65,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`ldexp`**, **`ldexpf`**, **`ldexpl`**|\|\| -|**`ldexp`** macro | \ || +| Routine | C header | C++ header | +|---|---|---| +| **`ldexp`**, **`ldexpf`**, **`ldexpl`** | \ | \ | +| **`ldexp`** macro | \ | | For compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/lfind-s.md b/docs/c-runtime-library/reference/lfind-s.md index e27d1743383..f8c80b4685a 100644 --- a/docs/c-runtime-library/reference/lfind-s.md +++ b/docs/c-runtime-library/reference/lfind-s.md @@ -55,12 +55,12 @@ If invalid parameters are passed to the function, the invalid parameter handler ### Error conditions -|*`key`*|*`base`*|*`compare`*|*`number`*|*`size`*|`errno`| -|---------|----------|-------------|---------|----------|-----------| -|`NULL`|any|any|any|any|`EINVAL`| -|any|`NULL`|any|!= 0|any|`EINVAL`| -|any|any|any|any|zero|`EINVAL`| -|any|any|`NULL`|an|any|`EINVAL`| +| *`key`* | *`base`* | *`compare`* | *`number`* | *`size`* | `errno` | +|---|---|---|---|---|---| +| `NULL` | any | any | any | any | `EINVAL` | +| any | `NULL` | any | != 0 | any | `EINVAL` | +| any | any | any | any | zero | `EINVAL` | +| any | any | `NULL` | an | any | `EINVAL` | ## Remarks @@ -72,9 +72,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_lfind_s`**|\| +| Routine | Required header | +|---|---| +| **`_lfind_s`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/lfind.md b/docs/c-runtime-library/reference/lfind.md index da759e1738c..973c745d8ac 100644 --- a/docs/c-runtime-library/reference/lfind.md +++ b/docs/c-runtime-library/reference/lfind.md @@ -57,9 +57,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_lfind`**|\| +| Routine | Required header | +|---|---| +| **`_lfind`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/lgamma-lgammaf-lgammal.md b/docs/c-runtime-library/reference/lgamma-lgammaf-lgammal.md index 33981a31418..e39474bc98b 100644 --- a/docs/c-runtime-library/reference/lgamma-lgammaf-lgammal.md +++ b/docs/c-runtime-library/reference/lgamma-lgammaf-lgammal.md @@ -35,14 +35,14 @@ The value to compute. If successful, return the natural logarithm of the absolute value of the gamma function of *`x`*. -|Issue|Return| -|-----------|------------| -|*`x`* = NaN|NaN| -|*`x`* = ±0|+INFINITY| -|*`x`*= negative integer|+INFINITY| -|±INFINITY|+INFINITY| -|pole error|+HUGE_VAL, +HUGE_VALF, or +HUGE_VALL| -|overflow range error|±HUGE_VAL, ±HUGE_VALF, or ±HUGE_VALL| +| Issue | Return | +|---|---| +| *`x`* = NaN | NaN | +| *`x`* = ±0 | +INFINITY | +| *`x`*= negative integer | +INFINITY | +| ±INFINITY | +INFINITY | +| pole error | +`HUGE_VAL`, +`HUGE_VALF`, or +`HUGE_VALL` | +| overflow range error | ±`HUGE_VAL`, ±`HUGE_VALF`, or ±`HUGE_VALL` | Errors are reported as specified in [`_matherr`](matherr.md). @@ -58,10 +58,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`lgamma`**, **`lgammaf`**, **`lgammal`**|\|\| -|**`lgamma`** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`lgamma`**, **`lgammaf`**, **`lgammal`** | \ | \ | +| **`lgamma`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/localeconv.md b/docs/c-runtime-library/reference/localeconv.md index c4b072cd878..020c08b31d2 100644 --- a/docs/c-runtime-library/reference/localeconv.md +++ b/docs/c-runtime-library/reference/localeconv.md @@ -95,9 +95,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`localeconv`**|\| +| Routine | Required header | +|---|---| +| **`localeconv`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/localtime-localtime32-localtime64.md b/docs/c-runtime-library/reference/localtime-localtime32-localtime64.md index 1523730b5a8..74d34be8850 100644 --- a/docs/c-runtime-library/reference/localtime-localtime32-localtime64.md +++ b/docs/c-runtime-library/reference/localtime-localtime32-localtime64.md @@ -43,17 +43,17 @@ Return a pointer to the structure result, or `NULL` if the date passed to the fu The fields of the structure type [`tm`](../standard-types.md) store the following values, each of which is an **`int`**: -|Field|Description| -|-|-| -|**`tm_sec`**|Seconds after minute (0 - 59).| -|**`tm_min`**|Minutes after hour (0 - 59).| -|**`tm_hour`**|Hours since midnight (0 - 23).| -|**`tm_mday`**|Day of month (1 - 31).| -|**`tm_mon`**|Month (0 - 11; January = 0).| -|**`tm_year`**|Year (current year minus 1900).| -|**`tm_wday`**|Day of week (0 - 6; Sunday = 0).| -|**`tm_yday`**|Day of year (0 - 365; January 1 = 0).| -|**`tm_isdst`**|Positive value if daylight saving time is in effect; 0 if daylight saving time isn't in effect; negative value if status of daylight saving time is unknown.| +| Field | Description | +|---|---| +| **`tm_sec`** | Seconds after minute (0 - 59). | +| **`tm_min`** | Minutes after hour (0 - 59). | +| **`tm_hour`** | Hours since midnight (0 - 23). | +| **`tm_mday`** | Day of month (1 - 31). | +| **`tm_mon`** | Month (0 - 11; January = 0). | +| **`tm_year`** | Year (current year minus 1900). | +| **`tm_wday`** | Day of week (0 - 6; Sunday = 0). | +| **`tm_yday`** | Day of year (0 - 365; January 1 = 0). | +| **`tm_isdst`** | Positive value if daylight saving time is in effect; 0 if daylight saving time isn't in effect; negative value if status of daylight saving time is unknown. | If the **`TZ`** environment variable is set, the C run-time library assumes rules appropriate to the United States for implementing the calculation of daylight-saving time (DST). @@ -74,9 +74,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required C header|Required C++ header| -|-------------|---------------------|-| -|**`localtime`**, **`_localtime32`**, **`_localtime64`**|``|`` or ``| +| Routine | Required C header | Required C++ header | +|---|---|---| +| **`localtime`**, **`_localtime32`**, **`_localtime64`** | `` | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/localtime-s-localtime32-s-localtime64-s.md b/docs/c-runtime-library/reference/localtime-s-localtime32-s-localtime64-s.md index 23fa1dd389d..ef94bc01f5b 100644 --- a/docs/c-runtime-library/reference/localtime-s-localtime32-s-localtime64-s.md +++ b/docs/c-runtime-library/reference/localtime-s-localtime32-s-localtime64-s.md @@ -45,11 +45,11 @@ Zero if successful. The return value is an error code if there's a failure. Erro ### Error conditions -|*`tmDest`*|*`sourceTime`*|Return value|Value in *`tmDest`*|Invokes invalid parameter handler| -|-----------|------------|------------------|--------------------|---------------------------------------| -|`NULL`|any|`EINVAL`|Not modified|Yes| -|Not `NULL` (points to valid memory)|`NULL`|`EINVAL`|All fields set to -1|Yes| -|Not `NULL` (points to valid memory)|less than 0 or greater than `_MAX__TIME64_T`|`EINVAL`|All fields set to -1|No| +| *`tmDest`* | *`sourceTime`* | Return value | Value in *`tmDest`* | Invokes invalid parameter handler | +|---|---|---|---|---| +| `NULL` | any | `EINVAL` | Not modified | Yes | +| Not `NULL` (points to valid memory) | `NULL` | `EINVAL` | All fields set to -1 | Yes | +| Not `NULL` (points to valid memory) | less than 0 or greater than `_MAX__TIME64_T` | `EINVAL` | All fields set to -1 | No | The first two error conditions invoke the invalid parameter handler, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions set `errno` to `EINVAL` and return `EINVAL`. @@ -68,17 +68,17 @@ The **`localtime_s`** function converts a time stored as a [`time_t`](../standar The fields of the structure type [`tm`](../standard-types.md) store the following values, each of which is an **`int`**. -|Field|Description| -|-|-| -|**`tm_sec`**|Seconds after minute (0 - 59).| -|**`tm_min`**|Minutes after hour (0 - 59).| -|**`tm_hour`**|Hours since midnight (0 - 23).| -|**`tm_mday`**|Day of month (1 - 31).| -|**`tm_mon`**|Month (0 - 11; January = 0).| -|**`tm_year`**|Year (current year minus 1900).| -|**`tm_wday`**|Day of week (0 - 6; Sunday = 0).| -|**`tm_yday`**|Day of year (0 - 365; January 1 = 0).| -|**`tm_isdst`**|Positive value if daylight saving time is in effect; 0 if daylight saving time isn't in effect; negative value if status of daylight saving time is unknown.| +| Field | Description | +|---|---| +| **`tm_sec`** | Seconds after minute (0 - 59). | +| **`tm_min`** | Minutes after hour (0 - 59). | +| **`tm_hour`** | Hours since midnight (0 - 23). | +| **`tm_mday`** | Day of month (1 - 31). | +| **`tm_mon`** | Month (0 - 11; January = 0). | +| **`tm_year`** | Year (current year minus 1900). | +| **`tm_wday`** | Day of week (0 - 6; Sunday = 0). | +| **`tm_yday`** | Day of year (0 - 365; January 1 = 0). | +| **`tm_isdst`** | Positive value if daylight saving time is in effect; 0 if daylight saving time isn't in effect; negative value if status of daylight saving time is unknown. | If the **`TZ`** environment variable is set, the C run-time library assumes rules appropriate to the United States for implementing the calculation of daylight saving time (DST). @@ -86,9 +86,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required C header|Required C++ header| -|-------------|---------------------|-| -|**`localtime_s`**, **`_localtime32_s`**, **`_localtime64_s`**|``|`` or ``| +| Routine | Required C header | Required C++ header | +|---|---|---| +| **`localtime_s`**, **`_localtime32_s`**, **`_localtime64_s`** | `` | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/lock-file.md b/docs/c-runtime-library/reference/lock-file.md index fc41b6170e7..fc105a56f3e 100644 --- a/docs/c-runtime-library/reference/lock-file.md +++ b/docs/c-runtime-library/reference/lock-file.md @@ -33,9 +33,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_lock_file`**|\| +| Routine | Required header | +|---|---| +| **`_lock_file`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/locking.md b/docs/c-runtime-library/reference/locking.md index e83e1a09dbb..52261581544 100644 --- a/docs/c-runtime-library/reference/locking.md +++ b/docs/c-runtime-library/reference/locking.md @@ -39,8 +39,8 @@ Number of bytes to lock. **`_locking`** returns 0 if successful. A return value of -1 indicates failure, in which case [`errno`](../errno-doserrno-sys-errlist-and-sys-nerr.md) is set to one of the following values. -|errno value|Condition| -|-|-| +| `errno` value | Condition | +|---|---| | `EACCES` | Locking violation (file already locked or unlocked). | | `EBADF` | Invalid file descriptor. | | `EDEADLOCK` | Locking violation. Returned when the `_LK_LOCK` or `_LK_RLCK` flag is specified and the file can't be locked after 10 attempts. | @@ -54,8 +54,8 @@ The **`_locking`** function locks or unlocks *`nbytes`* bytes of the file specif *`mode`* must be one of the following manifest constants, which are defined in Locking.h. -|*`mode`* value|Effect| -|-|-| +| *`mode`* value | Effect | +|---|---| | `_LK_LOCK` | Locks the specified bytes. If the bytes can't be locked, the program immediately tries again after 1 second. If the bytes can't be locked after 10 attempts, the constant returns an error. | | `_LK_NBLCK` | Locks the specified bytes. If the bytes can't be locked, the constant returns an error. | | `_LK_NBRLCK` | Same as `_LK_NBLCK`. | @@ -68,9 +68,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_locking`**|\ and \|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_locking`** | \ and \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/log-logf-log10-log10f.md b/docs/c-runtime-library/reference/log-logf-log10-log10f.md index d82b6f9ee59..385c378a044 100644 --- a/docs/c-runtime-library/reference/log-logf-log10-log10f.md +++ b/docs/c-runtime-library/reference/log-logf-log10-log10f.md @@ -40,11 +40,11 @@ Value whose logarithm is to be found. The **`log`** functions return the natural logarithm (base *`e`*) of *`x`* if successful. The **`log10`** functions return the base-10 logarithm. If *`x`* is negative, these functions return an indefinite (`IND`), by default. If *`x`* is 0, they return infinity (`INF`). -|Input|SEH Exception|`Matherr` Exception| -|-----------|-------------------|-----------------------| -|± QNAN, IND|none|`_DOMAIN`| -|± 0|`ZERODIVIDE`|`_SING`| -|*`x < 0`*|`INVALID`|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | `_DOMAIN` | +| ± 0 | `ZERODIVIDE` | `_SING` | +| *`x < 0`* | `INVALID` | `_DOMAIN` | **`log`** and **`log10`** have an implementation that uses Streaming SIMD Extensions 2 (SSE2). See [`_set_SSE2_enable`](set-sse2-enable.md) for information and restrictions on using the SSE2 implementation. @@ -58,10 +58,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`log`**, **`logf`**, **`logl`**, **`log10`**, **`log10f`**, **`log10l`**|``| -|**`log`** macro | `` | +| Routine | Required header | +|---|---| +| **`log`**, **`logf`**, **`logl`**, **`log10`**, **`log10f`**, **`log10l`** | `` | +| **`log`** macro | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/log1p-log1pf-log1pl2.md b/docs/c-runtime-library/reference/log1p-log1pf-log1pl2.md index 44e79eff8d3..44c488ab549 100644 --- a/docs/c-runtime-library/reference/log1p-log1pf-log1pl2.md +++ b/docs/c-runtime-library/reference/log1p-log1pf-log1pl2.md @@ -49,16 +49,16 @@ If successful, returns the natural (base-*e*) log of (*`x`* + 1). Otherwise, may return one of the following values: -|Input|Result|SEH exception|errno| -|-----------|------------|-------------------|-----------| -|+INF|+INF||| -|Denormals|Same as input|UNDERFLOW|| -|±0|Same as input||| -|-1|-INF|DIVBYZERO|ERANGE| -|< -1|NaN|INVALID|EDOM| -|-INF|NaN|INVALID|EDOM| -|±SNaN|Same as input|INVALID|| -|±QNaN, indefinite|Same as input||| +| Input | Result | SEH exception | errno | +|---|---|---|---| +| +INF | +INF | | | +| Denormals | Same as input | `UNDERFLOW` | | +| ±0 | Same as input | | | +| -1 | -INF | `DIVBYZERO` | `ERANGE` | +| < -1 | NaN | `INVALID` | `EDOM` | +| -INF | NaN | `INVALID` | `EDOM` | +| ±SNaN | Same as input | `INVALID` | | +| ±QNaN, indefinite | Same as input | | | The `errno` value is set to ERANGE if *`x`* = -1. The `errno` value is set to `EDOM` if *`x`* < -1. @@ -76,10 +76,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`log1p`**, **`log1pf`**, **`log1pl`**|\|\| -|**`log1p`** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`log1p`**, **`log1pf`**, **`log1pl`** | \ | \ | +| **`log1p`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/log2-log2f-log2l.md b/docs/c-runtime-library/reference/log2-log2f-log2l.md index a61b2253a38..1abc15d9ea2 100644 --- a/docs/c-runtime-library/reference/log2-log2f-log2l.md +++ b/docs/c-runtime-library/reference/log2-log2f-log2l.md @@ -49,15 +49,15 @@ On success, the functions return the base-2 log of *`x`*. Otherwise, the functions may return one of the following values: -|Issue|Return| -|-----------|------------| -|*`x`* < 0|NaN| -|*`x`* = ±0|-INFINITY| -|*`x`* = 1|+0| -|+INFINITY|+INFINITY| -|NaN|NaN| -|domain error|NaN| -|pole error|-HUGE_VAL, -HUGE_VALF, or -HUGE_VALL| +| Issue | Return | +|---|---| +| *`x`* < 0 | NaN | +| *`x`* = ±0 | -INFINITY | +| *`x`* = 1 | +0 | +| +INFINITY | +INFINITY | +| NaN | NaN | +| domain error | NaN | +| pole error | -`HUGE_VAL`, -`HUGE_VALF`, or -`HUGE_VALL` | Errors are reported as specified in [`_matherr`](matherr.md). @@ -69,10 +69,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`log2`**, **`log2f`**, **`log2l`**|\|\| -|**`log2`** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`log2`**, **`log2f`**, **`log2l`** | \ | \ | +| **`log2`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/logb-logbf-logbl-logb-logbf.md b/docs/c-runtime-library/reference/logb-logbf-logbl-logb-logbf.md index f614efee317..c40c6c21666 100644 --- a/docs/c-runtime-library/reference/logb-logbf-logbl-logb-logbf.md +++ b/docs/c-runtime-library/reference/logb-logbf-logbl-logb-logbf.md @@ -57,20 +57,20 @@ Because C++ allows overloading, you can call overloads of **`logb`** that take a If you use the `logb` macro from ``, the type of the argument determines which version of the function is selected. See [Type-generic math](../tgmath.md) for details. -|Input|SEH exception|`Matherr` exception| -|-----------|-------------------|-----------------------| -|`± QNAN`,`IND`|None|`_DOMAIN`| -|± 0|`ZERODIVIDE`|`_SING`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | None | `_DOMAIN` | +| ± 0 | `ZERODIVIDE` | `_SING` | 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). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_logb`**|``| -|**`logb`**, **`logbf`**, **`logbl`**, **`_logbf`**|``| -|**`logb`** macro | `` | +| Routine | Required header | +|---|---| +| **`_logb`** | `` | +| **`logb`**, **`logbf`**, **`logbl`**, **`_logbf`** | `` | +| **`logb`** macro | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/longjmp.md b/docs/c-runtime-library/reference/longjmp.md index 536a759ebcc..bdcacbcff65 100644 --- a/docs/c-runtime-library/reference/longjmp.md +++ b/docs/c-runtime-library/reference/longjmp.md @@ -63,9 +63,9 @@ For more information, see [Using setjmp and longjmp](../../cpp/using-setjmp-long ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`longjmp`**|\| +| Routine | Required header | +|---|---| +| **`longjmp`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md b/docs/c-runtime-library/reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md index 660928058b6..73844120b91 100644 --- a/docs/c-runtime-library/reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md +++ b/docs/c-runtime-library/reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md @@ -69,9 +69,9 @@ The value to round. If successful, returns the rounded integral value of *`x`*. -|Issue|Return| -|-----------|------------| -|*`x`* is outside the range of the return type

*`x`* = ±∞

*`x`* = NaN|Raises `FE_INVALID` and returns zero (0).| +| Issue | Return | +|---|---| +| *`x`* is outside the range of the return type

*`x`* = ±INF

*`x`* = NaN | Raises `FE_INVALID` and returns zero (0). | ## Remarks @@ -87,10 +87,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`lrint`**, **`lrintf`**, **`lrintl`**, **`llrint`**, **`llrintf`**, **`llrintl`**|\|\| -|**`lrint`** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`lrint`**, **`lrintf`**, **`lrintl`**, **`llrint`**, **`llrintf`**, **`llrintl`** | \ | \ | +| **`lrint`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/lrotl-lrotr.md b/docs/c-runtime-library/reference/lrotl-lrotr.md index e12210de0f1..1cef2be7037 100644 --- a/docs/c-runtime-library/reference/lrotl-lrotr.md +++ b/docs/c-runtime-library/reference/lrotl-lrotr.md @@ -39,9 +39,9 @@ The **`_lrotl`** and **`_lrotr`** functions rotate *`value`* by *`shift`* bits. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_lrotl`**, **`_lrotr`**|\| +| Routine | Required header | +|---|---| +| **`_lrotl`**, **`_lrotr`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md b/docs/c-runtime-library/reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md index 9d5b8ca9909..1cdf9e4e71f 100644 --- a/docs/c-runtime-library/reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md +++ b/docs/c-runtime-library/reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md @@ -59,9 +59,9 @@ The floating-point value to round. The **`lround`** and **`llround`** functions return the nearest **`long`** or **`long long`** integer to *`x`*. Halfway values are rounded away from zero, regardless of the setting of the floating-point rounding mode. There's no error return. -|Input|SEH Exception|`Matherr` Exception| -|-----------|-------------------|-----------------------| -|± `QNAN`, `IND`|none|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | `_DOMAIN` | ## Remarks @@ -73,10 +73,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`lround`**, **`lroundf`**, **`lroundl`**, **`llround`**, **`llroundf`**, **`llroundl`**|\| -|**`lround`** macro | \ | +| Routine | Required header | +|---|---| +| **`lround`**, **`lroundf`**, **`lroundl`**, **`llround`**, **`llroundf`**, **`llroundl`** | \ | +| **`lround`** macro | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/lsearch-s.md b/docs/c-runtime-library/reference/lsearch-s.md index 90a021ee597..74510849d2a 100644 --- a/docs/c-runtime-library/reference/lsearch-s.md +++ b/docs/c-runtime-library/reference/lsearch-s.md @@ -55,12 +55,12 @@ If invalid parameters are passed to the function, the invalid parameter handler ### Error conditions -|*`key`*|*`base`*|*`compare`*|*`number`*|*`size`*|`errno`| -|-----------|------------|---------------|-----------|------------|-------------| -|`NULL`|any|any|any|any|`EINVAL`| -|any|`NULL`|any|!= 0|any|`EINVAL`| -|any|any|any|any|zero|`EINVAL`| -|any|any|`NULL`|an|any|`EINVAL`| +| *`key`* | *`base`* | *`compare`* | *`number`* | *`size`* | `errno` | +|---|---|---|---|---|---| +| `NULL` | any | any | any | any | `EINVAL` | +| any | `NULL` | any | != 0 | any | `EINVAL` | +| any | any | any | any | zero | `EINVAL` | +| any | any | `NULL` | an | any | `EINVAL` | ## Remarks @@ -74,9 +74,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_lsearch_s`**|\| +| Routine | Required header | +|---|---| +| **`_lsearch_s`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/lsearch.md b/docs/c-runtime-library/reference/lsearch.md index ed81df15be4..04f6882641d 100644 --- a/docs/c-runtime-library/reference/lsearch.md +++ b/docs/c-runtime-library/reference/lsearch.md @@ -59,9 +59,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_lsearch`**|\| +| Routine | Required header | +|---|---| +| **`_lsearch`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/lseek-lseeki64.md b/docs/c-runtime-library/reference/lseek-lseeki64.md index 10a7ce705a7..23a8e17a34c 100644 --- a/docs/c-runtime-library/reference/lseek-lseeki64.md +++ b/docs/c-runtime-library/reference/lseek-lseeki64.md @@ -50,8 +50,8 @@ For more information about these and other error codes, see [`errno`, `_doserrno The **`_lseek`** function moves the file pointer associated with *`fd`* to a new location that is *`offset`* bytes from *`origin`*. The next operation on the file occurs at the new location. The *`origin`* argument must be one of the following constants, which are defined in Stdio.h. -|*`origin`* value| Description | -|-|-| +| *`origin`* value | Description | +|---|---| | `SEEK_SET` | Beginning of the file. | | `SEEK_CUR` | Current position of the file pointer. | | `SEEK_END` | End of file. | @@ -62,10 +62,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_lseek`**|\| -|**`_lseeki64`**|\| +| Routine | Required header | +|---|---| +| **`_lseek`** | \ | +| **`_lseeki64`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/makepath-s-wmakepath-s.md b/docs/c-runtime-library/reference/makepath-s-wmakepath-s.md index c93fa490c99..69954a77bb9 100644 --- a/docs/c-runtime-library/reference/makepath-s-wmakepath-s.md +++ b/docs/c-runtime-library/reference/makepath-s-wmakepath-s.md @@ -80,10 +80,10 @@ Zero if successful; an error code on failure. ### Error conditions -|*`path`*|*`sizeInWords`* / *`sizeInBytes`*|Return|Contents of *`path`*| -|------------|------------------------------------|------------|------------------------| -|`NULL`|any|`EINVAL`|not modified| -|any|<= 0|`EINVAL`|not modified| +| *`path`* | *`sizeInWords`* / *`sizeInBytes`* | Return | Contents of *`path`* | +|---|---|---|---| +| `NULL` | any | `EINVAL` | not modified | +| any | <= 0 | `EINVAL` | not modified | If any of the above error conditions occurs, these functions invoke the invalid parameter handler, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `errno` is set to `EINVAL` and the functions returns `EINVAL`. `NULL` is allowed for the parameters *`drive`*, *`fname`*, and *`ext`*. For information about the behavior when these parameters are null pointers or empty strings, see the Remarks section. @@ -95,9 +95,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tmakepath_s`|**`_makepath_s`**|**`_makepath_s`**|**`_wmakepath_s`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tmakepath_s` | **`_makepath_s`** | **`_makepath_s`** | **`_wmakepath_s`** | The *`path`* argument must point to an empty buffer large enough to hold the complete path. The composite *`path`* must be no larger than the `_MAX_PATH` constant, defined in Stdlib.h. @@ -109,10 +109,10 @@ The debug library versions of these functions first fill the buffer with 0xFE. T ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_makepath_s`**|\| -|**`_wmakepath_s`**|\ or \| +| Routine | Required header | +|---|---| +| **`_makepath_s`** | \ | +| **`_wmakepath_s`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/makepath-wmakepath.md b/docs/c-runtime-library/reference/makepath-wmakepath.md index 340ef73d0f9..6b7ca42ae06 100644 --- a/docs/c-runtime-library/reference/makepath-wmakepath.md +++ b/docs/c-runtime-library/reference/makepath-wmakepath.md @@ -60,9 +60,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tmakepath`|**`_makepath`**|**`_makepath`**|**`_wmakepath`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tmakepath` | **`_makepath`** | **`_makepath`** | **`_wmakepath`** | The *`path`* argument must point to an empty buffer large enough to hold the complete path. The composite *`path`* must be no larger than the `_MAX_PATH` constant, defined in Stdlib.h. @@ -70,10 +70,10 @@ If path is `NULL`, the invalid parameter handler is invoked, as described in [Pa ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_makepath`**|\| -|**`_wmakepath`**|\ or \| +| Routine | Required header | +|---|---| +| **`_makepath`** | \ | +| **`_wmakepath`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/malloc-dbg.md b/docs/c-runtime-library/reference/malloc-dbg.md index 0c9876472c3..be297575b40 100644 --- a/docs/c-runtime-library/reference/malloc-dbg.md +++ b/docs/c-runtime-library/reference/malloc-dbg.md @@ -57,9 +57,9 @@ For information about how memory blocks are allocated, initialized, and managed ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_malloc_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_malloc_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/malloc.md b/docs/c-runtime-library/reference/malloc.md index c6c391ce6f1..9fa5e337448 100644 --- a/docs/c-runtime-library/reference/malloc.md +++ b/docs/c-runtime-library/reference/malloc.md @@ -98,9 +98,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`malloc`**|`` and ``| +| Routine | Required header | +|---|---| +| **`malloc`** | `` and `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/malloca.md b/docs/c-runtime-library/reference/malloca.md index 63db4237c9b..9953a916579 100644 --- a/docs/c-runtime-library/reference/malloca.md +++ b/docs/c-runtime-library/reference/malloca.md @@ -53,9 +53,9 @@ In addition to the above restrictions, when using the [`/clr` (Common Language R ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_malloca`**|``| +| Routine | Required header | +|---|---| +| **`_malloca`** | `` | ## Example: `_malloca` diff --git a/docs/c-runtime-library/reference/matherr.md b/docs/c-runtime-library/reference/matherr.md index e43e2d818f2..78e0ea89b47 100644 --- a/docs/c-runtime-library/reference/matherr.md +++ b/docs/c-runtime-library/reference/matherr.md @@ -54,8 +54,8 @@ struct _exception The **`type`** member specifies the type of math error. It's one of the following values, defined in ``: -|Macro|Meaning| -|-|-| +| Macro | Description | +|---|---| | `_DOMAIN` | Argument domain error | | `_SING` | Argument singularity | | `_OVERFLOW` | Overflow range error | @@ -69,9 +69,9 @@ The default return value for the given error is **`retval`**. If you change the ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_matherr`**|``| +| Routine | Required header | +|---|---| +| **`_matherr`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/max.md b/docs/c-runtime-library/reference/max.md index bac54c43f73..c29fbe00f2d 100644 --- a/docs/c-runtime-library/reference/max.md +++ b/docs/c-runtime-library/reference/max.md @@ -37,9 +37,9 @@ The argument returned is evaluated twice by the macro. Double evaluation can lea ## Requirements -|Macro|Required header| -|-------------|---------------------| -|**`__max`**|\| +| Macro | Required header | +|---|---| +| **`__max`** | \ | ## Example diff --git a/docs/c-runtime-library/reference/mbbtombc-mbbtombc-l.md b/docs/c-runtime-library/reference/mbbtombc-mbbtombc-l.md index 0d5eaecfa6c..a24dc7a9971 100644 --- a/docs/c-runtime-library/reference/mbbtombc-mbbtombc-l.md +++ b/docs/c-runtime-library/reference/mbbtombc-mbbtombc-l.md @@ -53,10 +53,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbbtombc`**|\| -|**`_mbbtombc_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbbtombc`** | \ | +| **`_mbbtombc_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbbtype-mbbtype-l.md b/docs/c-runtime-library/reference/mbbtype-mbbtype-l.md index 6aed9b3099d..5c79bc9673f 100644 --- a/docs/c-runtime-library/reference/mbbtype-mbbtype-l.md +++ b/docs/c-runtime-library/reference/mbbtype-mbbtype-l.md @@ -46,13 +46,13 @@ The locale to use. **`_mbbtype`** returns the type of byte in a string. This decision is context-sensitive, as specified by the value of *`type`*, which provides the control test condition. *`type`* is the type of the previous byte in the string. The manifest constants in the following table are defined in Mbctype.h. -|Value of *`type`*|**`_mbbtype`** tests for|Return value|*`c`*| -|---------------------|--------------------------|------------------|---------| -|Any value except 1|Valid single byte or lead byte|`_MBC_SINGLE` (0)|Single byte (0x20 - 0x7E, 0xA1 - 0xDF)| -|Any value except 1|Valid single byte or lead byte|`_MBC_LEAD` (1)|Lead byte of multibyte character (0x81 - 0x9F, 0xE0 - 0xFC)| -|Any value except 1|Valid single-byte or lead byte|`_MBC_ILLEGAL`

(-1)|Invalid character (any value except 0x20 - 0x7E, 0xA1 - 0xDF, 0x81 - 0x9F, 0xE0 - 0xFC| -|1|Valid trail byte|`_MBC_TRAIL` (2)|Trailing byte of multibyte character (0x40 - 0x7E, 0x80 - 0xFC)| -|1|Valid trail byte|`_MBC_ILLEGAL`

(-1)|Invalid character (any value except 0x20 - 0x7E, 0xA1 - 0xDF, 0x81 - 0x9F, 0xE0 - 0xFC| +| Value of *`type`* | **`_mbbtype`** tests for | Return value | *`c`* | +|---|---|---|---| +| Any value except 1 | Valid single byte or lead byte | `_MBC_SINGLE` (0) | Single byte (0x20 - 0x7E, 0xA1 - 0xDF) | +| Any value except 1 | Valid single byte or lead byte | `_MBC_LEAD` (1) | Lead byte of multibyte character (0x81 - 0x9F, 0xE0 - 0xFC) | +| Any value except 1 | Valid single-byte or lead byte | `_MBC_ILLEGAL`

(-1) | Invalid character (any value except 0x20 - 0x7E, 0xA1 - 0xDF, 0x81 - 0x9F, 0xE0 - 0xFC | +| 1 | Valid trail byte | `_MBC_TRAIL` (2) | Trailing byte of multibyte character (0x40 - 0x7E, 0x80 - 0xFC) | +| 1 | Valid trail byte | `_MBC_ILLEGAL`

(-1) | Invalid character (any value except 0x20 - 0x7E, 0xA1 - 0xDF, 0x81 - 0x9F, 0xE0 - 0xFC | ## Remarks @@ -66,10 +66,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_mbbtype`**|\|\*| -|**`_mbbtype_l`**|\|\*| +| Routine | Required header | Optional header | +|---|---|---| +| **`_mbbtype`** | \ | \* | +| **`_mbbtype_l`** | \ | \* | \* For definitions of manifest constants that are used as return values. diff --git a/docs/c-runtime-library/reference/mbccpy-mbccpy-l.md b/docs/c-runtime-library/reference/mbccpy-mbccpy-l.md index 9458f200cc6..0daa70325e0 100644 --- a/docs/c-runtime-library/reference/mbccpy-mbccpy-l.md +++ b/docs/c-runtime-library/reference/mbccpy-mbccpy-l.md @@ -56,17 +56,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tccpy`|Maps to macro or inline function|**`_mbccpy`**|Maps to macro or inline function| -|`_tccpy_l`|n/a|**`_mbccpy_l`**|n/a| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tccpy` | Maps to macro or inline function | **`_mbccpy`** | Maps to macro or inline function | +| `_tccpy_l` | n/a | **`_mbccpy_l`** | n/a | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbccpy`**|\| -|**`_mbccpy_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbccpy`** | \ | +| **`_mbccpy_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbccpy-s-mbccpy-s-l.md b/docs/c-runtime-library/reference/mbccpy-s-mbccpy-s-l.md index 28b55e8108a..23610cba706 100644 --- a/docs/c-runtime-library/reference/mbccpy-s-mbccpy-s-l.md +++ b/docs/c-runtime-library/reference/mbccpy-s-mbccpy-s-l.md @@ -77,12 +77,12 @@ The **`_mbccpy_s`** function copies one multibyte character from *`src`* to *`de The value in *`pCopied`* is filled with the number of bytes copied. Possible values are 1 and 2 if the operation is successful. If `NULL` is passed in, this parameter is ignored. -|*`src`*|copied to *`dest`*|*`pCopied`*|Return value| -|-----------|----------------------|---------------|------------------| -|non-lead-byte|non-lead-byte|1|0| -|0|0|1|0| -|lead-byte followed by non-0|lead-byte followed by non-0|2|0| -|lead-byte followed by 0|0|1|`EILSEQ`| +| *`src`* | copied to *`dest`* | *`pCopied`* | Return value | +|---|---|---|---| +| non-lead-byte | non-lead-byte | 1 | 0 | +| 0 | 0 | 1 | 0 | +| lead-byte followed by non-0 | lead-byte followed by non-0 | 2 | 0 | +| lead-byte followed by 0 | 0 | 1 | `EILSEQ` | The second row is just a special case of the first row. The table assumes *`buffSizeInBytes`* >= *`pCopied`*. @@ -94,16 +94,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tccpy_s`|Maps to macro or inline function.|**`_mbccpy_s`**|Maps to macro or inline function.| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tccpy_s` | Maps to macro or inline function. | **`_mbccpy_s`** | Maps to macro or inline function. | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbccpy_s`**|\| -|**`_mbccpy_s_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbccpy_s`** | \ | +| **`_mbccpy_s_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbcjistojms-mbcjistojms-l-mbcjmstojis-mbcjmstojis-l.md b/docs/c-runtime-library/reference/mbcjistojms-mbcjistojms-l-mbcjmstojis-mbcjmstojis-l.md index bba28d1af29..4da143b17cb 100644 --- a/docs/c-runtime-library/reference/mbcjistojms-mbcjistojms-l-mbcjmstojis-mbcjmstojis-l.md +++ b/docs/c-runtime-library/reference/mbcjistojms-mbcjistojms-l-mbcjmstojis-mbcjmstojis-l.md @@ -64,12 +64,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbcjistojms`**|\| -|**`_mbcjistojms_l`**|\| -|**`_mbcjmstojis`**|\| -|**`_mbcjmstojis_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbcjistojms`** | \ | +| **`_mbcjistojms_l`** | \ | +| **`_mbcjmstojis`** | \ | +| **`_mbcjmstojis_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbclen-mblen-mblen-l.md b/docs/c-runtime-library/reference/mbclen-mblen-mblen-l.md index 7b4cce64440..69741ca40ce 100644 --- a/docs/c-runtime-library/reference/mbclen-mblen-mblen-l.md +++ b/docs/c-runtime-library/reference/mbclen-mblen-mblen-l.md @@ -72,17 +72,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tclen`|Maps to macro or inline function|**`_mbclen`**|Maps to macro or inline function| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tclen` | Maps to macro or inline function | **`_mbclen`** | Maps to macro or inline function | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbclen`**|\| -|**`mblen`**|\| -|**`_mblen_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbclen`** | \ | +| **`mblen`** | \ | +| **`_mblen_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbctohira-mbctohira-l-mbctokata-mbctokata-l.md b/docs/c-runtime-library/reference/mbctohira-mbctohira-l-mbctokata-mbctokata-l.md index 827cc0cddac..0166474d3ee 100644 --- a/docs/c-runtime-library/reference/mbctohira-mbctohira-l-mbctokata-mbctokata-l.md +++ b/docs/c-runtime-library/reference/mbctohira-mbctohira-l-mbctokata-mbctokata-l.md @@ -52,10 +52,10 @@ Each of these functions returns the converted character *`c`*, if possible. Othe The **`_mbctohira`** and **`_mbctokata`** functions test a character *`c`* and, if possible, apply one of the following conversions. -|Routines|Converts| -|--------------|--------------| -|**`_mbctohira`**, **`_mbctohira_l`**|Multibyte katakana to multibyte hiragana.| -|**`_mbctokata`**, **`_mbctokata_l`**|Multibyte hiragana to multibyte katakana.| +| Routines | Converts | +|---|---| +| **`_mbctohira`**, **`_mbctohira_l`** | Multibyte katakana to multibyte hiragana. | +| **`_mbctokata`**, **`_mbctokata_l`** | Multibyte hiragana to multibyte katakana. | The output value is affected by the setting of the `LC_CTYPE` category setting of the locale. For more information, see [`setlocale`](setlocale-wsetlocale.md). The versions of these functions are identical, except that the ones that don't have the `_l` suffix use the current locale for this locale-dependent behavior and the ones that do have the `_l` suffix instead use the locale parameter that's passed in. For more information, see [Locale](../locale.md). @@ -65,12 +65,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbctohira`**|\| -|**`_mbctohira_l`**|\| -|**`_mbctokata`**|\| -|**`_mbctokata_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbctohira`** | \ | +| **`_mbctohira_l`** | \ | +| **`_mbctokata`** | \ | +| **`_mbctokata_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbctolower-mbctolower-l-mbctoupper-mbctoupper-l.md b/docs/c-runtime-library/reference/mbctolower-mbctolower-l-mbctoupper-mbctoupper-l.md index a8e62436177..85b07df89a5 100644 --- a/docs/c-runtime-library/reference/mbctolower-mbctolower-l-mbctoupper-mbctoupper-l.md +++ b/docs/c-runtime-library/reference/mbctolower-mbctolower-l-mbctoupper-mbctoupper-l.md @@ -52,10 +52,10 @@ Each of these functions returns the converted character *`c`*, if possible. Othe The functions test a character *`c`* and, if possible, apply one of the following conversions. -|Routines|Converts| -|--------------|--------------| -|**`_mbctolower`**, **`_mbctolower_l`**|Uppercase character to lowercase character.| -|**`_mbctoupper`**, **`_mbctoupper_l`**|Lowercase character to uppercase character.| +| Routines | Converts | +|---|---| +| **`_mbctolower`**, **`_mbctolower_l`** | Uppercase character to lowercase character. | +| **`_mbctoupper`**, **`_mbctoupper_l`** | Lowercase character to uppercase character. | The output value is affected by the setting of the `LC_CTYPE` category setting of the locale. For more information, see [`setlocale`](setlocale-wsetlocale.md). The version of this function without the `_l` suffix uses the current locale for this locale-dependent behavior; the version with the `_l` suffix is identical except that it uses the locale parameter passed in instead. For more information, see [Locale](../locale.md). @@ -65,19 +65,19 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_totlower`|`tolower`|**`_mbctolower`**|`towlower`| -|`_totlower_l`|`_tolower_l`|**`_mbctolower_l`**|`_towlower_t`| -|`_totupper`|`toupper`|**`_mbctoupper`**|`towupper`| -|`_totupper_l`|`toupper_l`|**`_mbctoupper_l`**|`_towupper_l`| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_totlower` | `tolower` | **`_mbctolower`** | `towlower` | +| `_totlower_l` | `_tolower_l` | **`_mbctolower_l`** | `_towlower_t` | +| `_totupper` | `toupper` | **`_mbctoupper`** | `towupper` | +| `_totupper_l` | `toupper_l` | **`_mbctoupper_l`** | `_towupper_l` | ## Requirements -|Routines|Required header| -|--------------|---------------------| -|**`_mbctolower`**, **`_mbctolower_l`**|\| -|**`_mbctoupper`**, **`_mbctoupper_l`**|\| +| Routines | Required header | +|---|---| +| **`_mbctolower`**, **`_mbctolower_l`** | \ | +| **`_mbctoupper`**, **`_mbctoupper_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbctombb-mbctombb-l.md b/docs/c-runtime-library/reference/mbctombb-mbctombb-l.md index 0f165c8e0c4..b652e54e6eb 100644 --- a/docs/c-runtime-library/reference/mbctombb-mbctombb-l.md +++ b/docs/c-runtime-library/reference/mbctombb-mbctombb-l.md @@ -53,10 +53,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbctombb`**|\| -|**`_mbctombb_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbctombb`** | \ | +| **`_mbctombb_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbrlen.md b/docs/c-runtime-library/reference/mbrlen.md index e9e1790528c..b3f995551fd 100644 --- a/docs/c-runtime-library/reference/mbrlen.md +++ b/docs/c-runtime-library/reference/mbrlen.md @@ -58,15 +58,15 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|not applicable|not applicable|**`mbrlen`**|not applicable| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| not applicable | not applicable | **`mbrlen`** | not applicable | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`mbrlen`**|\| +| Routine | Required header | +|---|---| +| **`mbrlen`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbrtoc16-mbrtoc323.md b/docs/c-runtime-library/reference/mbrtoc16-mbrtoc323.md index 3ad982ae334..fc7eb70bf85 100644 --- a/docs/c-runtime-library/reference/mbrtoc16-mbrtoc323.md +++ b/docs/c-runtime-library/reference/mbrtoc16-mbrtoc323.md @@ -50,13 +50,13 @@ Pointer to a `mbstate_t` conversion state object used to interpret the UTF-8 mul On success, returns the value of the first of these conditions that applies, given the current *`state`* value: -|Value|Condition| -|-----------|---------------| -|0|The next *`max_bytes`* or fewer characters converted from *`source`* correspond to the null wide character, which is the value stored if *`destination`* isn't null.

*`state`* contains the initial shift state.| -|Between 1 and *`max_bytes`*, inclusive|The value returned is the number of bytes of *`source`* that complete a valid multibyte character. The converted wide character is stored if *`destination`* isn't null.| -|-3|The next wide character resulting from a previous call to the function has been stored in *`destination`* if *`destination`* isn't null. No bytes from *`source`* are consumed by this call to the function.

When *`source`* points to a UTF-8 multibyte character that requires more than one wide character to represent (for example, a surrogate pair), then the *`state`* value is updated so that the next function call writes out the extra character.| -|-2|The next *`max_bytes`* bytes represent an incomplete, but potentially valid, UTF-8 multibyte character. No value is stored in *`destination`*. This result can occur if *`max_bytes`* is zero.| -|-1|An encoding error has occurred. The next *`max_bytes`* or fewer bytes don't contribute to a complete and valid UTF-8 multibyte character. No value is stored in *`destination`*.

`EILSEQ` is stored in `errno` and the conversion state value *`state`* is unspecified.| +| Value | Condition | +|---|---| +| 0 | The next *`max_bytes`* or fewer characters converted from *`source`* correspond to the null wide character, which is the value stored if *`destination`* isn't null.

*`state`* contains the initial shift state. | +| Between 1 and *`max_bytes`*, inclusive | The value returned is the number of bytes of *`source`* that complete a valid multibyte character. The converted wide character is stored if *`destination`* isn't null. | +| -3 | The next wide character resulting from a previous call to the function has been stored in *`destination`* if *`destination`* isn't null. No bytes from *`source`* are consumed by this call to the function.

When *`source`* points to a UTF-8 multibyte character that requires more than one wide character to represent (for example, a surrogate pair), then the *`state`* value is updated so that the next function call writes out the extra character. | +| -2 | The next *`max_bytes`* bytes represent an incomplete, but potentially valid, UTF-8 multibyte character. No value is stored in *`destination`*. This result can occur if *`max_bytes`* is zero. | +| -1 | An encoding error has occurred. The next *`max_bytes`* or fewer bytes don't contribute to a complete and valid UTF-8 multibyte character. No value is stored in *`destination`*.

`EILSEQ` is stored in `errno` and the conversion state value *`state`* is unspecified. | ## Remarks @@ -72,9 +72,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`mbrtoc16`**, **`mbrtoc32`**|\|\| +| Function | C header | C++ header | +|---|---|---| +| **`mbrtoc16`**, **`mbrtoc32`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbrtowc.md b/docs/c-runtime-library/reference/mbrtowc.md index 900c2013d13..f2ec71dd408 100644 --- a/docs/c-runtime-library/reference/mbrtowc.md +++ b/docs/c-runtime-library/reference/mbrtowc.md @@ -190,9 +190,9 @@ WC String: AaBbCcÜïα∩≡xXyYzZ ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`mbrtowc`**|\| +| Routine | Required header | +|---|---| +| **`mbrtowc`** | \ | ## See also diff --git a/docs/c-runtime-library/reference/mbsbtype-mbsbtype-l.md b/docs/c-runtime-library/reference/mbsbtype-mbsbtype-l.md index e1593e74a23..5637ba2e0ba 100644 --- a/docs/c-runtime-library/reference/mbsbtype-mbsbtype-l.md +++ b/docs/c-runtime-library/reference/mbsbtype-mbsbtype-l.md @@ -46,12 +46,12 @@ Locale to use. **`_mbsbtype`** and **`_mbsbtype_l`** returns an integer value indicating the result of the test on the specified byte. The manifest constants in the following table are defined in Mbctype.h. -|Return value|Byte type| -|------------------|---------------| -|`_MBC_SINGLE` (0)|Single-byte character. For example, in code page 932, **`_mbsbtype`** returns 0 if the specified byte is within the range 0x20 - 0x7E or 0xA1 - 0xDF.| -|`_MBC_LEAD` (1)|Lead byte of multibyte character. For example, in code page 932, **`_mbsbtype`** returns 1 if the specified byte is within the range 0x81 - 0x9F or 0xE0 - 0xFC.| -|`_MBC_TRAIL` (2)|Trailing byte of multibyte character. For example, in code page 932, **`_mbsbtype`** returns 2 if the specified byte is within the range 0x40 - 0x7E or 0x80 - 0xFC.| -|`_MBC_ILLEGAL` (-1)|`NULL` string, invalid character, or null byte found before the byte at offset *`count`* in *`mbstr`*.| +| Return value | Byte type | +|---|---| +| `_MBC_SINGLE` (0) | Single-byte character. For example, in code page 932, **`_mbsbtype`** returns 0 if the specified byte is within the range 0x20 - 0x7E or 0xA1 - 0xDF. | +| `_MBC_LEAD` (1) | Lead byte of multibyte character. For example, in code page 932, **`_mbsbtype`** returns 1 if the specified byte is within the range 0x81 - 0x9F or 0xE0 - 0xFC. | +| `_MBC_TRAIL` (2) | Trailing byte of multibyte character. For example, in code page 932, **`_mbsbtype`** returns 2 if the specified byte is within the range 0x40 - 0x7E or 0x80 - 0xFC. | +| `_MBC_ILLEGAL` (-1) | `NULL` string, invalid character, or null byte found before the byte at offset *`count`* in *`mbstr`*. | ## Remarks @@ -65,10 +65,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_mbsbtype`**|\|\*| -|**`_mbsbtype_l`**|\|\*| +| Routine | Required header | Optional header | +|---|---|---| +| **`_mbsbtype`** | \ | \* | +| **`_mbsbtype_l`** | \ | \* | \* For manifest constants used as return values. diff --git a/docs/c-runtime-library/reference/mbsnbcat-mbsnbcat-l.md b/docs/c-runtime-library/reference/mbsnbcat-mbsnbcat-l.md index f16c7234e28..4cfccf9fd55 100644 --- a/docs/c-runtime-library/reference/mbsnbcat-mbsnbcat-l.md +++ b/docs/c-runtime-library/reference/mbsnbcat-mbsnbcat-l.md @@ -80,17 +80,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcsncat`|[`strncat`](strncat-strncat-l-wcsncat-wcsncat-l-mbsncat-mbsncat-l.md)|**`_mbsnbcat`**|[`wcsncat`](strncat-strncat-l-wcsncat-wcsncat-l-mbsncat-mbsncat-l.md)| -|`_tcsncat_l`|`_strncat_l`|**`_mbsnbcat_l`**|`_wcsncat_l`| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsncat` | [`strncat`](strncat-strncat-l-wcsncat-wcsncat-l-mbsncat-mbsncat-l.md) | **`_mbsnbcat`** | [`wcsncat`](strncat-strncat-l-wcsncat-wcsncat-l-mbsncat-mbsncat-l.md) | +| `_tcsncat_l` | `_strncat_l` | **`_mbsnbcat_l`** | `_wcsncat_l` | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsnbcat`**|\| -|**`_mbsnbcat_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbsnbcat`** | \ | +| **`_mbsnbcat_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbsnbcat-s-mbsnbcat-s-l.md b/docs/c-runtime-library/reference/mbsnbcat-s-mbsnbcat-s-l.md index 6d84860901c..f5e86bd4c63 100644 --- a/docs/c-runtime-library/reference/mbsnbcat-s-mbsnbcat-s-l.md +++ b/docs/c-runtime-library/reference/mbsnbcat-s-mbsnbcat-s-l.md @@ -71,11 +71,11 @@ Zero if successful; otherwise, an error code. ### Error conditions -|**`dest`**|*`sizeInBytes`*|*`src`*|Return value| -|------------|-------------------|-----------|------------------| -|`NULL`|any|any|`EINVAL`| -|Any|<= 0|any|`EINVAL`| -|Any|any|`NULL`|`EINVAL`| +| **`dest`** | *`sizeInBytes`* | *`src`* | Return value | +|---|---|---|---| +| `NULL` | any | any | `EINVAL` | +| Any | <= 0 | any | `EINVAL` | +| Any | any | `NULL` | `EINVAL` | If any of the error conditions occurs, the function generates an invalid parameter error, as described in [Parameter validation](../parameter-validation.md). If the error is handled, the function returns `EINVAL` and sets `errno` to `EINVAL`. @@ -93,17 +93,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_tcsncat_s`**|[`strncat_s`](strncat-s-strncat-s-l-wcsncat-s-wcsncat-s-l-mbsncat-s-mbsncat-s-l.md)|**`_mbsnbcat_s`**|[`wcsncat_s`](strncat-s-strncat-s-l-wcsncat-s-wcsncat-s-l-mbsncat-s-mbsncat-s-l.md)| -|**`_tcsncat_s_l`**|**`_strncat_s_l`**|**`_mbsnbcat_s_l`**|**`_wcsncat_s_l`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsncat_s` | [`strncat_s`](strncat-s-strncat-s-l-wcsncat-s-wcsncat-s-l-mbsncat-s-mbsncat-s-l.md) | **`_mbsnbcat_s`** | [`wcsncat_s`](strncat-s-strncat-s-l-wcsncat-s-wcsncat-s-l-mbsncat-s-mbsncat-s-l.md) | +| `_tcsncat_s_l` | **`_strncat_s_l`** | **`_mbsnbcat_s_l`** | **`_wcsncat_s_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsnbcat_s`**|\| -|**`_mbsnbcat_s_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbsnbcat_s`** | \ | +| **`_mbsnbcat_s_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbsnbcmp-mbsnbcmp-l.md b/docs/c-runtime-library/reference/mbsnbcmp-mbsnbcmp-l.md index 0f58353281b..89aa2fe6edd 100644 --- a/docs/c-runtime-library/reference/mbsnbcmp-mbsnbcmp-l.md +++ b/docs/c-runtime-library/reference/mbsnbcmp-mbsnbcmp-l.md @@ -48,11 +48,11 @@ The locale to use. The return value indicates the ordinal relationship between the substrings of *`string1`* and *`string2`*. -|Return value|Description| -|------------------|-----------------| -|< 0|*`string1`* substring is less than *`string2`* substring.| -|0|*`string1`* substring is identical to *`string2`* substring.| -|> 0|*`string1`* substring is greater than *`string2`* substring.| +| Return value | Description | +|---|---| +| < 0 | *`string1`* substring is less than *`string2`* substring. | +| 0 | *`string1`* substring is identical to *`string2`* substring. | +| > 0 | *`string1`* substring is greater than *`string2`* substring. | On a parameter validation error, **`_mbsnbcmp`** and **`_mbsnbcmp_l`** return `_NLSCMPERROR`, which is defined in \ and \. @@ -70,17 +70,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|_UNICODE and _MBCS not defined|_MBCS defined|_UNICODE defined| -|---------------------|---------------------------------------|--------------------|-----------------------| -|`_tcsncmp`|[`strncmp`](strncmp-wcsncmp-mbsncmp-mbsncmp-l.md)|**`_mbsnbcmp`**|[`wcsncmp`](strncmp-wcsncmp-mbsncmp-mbsncmp-l.md)| -|`_tcsncmp_l`|[`strncmp`](strncmp-wcsncmp-mbsncmp-mbsncmp-l.md)|**`_mbsnbcml`**|[`wcsncmp`](strncmp-wcsncmp-mbsncmp-mbsncmp-l.md)| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsncmp` | [`strncmp`](strncmp-wcsncmp-mbsncmp-mbsncmp-l.md) | **`_mbsnbcmp`** | [`wcsncmp`](strncmp-wcsncmp-mbsncmp-mbsncmp-l.md) | +| `_tcsncmp_l` | [`strncmp`](strncmp-wcsncmp-mbsncmp-mbsncmp-l.md) | **`_mbsnbcml`** | [`wcsncmp`](strncmp-wcsncmp-mbsncmp-mbsncmp-l.md) | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsnbcmp`**|\| -|**`_mbsnbcmp_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbsnbcmp`** | \ | +| **`_mbsnbcmp_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbsnbcoll-mbsnbcoll-l-mbsnbicoll-mbsnbicoll-l.md b/docs/c-runtime-library/reference/mbsnbcoll-mbsnbcoll-l-mbsnbicoll-mbsnbicoll-l.md index 3079753e62e..dbafe45f48c 100644 --- a/docs/c-runtime-library/reference/mbsnbcoll-mbsnbcoll-l-mbsnbicoll-mbsnbicoll-l.md +++ b/docs/c-runtime-library/reference/mbsnbcoll-mbsnbcoll-l-mbsnbicoll-mbsnbicoll-l.md @@ -59,11 +59,11 @@ Locale to use. The return value indicates the relation of the substrings of *`string1`* and *`string2`*. -|Return value|Description| -|------------------|-----------------| -|< 0|*`string1`* substring less than *`string2`* substring.| -|0|*`string1`* substring identical to *`string2`* substring.| -|> 0|*`string1`* substring greater than *`string2`* substring.| +| Return value | Description | +|---|---| +| < 0 | *`string1`* substring less than *`string2`* substring. | +| 0 | *`string1`* substring identical to *`string2`* substring. | +| > 0 | *`string1`* substring greater than *`string2`* substring. | If *`string1`* or *`string2`* is `NULL` or *`count`* is greater than `INT_MAX`, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions return `_NLSCMPERROR` and set `errno` to `EINVAL`. To use `_NLSCMPERROR`, include either String.h or Mbstring.h. @@ -81,21 +81,21 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcsncoll`|[`_strncoll`](strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md)|**`_mbsnbcoll`**|[`_wcsncoll`](strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md)| -|`_tcsncoll_l`|[`_strncoll`, `_wcsncoll`, `_mbsncoll`, `_strncoll_l`, `_wcsncoll_l`, `_mbsncoll_l`](strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md)|**`_mbsnbcoll_l`**|[`_wcsncoll_l`](strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md)| -|`_tcsnicoll`|[`_strnicoll`](strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md)|**`_mbsnbicoll`**|[`_wcsnicoll`](strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md)| -|`_tcsnicoll_l`|[`_strnicoll_l`](strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md)|**`_mbsnbicoll_l`**|[`_wcsnicoll_l`](strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md)| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsncoll` | [`_strncoll`](strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md) | **`_mbsnbcoll`** | [`_wcsncoll`](strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md) | +| `_tcsncoll_l` | [`_strncoll`, `_wcsncoll`, `_mbsncoll`, `_strncoll_l`, `_wcsncoll_l`, `_mbsncoll_l`](strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md) | **`_mbsnbcoll_l`** | [`_wcsncoll_l`](strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md) | +| `_tcsnicoll` | [`_strnicoll`](strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md) | **`_mbsnbicoll`** | [`_wcsnicoll`](strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md) | +| `_tcsnicoll_l` | [`_strnicoll_l`](strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md) | **`_mbsnbicoll_l`** | [`_wcsnicoll_l`](strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md) | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsnbcoll`**|\| -|**`_mbsnbcoll_l`**|\| -|**`_mbsnbicoll`**|\| -|**`_mbsnbicoll_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbsnbcoll`** | \ | +| **`_mbsnbcoll_l`** | \ | +| **`_mbsnbicoll`** | \ | +| **`_mbsnbicoll_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbsnbcpy-mbsnbcpy-l.md b/docs/c-runtime-library/reference/mbsnbcpy-mbsnbcpy-l.md index adfc7c3d376..1aa60e7e7e1 100644 --- a/docs/c-runtime-library/reference/mbsnbcpy-mbsnbcpy-l.md +++ b/docs/c-runtime-library/reference/mbsnbcpy-mbsnbcpy-l.md @@ -81,17 +81,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcsncpy`|[`strncpy`](strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md)|**`_mbsnbcpy`**|[`wcsncpy`](strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md)| -|`_tcsncpy_l`|`_strncpy_l`|**`_mbsnbcp_l`**|`_wcsncpy_l`| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsncpy` | [`strncpy`](strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md) | **`_mbsnbcpy`** | [`wcsncpy`](strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md) | +| `_tcsncpy_l` | `_strncpy_l` | **`_mbsnbcp_l`** | `_wcsncpy_l` | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsnbcpy`**|\| -|**`_mbsnbcpy_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbsnbcpy`** | \ | +| **`_mbsnbcpy_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbsnbcpy-s-mbsnbcpy-s-l.md b/docs/c-runtime-library/reference/mbsnbcpy-s-mbsnbcpy-s-l.md index 8d1eb139335..b6af37014c8 100644 --- a/docs/c-runtime-library/reference/mbsnbcpy-s-mbsnbcpy-s-l.md +++ b/docs/c-runtime-library/reference/mbsnbcpy-s-mbsnbcpy-s-l.md @@ -86,17 +86,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcsncpy_s`|`_strncpy_s`|**`_mbsnbcpy_s`**|`_wcsncpy_s`| -|`_tcsncpy_s_l`|`_strncpy_s_l`|**`_mbsnbcpy_s_l`**|`_wcsncpy_s_l`| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsncpy_s` | `_strncpy_s` | **`_mbsnbcpy_s`** | `_wcsncpy_s` | +| `_tcsncpy_s_l` | `_strncpy_s_l` | **`_mbsnbcpy_s_l`** | `_wcsncpy_s_l` | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsnbcpy_s`**|\| -|**`_mbsnbcpy_s_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbsnbcpy_s`** | \ | +| **`_mbsnbcpy_s_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbsnbicmp-mbsnbicmp-l.md b/docs/c-runtime-library/reference/mbsnbicmp-mbsnbicmp-l.md index e38ba2a7044..d53efc7d0e6 100644 --- a/docs/c-runtime-library/reference/mbsnbicmp-mbsnbicmp-l.md +++ b/docs/c-runtime-library/reference/mbsnbicmp-mbsnbicmp-l.md @@ -39,11 +39,11 @@ Number of bytes to compare. The return value indicates the relationship between the substrings. -|Return value|Description| -|------------------|-----------------| -|< 0|*`string1`* substring less than *`string2`* substring.| -|0|*`string1`* substring identical to *`string2`* substring.| -|> 0|*`string1`* substring greater than *`string2`* substring.| +| Return value | Description | +|---|---| +| < 0 | *`string1`* substring less than *`string2`* substring. | +| 0 | *`string1`* substring identical to *`string2`* substring. | +| > 0 | *`string1`* substring greater than *`string2`* substring. | On an error, **`_mbsnbicmp`** returns `_NLSCMPERROR`, which is defined in String.h and Mbstring.h. @@ -63,16 +63,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcsnicmp`|`_strnicmp`|**`_mbsnbicmp`**|`_wcsnicmp`| -|`_tcsnicmp_l`|`_strnicmp_l`|**`_mbsnbicmp_l`**|`_wcsnicmp_l`| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsnicmp` | `_strnicmp` | **`_mbsnbicmp`** | `_wcsnicmp` | +| `_tcsnicmp_l` | `_strnicmp_l` | **`_mbsnbicmp_l`** | `_wcsnicmp_l` | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsnbicmp`**|\| +| Routine | Required header | +|---|---| +| **`_mbsnbicmp`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbsnbset-mbsnbset-l.md b/docs/c-runtime-library/reference/mbsnbset-mbsnbset-l.md index 215877aeedb..23d1f2ba2cc 100644 --- a/docs/c-runtime-library/reference/mbsnbset-mbsnbset-l.md +++ b/docs/c-runtime-library/reference/mbsnbset-mbsnbset-l.md @@ -67,17 +67,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcsnset`|`_strnset`|**`_mbsnbset`**|`_wcsnset`| -|`_tcsnset_l`|`_strnset_l`|**`_mbsnbset_l`**|`_wcsnset_l`| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsnset` | `_strnset` | **`_mbsnbset`** | `_wcsnset` | +| `_tcsnset_l` | `_strnset_l` | **`_mbsnbset_l`** | `_wcsnset_l` | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsnbset`**|\| -|**`_mbsnbset_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbsnbset`** | \ | +| **`_mbsnbset_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbsnbset-s-mbsnbset-s-l.md b/docs/c-runtime-library/reference/mbsnbset-s-mbsnbset-s-l.md index 8bf0345e394..67ea2ec8eb6 100644 --- a/docs/c-runtime-library/reference/mbsnbset-s-mbsnbset-s-l.md +++ b/docs/c-runtime-library/reference/mbsnbset-s-mbsnbset-s-l.md @@ -87,17 +87,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcsnset_s`|`_strnset_s`|**`_mbsnbset_s`**|`_wcsnset_s`| -|`_tcsnset_s_l`|`_strnset_s _l`|**`_mbsnbset_s_l`**|`_wcsnset_s_l`| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsnset_s` | `_strnset_s` | **`_mbsnbset_s`** | `_wcsnset_s` | +| `_tcsnset_s_l` | `_strnset_s _l` | **`_mbsnbset_s_l`** | `_wcsnset_s_l` | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsnbset_s`**|\| -|**`_mbsnbset_s_l`**|\| +| Routine | Required header | +|---|---| +| **`_mbsnbset_s`** | \ | +| **`_mbsnbset_s_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbsrtowcs-s.md b/docs/c-runtime-library/reference/mbsrtowcs-s.md index a82ffe615a3..cb33469fe47 100644 --- a/docs/c-runtime-library/reference/mbsrtowcs-s.md +++ b/docs/c-runtime-library/reference/mbsrtowcs-s.md @@ -59,12 +59,12 @@ A pointer to an `mbstate_t` conversion state object. If this value is a null poi Zero if conversion is successful, or an error code on failure. -|Error condition|Return value and `errno`| -|---------------------|------------------------------| -|*`wcstr`* is a null pointer and *`sizeInWords`* > 0|`EINVAL`| -|*`mbstr`* is a null pointer|`EINVAL`| -|The string indirectly pointed to by *`mbstr`* contains a multibyte sequence that isn't valid for the current locale.|`EILSEQ`| -|The destination buffer is too small to contain the converted string (unless *`count`* is `_TRUNCATE`; for more information, see Remarks)|`ERANGE`| +| Error condition | Return value and `errno` | +|---|---| +| *`wcstr`* is a null pointer and *`sizeInWords`* > 0 | `EINVAL` | +| *`mbstr`* is a null pointer | `EINVAL` | +| The string indirectly pointed to by *`mbstr`* contains a multibyte sequence that isn't valid for the current locale. | `EILSEQ` | +| The destination buffer is too small to contain the converted string (unless *`count`* is `_TRUNCATE`; for more information, see Remarks) | `ERANGE` | If any one of these conditions occurs, the invalid parameter exception is invoked as described in [Parameter validation](../parameter-validation.md) . If execution is allowed to continue, the function returns an error code and sets `errno` as indicated in the table. @@ -107,9 +107,9 @@ The **`mbsrtowcs_s`** function is multithread safe if no function in the current ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`mbsrtowcs_s`**|\| +| Routine | Required header | +|---|---| +| **`mbsrtowcs_s`** | \ | ## See also diff --git a/docs/c-runtime-library/reference/mbsrtowcs.md b/docs/c-runtime-library/reference/mbsrtowcs.md index b6a1be2587e..346ecdb8824 100644 --- a/docs/c-runtime-library/reference/mbsrtowcs.md +++ b/docs/c-runtime-library/reference/mbsrtowcs.md @@ -74,9 +74,9 @@ The **`mbsrtowcs`** function is multithread safe as long as no function in the c ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`mbsrtowcs`**|\| +| Routine | Required header | +|---|---| +| **`mbsrtowcs`** | \ | ## See also diff --git a/docs/c-runtime-library/reference/mbstowcs-mbstowcs-l.md b/docs/c-runtime-library/reference/mbstowcs-mbstowcs-l.md index f131fd75d7a..12e7332f311 100644 --- a/docs/c-runtime-library/reference/mbstowcs-mbstowcs-l.md +++ b/docs/c-runtime-library/reference/mbstowcs-mbstowcs-l.md @@ -79,10 +79,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`mbstowcs`**|``| -|**`_mbstowcs_l`**|``| +| Routine | Required header | +|---|---| +| **`mbstowcs`** | `` | +| **`_mbstowcs_l`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbstowcs-s-mbstowcs-s-l.md b/docs/c-runtime-library/reference/mbstowcs-s-mbstowcs-s-l.md index 0104ddd2396..1c7a9df5769 100644 --- a/docs/c-runtime-library/reference/mbstowcs-s-mbstowcs-s-l.md +++ b/docs/c-runtime-library/reference/mbstowcs-s-mbstowcs-s-l.md @@ -73,12 +73,12 @@ The locale to use. Zero if successful, an error code on failure. -|Error condition|Return value and `errno`| -|---------------------|------------------------------| -|*`wcstr`* is `NULL` and *`sizeInWords`* > 0|`EINVAL`| -|*`mbstr`* is `NULL`|`EINVAL`| -|The destination buffer is too small to contain the converted string (unless *`count`* is `_TRUNCATE`; see Remarks below)|`ERANGE`| -|*`wcstr`* isn't `NULL` and *`sizeInWords`* == 0|`EINVAL`| +| Error condition | Return value and `errno` | +|---|---| +| *`wcstr`* is `NULL` and *`sizeInWords`* > 0 | `EINVAL` | +| *`mbstr`* is `NULL` | `EINVAL` | +| The destination buffer is too small to contain the converted string (unless *`count`* is `_TRUNCATE`; see Remarks below) | `ERANGE` | +| *`wcstr`* isn't `NULL` and *`sizeInWords`* == 0 | `EINVAL` | If any of these conditions occurs, the invalid parameter exception is invoked as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, the function returns an error code and sets `errno` as indicated in the table. @@ -113,10 +113,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`mbstowcs_s`**|``| -|**`_mbstowcs_s_l`**|``| +| Routine | Required header | +|---|---| +| **`mbstowcs_s`** | `` | +| **`_mbstowcs_s_l`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mbtowc-mbtowc-l.md b/docs/c-runtime-library/reference/mbtowc-mbtowc-l.md index 0668a81299d..c0c97f3aefa 100644 --- a/docs/c-runtime-library/reference/mbtowc-mbtowc-l.md +++ b/docs/c-runtime-library/reference/mbtowc-mbtowc-l.md @@ -56,10 +56,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`mbtowc`**|\| -|**`_mbtowc_l`**|\| +| Routine | Required header | +|---|---| +| **`mbtowc`** | \ | +| **`_mbtowc_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/memccpy.md b/docs/c-runtime-library/reference/memccpy.md index 7d3f6813a24..b742d4e7843 100644 --- a/docs/c-runtime-library/reference/memccpy.md +++ b/docs/c-runtime-library/reference/memccpy.md @@ -51,9 +51,9 @@ The **`_memccpy`** function copies zero or more characters of *`src`* to *`dest` ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_memccpy`**|\ or \| +| Routine | Required header | +|---|---| +| **`_memccpy`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/memchr-wmemchr.md b/docs/c-runtime-library/reference/memchr-wmemchr.md index ba46cc98f1e..688d80faa08 100644 --- a/docs/c-runtime-library/reference/memchr-wmemchr.md +++ b/docs/c-runtime-library/reference/memchr-wmemchr.md @@ -72,10 +72,10 @@ In C, these functions take a **`const`** pointer for the first argument. In C++, ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`memchr`|\ or \| -|`wmemchr`|\| +| Routine | Required header | +|---|---| +| `memchr` | \ or \ | +| `wmemchr` | \ | For more information about compatibility, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/memcmp-wmemcmp.md b/docs/c-runtime-library/reference/memcmp-wmemcmp.md index 8cf32179733..35e7714a555 100644 --- a/docs/c-runtime-library/reference/memcmp-wmemcmp.md +++ b/docs/c-runtime-library/reference/memcmp-wmemcmp.md @@ -44,11 +44,11 @@ Number of characters to compare. (Compares bytes for **`memcmp`**, wide characte The return value indicates the relationship between the buffers. -|Return value|Relationship of first *`count`* characters of `buf1` and `buf2`| -|------------------|---------------------------------------------------------------| -|< 0|*`buffer1`* less than *`buffer2`*| -|0|*`buffer1`* identical to *`buffer2`*| -|> 0|*`buffer1`* greater than *`buffer2`*| +| Return value | Relationship of first *`count`* characters of `buf1` and `buf2` | +|---|---| +| < 0 | *`buffer1`* less than *`buffer2`* | +| 0 | *`buffer1`* identical to *`buffer2`* | +| > 0 | *`buffer1`* greater than *`buffer2`* | ## Remarks @@ -56,10 +56,10 @@ Compares the first *`count`* characters of *`buffer1`* and *`buffer2`* and retur ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`memcmp`**|`` or ``| -|**`wmemcmp`**|``| +| Routine | Required header | +|---|---| +| **`memcmp`** | `` or `` | +| **`wmemcmp`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/memcpy-s-wmemcpy-s.md b/docs/c-runtime-library/reference/memcpy-s-wmemcpy-s.md index c4d71189006..1e0ccc4617d 100644 --- a/docs/c-runtime-library/reference/memcpy-s-wmemcpy-s.md +++ b/docs/c-runtime-library/reference/memcpy-s-wmemcpy-s.md @@ -51,12 +51,12 @@ Zero if successful; an error code on failure. ### Error conditions -|*`dest`*|*`destSize`*|*`src`*|*`count`*|Return value|Contents of *`dest`*| -|------------|----------------|-----------|---|------------------|------------------------| -|any|any|any|0|0|Not modified| -|`NULL`|any|any|non-zero|`EINVAL`|Not modified| -|any|any|`NULL`|non-zero|`EINVAL`|*`dest`* is zeroed out| -|any|< *`count`*|any|non-zero|`ERANGE`|*`dest`* is zeroed out| +| *`dest`* | *`destSize`* | *`src`* | *`count`* | Return value | Contents of *`dest`* | +|---|---|---|---|---|---| +| any | any | any | 0 | 0 | Not modified | +| `NULL` | any | any | non-zero | `EINVAL` | Not modified | +| any | any | `NULL` | non-zero | `EINVAL` | *`dest`* is zeroed out | +| any | < *`count`* | any | non-zero | `ERANGE` | *`dest`* is zeroed out | ## Remarks @@ -68,10 +68,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`memcpy_s`**|`` or ``| -|**`wmemcpy_s`**|``| +| Routine | Required header | +|---|---| +| **`memcpy_s`** | `` or `` | +| **`wmemcpy_s`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/memcpy-wmemcpy.md b/docs/c-runtime-library/reference/memcpy-wmemcpy.md index 4a6efe99470..00150c7026a 100644 --- a/docs/c-runtime-library/reference/memcpy-wmemcpy.md +++ b/docs/c-runtime-library/reference/memcpy-wmemcpy.md @@ -72,10 +72,10 @@ or ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`memcpy`**|`` or ``| -|**`wmemcpy`**|``| +| Routine | Required header | +|---|---| +| **`memcpy`** | `` or `` | +| **`wmemcpy`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/memicmp-memicmp-l.md b/docs/c-runtime-library/reference/memicmp-memicmp-l.md index b96b86a3f0c..3d60b5d32af 100644 --- a/docs/c-runtime-library/reference/memicmp-memicmp-l.md +++ b/docs/c-runtime-library/reference/memicmp-memicmp-l.md @@ -48,12 +48,12 @@ Locale to use. The return value indicates the relationship between the buffers. -|Return value|Relationship of first count bytes of buf1 and buf2| -|------------------|--------------------------------------------------------| -|< 0|*`buffer1`* less than *`buffer2`*.| -|0|*`buffer1`* identical to *`buffer2`*.| -|> 0|*`buffer1`* greater than *`buffer2`*.| -|`_NLSCMPERROR`|An error occurred.| +| Return value | Relationship of first count bytes of buf1 and buf2 | +|---|---| +| < 0 | *`buffer1`* less than *`buffer2`*. | +| 0 | *`buffer1`* identical to *`buffer2`*. | +| > 0 | *`buffer1`* greater than *`buffer2`*. | +| `_NLSCMPERROR` | An error occurred. | ## Remarks @@ -67,10 +67,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_memicmp`**|\ or \| -|**`_memicmp_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`_memicmp`** | \ or \ | +| **`_memicmp_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/memmove-s-wmemmove-s.md b/docs/c-runtime-library/reference/memmove-s-wmemmove-s.md index 2159bf6b5a3..15e73aaed94 100644 --- a/docs/c-runtime-library/reference/memmove-s-wmemmove-s.md +++ b/docs/c-runtime-library/reference/memmove-s-wmemmove-s.md @@ -51,11 +51,11 @@ Zero if successful; an error code on failure ### Error conditions -|*`dest`*|*`numberOfElements`*|*`src`*|Return value|Contents of *`dest`*| -|------------|------------------------|-----------|------------------|------------------------| -|`NULL`|any|any|`EINVAL`|not modified| -|any|any|`NULL`|`EINVAL`|not modified| -|any|< *`count`*|any|`ERANGE`|not modified| +| *`dest`* | *`numberOfElements`* | *`src`* | Return value | Contents of *`dest`* | +|---|---|---|---|---| +| `NULL` | any | any | `EINVAL` | not modified | +| any | any | `NULL` | `EINVAL` | not modified | +| any | < *`count`* | any | `ERANGE` | not modified | ## Remarks @@ -67,10 +67,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`memmove_s`**|\| -|**`wmemmove_s`**|\| +| Routine | Required header | +|---|---| +| **`memmove_s`** | \ | +| **`wmemmove_s`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/memmove-wmemmove.md b/docs/c-runtime-library/reference/memmove-wmemmove.md index db0639cb8a3..78e77fbe8ef 100644 --- a/docs/c-runtime-library/reference/memmove-wmemmove.md +++ b/docs/c-runtime-library/reference/memmove-wmemmove.md @@ -65,10 +65,10 @@ or ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`memmove`**|``| -|**`wmemmove`**|``| +| Routine | Required header | +|---|---| +| **`memmove`** | `` | +| **`wmemmove`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/memset-wmemset.md b/docs/c-runtime-library/reference/memset-wmemset.md index 14e24da21c9..653fc9b8b7f 100644 --- a/docs/c-runtime-library/reference/memset-wmemset.md +++ b/docs/c-runtime-library/reference/memset-wmemset.md @@ -53,10 +53,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`memset`**|`` or ``| -|**`wmemset`**|``| +| Routine | Required header | +|---|---| +| **`memset`** | `` or `` | +| **`wmemset`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/min.md b/docs/c-runtime-library/reference/min.md index 239898514e5..d6e3fbfd164 100644 --- a/docs/c-runtime-library/reference/min.md +++ b/docs/c-runtime-library/reference/min.md @@ -37,9 +37,9 @@ The argument returned is evaluated twice by the macro. Double evaluation can lea ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`__min`**|\| +| Routine | Required header | +|---|---| +| **`__min`** | \ | ## Example diff --git a/docs/c-runtime-library/reference/mkdir-wmkdir.md b/docs/c-runtime-library/reference/mkdir-wmkdir.md index 0f9e7a4bb3d..e8ad9c0ddcc 100644 --- a/docs/c-runtime-library/reference/mkdir-wmkdir.md +++ b/docs/c-runtime-library/reference/mkdir-wmkdir.md @@ -51,16 +51,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_tmkdir`**|**`_mkdir`**|**`_mkdir`**|**`_wmkdir`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tmkdir` | **`_mkdir`** | **`_mkdir`** | **`_wmkdir`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mkdir`**|``| -|**`_wmkdir`**|`` or ``| +| Routine | Required header | +|---|---| +| **`_mkdir`** | `` | +| **`_wmkdir`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mktemp-s-wmktemp-s.md b/docs/c-runtime-library/reference/mktemp-s-wmktemp-s.md index 662b5d33575..d9d38e21662 100644 --- a/docs/c-runtime-library/reference/mktemp-s-wmktemp-s.md +++ b/docs/c-runtime-library/reference/mktemp-s-wmktemp-s.md @@ -49,11 +49,11 @@ Both of these functions return zero on success; an error code on failure. ### Error conditions -|*`nameTemplate`*|*`sizeInChars`*|Return value|New value in *`nameTemplate`*| -|----------------|-------------------|----------------------|-------------------------------| -|`NULL`|any|`EINVAL`|`NULL`| -|Incorrect format (see Remarks section for correct format)|any|`EINVAL`|empty string| -|any|<= number of X characters|`EINVAL`|empty string| +| *`nameTemplate`* | *`sizeInChars`* | Return value | New value in *`nameTemplate`* | +|---|---|---|---| +| `NULL` | any | `EINVAL` | `NULL` | +| Incorrect format (see Remarks section for correct format) | any | `EINVAL` | empty string | +| any | <= number of X characters | `EINVAL` | empty string | If any of the above error conditions occurs, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `errno` is set to `EINVAL` and the functions returns `EINVAL`. @@ -67,9 +67,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tmktemp_s`|**`_mktemp_s`**|**`_mktemp_s`**|**`_wmktemp_s`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tmktemp_s` | **`_mktemp_s`** | **`_mktemp_s`** | **`_wmktemp_s`** | The *`nameTemplate`* argument has the form *`baseXXXXXX`*, where *`base`* is the part of the new file name that you supply and each X is a placeholder for a character supplied by **`_mktemp_s`**. Each placeholder character in *`nameTemplate`* must be an uppercase X. **`_mktemp_s`** preserves *`base`* and replaces the first trailing X with an alphabetic character. **`_mktemp_s`** replaces the X characters that follow with a five-digit value. This value is a unique number that identifies the calling process, or in multithreaded programs, the calling thread. @@ -95,10 +95,10 @@ In C++, using these functions is simplified by template overloads; the overloads ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mktemp_s`**|\| -|**`_wmktemp_s`**|\ or \| +| Routine | Required header | +|---|---| +| **`_mktemp_s`** | \ | +| **`_wmktemp_s`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mktemp-wmktemp.md b/docs/c-runtime-library/reference/mktemp-wmktemp.md index 82f14ee2656..f38ec922985 100644 --- a/docs/c-runtime-library/reference/mktemp-wmktemp.md +++ b/docs/c-runtime-library/reference/mktemp-wmktemp.md @@ -50,9 +50,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tmktemp`|**`_mktemp`**|**`_mktemp`**|**`_wmktemp`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tmktemp` | **`_mktemp`** | **`_mktemp`** | **`_wmktemp`** | The *`nameTemplate`* argument has the form *`baseXXXXXX`*, where *`base`* is the part of the new file name that you supply and each X is a placeholder for a character supplied by **`_mktemp`**. Each placeholder character in *`nameTemplate`* must be an uppercase X. **`_mktemp`** preserves *`base`* and replaces the first trailing X with an alphabetic character. **`_mktemp`** replaces the trailing X characters with a five-digit value. This value is a unique number that identifies the calling process, or in multithreaded programs, the calling thread. @@ -80,10 +80,10 @@ In C++, these functions have template overloads that invoke the newer, secure co ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mktemp`**|\| -|**`_wmktemp`**|\ or \| +| Routine | Required header | +|---|---| +| **`_mktemp`** | \ | +| **`_wmktemp`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/mktime-mktime32-mktime64.md b/docs/c-runtime-library/reference/mktime-mktime32-mktime64.md index 8ae45f51d25..f8c633ee2f0 100644 --- a/docs/c-runtime-library/reference/mktime-mktime32-mktime64.md +++ b/docs/c-runtime-library/reference/mktime-mktime32-mktime64.md @@ -64,11 +64,11 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`mktime`**|``| -|**`_mktime32`**|``| -|**`_mktime64`**|``| +| Routine | Required header | +|---|---| +| **`mktime`** | `` | +| **`_mktime32`** | `` | +| **`_mktime64`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/modf-modff-modfl.md b/docs/c-runtime-library/reference/modf-modff-modfl.md index e0632dc9f98..5aaab1a1319 100644 --- a/docs/c-runtime-library/reference/modf-modff-modfl.md +++ b/docs/c-runtime-library/reference/modf-modff-modfl.md @@ -50,9 +50,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`modf`**, **`modff`**, **`modfl`**|C: ``

C++: , `` or ``| +| Routine | Required header | +|---|---| +| **`modf`**, **`modff`**, **`modfl`** | C: ``

C++: , `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/msize-dbg.md b/docs/c-runtime-library/reference/msize-dbg.md index b8c1fcb65b5..41a1c384964 100644 --- a/docs/c-runtime-library/reference/msize-dbg.md +++ b/docs/c-runtime-library/reference/msize-dbg.md @@ -45,9 +45,9 @@ This function validates its parameter. If *`memblock`* is a null pointer, **`_ms ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_msize_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_msize_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/msize.md b/docs/c-runtime-library/reference/msize.md index b7822a5406b..41cf86612a3 100644 --- a/docs/c-runtime-library/reference/msize.md +++ b/docs/c-runtime-library/reference/msize.md @@ -42,9 +42,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_msize`**|``| +| Routine | Required header | +|---|---| +| **`_msize`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/nan-nanf-nanl.md b/docs/c-runtime-library/reference/nan-nanf-nanl.md index 130e435c262..55645e29858 100644 --- a/docs/c-runtime-library/reference/nan-nanf-nanl.md +++ b/docs/c-runtime-library/reference/nan-nanf-nanl.md @@ -39,9 +39,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`nan`**, **`nanf`**, **`nanl`**|\|\ or \| +| Function | C header | C++ header | +|---|---|---| +| **`nan`**, **`nanf`**, **`nanl`** | \ | \ or \ | ## See also diff --git a/docs/c-runtime-library/reference/nearbyint-nearbyintf-nearbyintl1.md b/docs/c-runtime-library/reference/nearbyint-nearbyintf-nearbyintl1.md index 89dfd8cc9b3..036fd43be5a 100644 --- a/docs/c-runtime-library/reference/nearbyint-nearbyintf-nearbyintl1.md +++ b/docs/c-runtime-library/reference/nearbyint-nearbyintf-nearbyintl1.md @@ -35,11 +35,11 @@ The value to round. If successful, returns *`x`*, rounded to the nearest integer, using the current rounding format as reported by [`fegetround`](fegetround-fesetround2.md). Otherwise, the function may return one of the following values: -|Issue|Return| -|-----------|------------| -|*`x`* = ±INFINITY|±INFINITY, unmodified| -|*`x`* = ±0|±0, unmodified| -|*`x`* = NaN|NaN| +| Issue | Return | +|---|---| +| *`x`* = ±INFINITY | ±INFINITY, unmodified | +| *`x`* = ±0 | ±0, unmodified | +| *`x`* = NaN | NaN | Errors aren't reported through [`_matherr`](matherr.md); specifically, this function doesn't report any `FE_INEXACT` exceptions. @@ -57,10 +57,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`nearbyint`**, **`nearbyintf`**, **`nearbyintl`**|\|\ or \| -|**`nearbyint`** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`nearbyint`**, **`nearbyintf`**, **`nearbyintl`** | \ | \ or \ | +| **`nearbyint`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/nextafter-functions.md b/docs/c-runtime-library/reference/nextafter-functions.md index 7ccf62877f1..d61d49dfc68 100644 --- a/docs/c-runtime-library/reference/nextafter-functions.md +++ b/docs/c-runtime-library/reference/nextafter-functions.md @@ -64,11 +64,11 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header (C)|Required header (C++)| -|-------------|---------------------------|-------------------------------| -|**`nextafter`**, **`nextafterf`**, **`nextafterl`**, **`_nextafterf`**, **`nexttoward`**, **`nexttowardf`**, **`nexttowardl`**|``|`` or ``| -|**`_nextafter`**|``|`` or ``| -|**`nextafter`** macro, **`nexttoward`** macro| `` || +| Routine | Required header (C) | Required header (C++) | +|---|---|---| +| **`nextafter`**, **`nextafterf`**, **`nextafterl`**, **`_nextafterf`**, **`nexttoward`**, **`nexttowardf`**, **`nexttowardl`** | `` | `` or `` | +| **`_nextafter`** | `` | `` or `` | +| **`nextafter`** macro, **`nexttoward`** macro | `` | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/norm-normf-norml1.md b/docs/c-runtime-library/reference/norm-normf-norml1.md index 04ef39f1a9f..5115c675abe 100644 --- a/docs/c-runtime-library/reference/norm-normf-norml1.md +++ b/docs/c-runtime-library/reference/norm-normf-norml1.md @@ -42,9 +42,9 @@ Because C++ allows overloading, you can call overloads of **`norm`** that take ` ## Requirements -|Routine|C header|C++ header| -|-------------|--------------|------------------| -|**`norm`**, **`normf`**, **`norml`**|\|\| +| Routine | C header | C++ header | +|---|---|---| +| **`norm`**, **`normf`**, **`norml`** | \ | \ | The `_Fcomplex`, `_Dcomplex`, and `_Lcomplex` types are Microsoft-specific equivalents of the unimplemented native C99 types **float _Complex**, **double _Complex**, and **long double _Complex**, respectively. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/offsetof-macro.md b/docs/c-runtime-library/reference/offsetof-macro.md index fe043abbffe..1d200208d64 100644 --- a/docs/c-runtime-library/reference/offsetof-macro.md +++ b/docs/c-runtime-library/reference/offsetof-macro.md @@ -43,9 +43,9 @@ The **`offsetof`** macro returns the offset in bytes of *`memberName`* from the ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`offsetof`**|\| +| Routine | Required header | +|---|---| +| **`offsetof`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/onexit-onexit-m.md b/docs/c-runtime-library/reference/onexit-onexit-m.md index efd92b32544..304be260d3c 100644 --- a/docs/c-runtime-library/reference/onexit-onexit-m.md +++ b/docs/c-runtime-library/reference/onexit-onexit-m.md @@ -44,9 +44,9 @@ In the case when **`_onexit`** is called from within a DLL, routines registered ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_onexit`**|\| +| Routine | Required header | +|---|---| +| **`_onexit`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/open-osfhandle.md b/docs/c-runtime-library/reference/open-osfhandle.md index 9a2ce74d58b..f286a437340 100644 --- a/docs/c-runtime-library/reference/open-osfhandle.md +++ b/docs/c-runtime-library/reference/open-osfhandle.md @@ -53,9 +53,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_open_osfhandle`**|``| +| Routine | Required header | +|---|---| +| **`_open_osfhandle`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/pclose.md b/docs/c-runtime-library/reference/pclose.md index 6187594be8c..52e8568b94e 100644 --- a/docs/c-runtime-library/reference/pclose.md +++ b/docs/c-runtime-library/reference/pclose.md @@ -44,9 +44,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_pclose`**|\| +| Routine | Required header | +|---|---| +| **`_pclose`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/perror-wperror.md b/docs/c-runtime-library/reference/perror-wperror.md index b132cfe17c2..be3b1e88fc2 100644 --- a/docs/c-runtime-library/reference/perror-wperror.md +++ b/docs/c-runtime-library/reference/perror-wperror.md @@ -38,9 +38,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tperror`|**`perror`**|**`perror`**|**`_wperror`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tperror` | **`perror`** | **`perror`** | **`_wperror`** | *`message`* is printed first, followed by a colon, then by the system error message for the last library call that produced the error, and finally by a newline character. If *`message`* is a null pointer or a pointer to a null string, **`perror`** prints only the system error message. @@ -52,10 +52,10 @@ In the Windows operating system, some `errno` values listed in ERRNO.H are unuse ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`perror`**|\ or \| -|**`_wperror`**|\ or \| +| Routine | Required header | +|---|---| +| **`perror`** | \ or \ | +| **`_wperror`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/pipe.md b/docs/c-runtime-library/reference/pipe.md index 8b19f0ccf1a..ca9f736e898 100644 --- a/docs/c-runtime-library/reference/pipe.md +++ b/docs/c-runtime-library/reference/pipe.md @@ -71,9 +71,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_pipe`**|``|``,1 ``2| +| Routine | Required header | Optional header | +|---|---|---| +| **`_pipe`** | `` | ``,1 ``2 | 1 For `_O_BINARY` and `_O_TEXT` definitions. diff --git a/docs/c-runtime-library/reference/popen-wpopen.md b/docs/c-runtime-library/reference/popen-wpopen.md index dc463bdb2a7..7a2769a84a7 100644 --- a/docs/c-runtime-library/reference/popen-wpopen.md +++ b/docs/c-runtime-library/reference/popen-wpopen.md @@ -49,12 +49,12 @@ For information about these and other error codes, see [`errno`, `_doserrno`, `_ The **`_popen`** function creates a pipe. It then asynchronously executes a spawned copy of the command processor, and uses *`command`* as the command line. The character string *`mode`* specifies the type of access requested, as follows. -|Access mode|Description| -|-|-| -|**"r"**|The calling process can read the spawned command's standard output using the returned stream.| -|**"w"**|The calling process can write to the spawned command's standard input using the returned stream.| -|**"b"**|Open in binary mode.| -|**"t"**|Open in text mode.| +| Access mode | Description | +|---|---| +| **"`r`"** | The calling process can read the spawned command's standard output using the returned stream. | +| **"`w`"** | The calling process can write to the spawned command's standard input using the returned stream. | +| **"`b`"** | Open in binary mode. | +| **"`t`"** | Open in text mode. | > [!NOTE] > If used in a Windows program, the **`_popen`** function returns an invalid file pointer that causes the program to stop responding indefinitely. **`_popen`** works properly in a console application. To create a Windows application that redirects input and output, see [Creating a child process with redirected input and output](/windows/win32/ProcThread/creating-a-child-process-with-redirected-input-and-output) in the Windows SDK. @@ -65,16 +65,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_tpopen`**|**`_popen`**|**`_popen`**|**`_wpopen`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tpopen` | **`_popen`** | **`_popen`** | **`_wpopen`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_popen`**|``| -|**`_wpopen`**|`` or ``| +| Routine | Required header | +|---|---| +| **`_popen`** | `` | +| **`_wpopen`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/pow-powf-powl.md b/docs/c-runtime-library/reference/pow-powf-powl.md index f54f40c819b..7ceb1e7185f 100644 --- a/docs/c-runtime-library/reference/pow-powf-powl.md +++ b/docs/c-runtime-library/reference/pow-powf-powl.md @@ -41,11 +41,11 @@ Exponent. Returns the value of *`x`**`y`*. No error message is printed on overflow or underflow. -|Values of x and y|Return value of pow| -|-----------------------|-------------------------| -|*`x`* != 0.0 and *`y`* == 0.0|1| -|*`x`* == 0.0 and *`y`* == 0.0|1| -|*`x`* == 0.0 and *`y`* < 0|INF| +| Values of *`x`* and *`y`* | Return value of **`pow`** | +|---|---| +| *`x`* != 0.0 and *`y`* == 0.0 | 1 | +| *`x`* == 0.0 and *`y`* == 0.0 | 1 | +| *`x`* == 0.0 and *`y`* < 0 | INF | ## Remarks @@ -65,10 +65,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header (C)|Required header (C++)| -|-|-|-| -|**`pow`**, **`powf`**, **`powl`**|``|`` or ``| -|**`pow`** macro | `` || +| Routine | Required header (C) | Required header (C++) | +|---|---|---| +| **`pow`**, **`powf`**, **`powl`** | `` | `` or `` | +| **`pow`** macro | `` | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/printf-p-printf-p-l-wprintf-p-wprintf-p-l.md b/docs/c-runtime-library/reference/printf-p-printf-p-l-wprintf-p-wprintf-p-l.md index 0f698966462..3d909d93970 100644 --- a/docs/c-runtime-library/reference/printf-p-printf-p-l-wprintf-p-wprintf-p-l.md +++ b/docs/c-runtime-library/reference/printf-p-printf-p-l-wprintf-p-wprintf-p-l.md @@ -68,17 +68,17 @@ If *`format`* or *`argument`* are `NULL`, or of the format string contains inval ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tprintf_p`|**`_printf_p`**|**`_printf_p`**|**`_wprintf_p`**| -|`_tprintf_p_l`|**`_printf_p_l`**|**`_printf_p_l`**|**`_wprintf_p_l`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tprintf_p` | **`_printf_p`** | **`_printf_p`** | **`_wprintf_p`** | +| `_tprintf_p_l` | **`_printf_p_l`** | **`_printf_p_l`** | **`_wprintf_p_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_printf_p`**, **`_printf_p_l`**|\| -|**`_wprintf_p`**, **`_wprintf_p_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`_printf_p`**, **`_printf_p_l`** | \ | +| **`_wprintf_p`**, **`_wprintf_p_l`** | \ or \ | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/printf-printf-l-wprintf-wprintf-l.md b/docs/c-runtime-library/reference/printf-printf-l-wprintf-wprintf-l.md index 39502b2cae3..9754b1c51fd 100644 --- a/docs/c-runtime-library/reference/printf-printf-l-wprintf-wprintf-l.md +++ b/docs/c-runtime-library/reference/printf-printf-l-wprintf-wprintf-l.md @@ -81,17 +81,17 @@ Line one ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_tprintf`**|**`printf`**|**`printf`**|**`wprintf`**| -|**`_tprintf_l`**|**`_printf_l`**|**`_printf_l`**|**`_wprintf_l`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tprintf`** | **`printf`** | **`printf`** | **`wprintf`** | +| **`_tprintf_l`** | **`_printf_l`** | **`_printf_l`** | **`_wprintf_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`printf`**, **`_printf_l`**|``| -|**`wprintf`**, **`_wprintf_l`**|`` or ``| +| Routine | Required header | +|---|---| +| **`printf`**, **`_printf_l`** | `` | +| **`wprintf`**, **`_wprintf_l`** | `` or `` | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, **`stdin`**, **`stdout`**, and **`stderr`**, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md b/docs/c-runtime-library/reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md index eeecf47a805..be7f7d3340e 100644 --- a/docs/c-runtime-library/reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md +++ b/docs/c-runtime-library/reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md @@ -67,10 +67,10 @@ The versions of these functions with the **`_l`** suffix are identical except th ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tprintf_s`**|**`printf_s`**|**`printf_s`**|**`wprintf_s`**| -|**`_tprintf_s_l`**|**`_printf_s_l`**|**`_printf_s_l`**|**`_wprintf_s_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tprintf_s` | **`printf_s`** | **`printf_s`** | **`wprintf_s`** | +| `_tprintf_s_l` | **`_printf_s_l`** | **`_printf_s_l`** | **`_wprintf_s_l`** | The *`format`* argument consists of ordinary characters, escape sequences, and (if arguments follow *`format`*) format specifications. The ordinary characters and escape sequences are copied to **`stdout`** in order of their appearance. For example, the line @@ -94,10 +94,10 @@ Line one ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`printf_s`**, **`_printf_s_l`**|``| -|**`wprintf_s`**, **`_wprintf_s_l`**|`` or ``| +| Routine | Required header | +|---|---| +| **`printf_s`**, **`_printf_s_l`** | `` | +| **`wprintf_s`**, **`_wprintf_s_l`** | `` or `` | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, **`stdin`**, **`stdout`**, and **`stderr`**, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/putc-nolock-putwc-nolock.md b/docs/c-runtime-library/reference/putc-nolock-putwc-nolock.md index 9ffbc158a35..e44c014c4c6 100644 --- a/docs/c-runtime-library/reference/putc-nolock-putwc-nolock.md +++ b/docs/c-runtime-library/reference/putc-nolock-putwc-nolock.md @@ -49,16 +49,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_puttc_nolock`|**`_putc_nolock`**|**`_putc_nolock`**|**`_putwc_nolock`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_puttc_nolock` | **`_putc_nolock`** | **`_putc_nolock`** | **`_putwc_nolock`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_putc_nolock`**|\| -|**`_putwc_nolock`**|\ or \| +| Routine | Required header | +|---|---| +| **`_putc_nolock`** | \ | +| **`_putwc_nolock`** | \ or \ | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/putc-putwc.md b/docs/c-runtime-library/reference/putc-putwc.md index 017e9680211..9275e6135c4 100644 --- a/docs/c-runtime-library/reference/putc-putwc.md +++ b/docs/c-runtime-library/reference/putc-putwc.md @@ -51,16 +51,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_puttc`|**`putc`**|**`putc`**|**`putwc`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_puttc` | **`putc`** | **`putc`** | **`putwc`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`putc`**|\| -|**`putwc`**|\ or \| +| Routine | Required header | +|---|---| +| **`putc`** | \ | +| **`putwc`** | \ or \ | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/putch-nolock-putwch-nolock.md b/docs/c-runtime-library/reference/putch-nolock-putwch-nolock.md index 4e25a61f0b7..a8d1f33ac55 100644 --- a/docs/c-runtime-library/reference/putch-nolock-putwch-nolock.md +++ b/docs/c-runtime-library/reference/putch-nolock-putwch-nolock.md @@ -45,16 +45,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_puttch_nolock`|**`_putch_nolock`**|**`_putch_nolock`**|**`_putwch_nolock`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_puttch_nolock` | **`_putch_nolock`** | **`_putch_nolock`** | **`_putwch_nolock`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_putch_nolock`**|\| -|**`_putwch_nolock`**|\| +| Routine | Required header | +|---|---| +| **`_putch_nolock`** | \ | +| **`_putwch_nolock`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/putch-putwch.md b/docs/c-runtime-library/reference/putch-putwch.md index b372ad9fbdf..dda5aad576a 100644 --- a/docs/c-runtime-library/reference/putch-putwch.md +++ b/docs/c-runtime-library/reference/putch-putwch.md @@ -48,16 +48,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_puttch`|**`_putch`**|**`_putch`**|**`_putwch`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_puttch` | **`_putch`** | **`_putch`** | **`_putwch`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_putch`**|\| -|**`_putwch`**|\| +| Routine | Required header | +|---|---| +| **`_putch`** | \ | +| **`_putwch`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/putchar-nolock-putwchar-nolock.md b/docs/c-runtime-library/reference/putchar-nolock-putwchar-nolock.md index 06ce2cd9a78..4748670c50b 100644 --- a/docs/c-runtime-library/reference/putchar-nolock-putwchar-nolock.md +++ b/docs/c-runtime-library/reference/putchar-nolock-putwchar-nolock.md @@ -40,16 +40,16 @@ See **putchar, putwchar**. ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_puttchar_nolock`|**`_putchar_nolock`**|**`_putchar_nolock`**|**`_putwchar_nolock`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_puttchar_nolock` | **`_putchar_nolock`** | **`_putchar_nolock`** | **`_putwchar_nolock`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_putchar_nolock`**|\| -|**`_putwchar_nolock`**|\ or \| +| Routine | Required header | +|---|---| +| **`_putchar_nolock`** | \ | +| **`_putwchar_nolock`** | \ or \ | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/putchar-putwchar.md b/docs/c-runtime-library/reference/putchar-putwchar.md index a4290d5558e..5b7a6c6b098 100644 --- a/docs/c-runtime-library/reference/putchar-putwchar.md +++ b/docs/c-runtime-library/reference/putchar-putwchar.md @@ -46,16 +46,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_puttchar`|**`putchar`**|**`putchar`**|**`putwchar`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_puttchar` | **`putchar`** | **`putchar`** | **`putwchar`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`putchar`**|\| -|**`putwchar`**|\ or \| +| Routine | Required header | +|---|---| +| **`putchar`** | \ | +| **`putwchar`** | \ or \ | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/putenv-s-wputenv-s.md b/docs/c-runtime-library/reference/putenv-s-wputenv-s.md index 9e3f17e4599..51256a71db9 100644 --- a/docs/c-runtime-library/reference/putenv-s-wputenv-s.md +++ b/docs/c-runtime-library/reference/putenv-s-wputenv-s.md @@ -43,10 +43,10 @@ Returns 0 if successful, or an error code. ### Error conditions -|*`varname`*|*`value_string`*|Return value| -|------------|-------------|------------------| -|`NULL`|any|`EINVAL`| -|any|`NULL`|`EINVAL`| +| *`varname`* | *`value_string`* | Return value | +|---|---|---| +| `NULL` | any | `EINVAL` | +| any | `NULL` | `EINVAL` | If one of the error conditions occurs, these functions invoke an invalid parameter handler, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions return `EINVAL` and set `errno` to `EINVAL`. @@ -58,9 +58,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tputenv_s`**|**`_putenv_s`**|**`_putenv_s`**|**`_wputenv_s`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tputenv_s` | **`_putenv_s`** | **`_putenv_s`** | **`_wputenv_s`** | *`varname`* is the name of the environment variable to be added or modified and *`value_string`* is the variable's value. If *`varname`* is already part of the environment, its value is replaced by *`value_string`*; otherwise, the new *`varname`* variable and its *`value_string`* are added to the environment. You can remove a variable from the environment by specifying an empty string (that is, `""`) for *`value_string`*. @@ -75,10 +75,10 @@ Don't change an environment entry directly; instead, use **`_putenv_s`** or **`_ ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_putenv_s`**|``| -|**`_wputenv_s`**|`` or ``| +| Routine | Required header | +|---|---| +| **`_putenv_s`** | `` | +| **`_wputenv_s`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/putenv-wputenv.md b/docs/c-runtime-library/reference/putenv-wputenv.md index 8e218cf535b..3eb33e13f77 100644 --- a/docs/c-runtime-library/reference/putenv-wputenv.md +++ b/docs/c-runtime-library/reference/putenv-wputenv.md @@ -44,9 +44,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE and _MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_tputenv`**|**`_putenv`**|**`_putenv`**|**`_wputenv`**| +| `Tchar.h` routine | `_UNICODE and _MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tputenv` | **`_putenv`** | **`_putenv`** | **`_wputenv`** | The *`envstring`* argument must be a pointer to a string of the form *`varname=value_string`*, where *`varname`* is the name of the environment variable to be added or modified and *`value_string`* is the variable's value. If *`varname`* is already part of the environment, its value is replaced by *`value_string`*; otherwise, the new *`varname`* variable and its *`value_string`* value are added to the environment. You can remove a variable from the environment by specifying an empty *`value_string`*, or in other words, by specifying only *`varname`*=. @@ -61,10 +61,10 @@ Don't change an environment entry directly: instead, use **`_putenv`** or **`_wp ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_putenv`**|``| -|**`_wputenv`**|`` or ``| +| Routine | Required header | +|---|---| +| **`_putenv`** | `` | +| **`_wputenv`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/puts-putws.md b/docs/c-runtime-library/reference/puts-putws.md index 0feedd4d490..1e9684c7d72 100644 --- a/docs/c-runtime-library/reference/puts-putws.md +++ b/docs/c-runtime-library/reference/puts-putws.md @@ -48,16 +48,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_putts`|**`puts`**|**`puts`**|**`_putws`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_putts` | **`puts`** | **`puts`** | **`_putws`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`puts`**|\| -|**`_putws`**|\| +| Routine | Required header | +|---|---| +| **`puts`** | \ | +| **`_putws`** | \ | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/putw.md b/docs/c-runtime-library/reference/putw.md index 5c9924ee651..8d3e14af26f 100644 --- a/docs/c-runtime-library/reference/putw.md +++ b/docs/c-runtime-library/reference/putw.md @@ -45,9 +45,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_putw`**|\| +| Routine | Required header | +|---|---| +| **`_putw`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/qsort-s.md b/docs/c-runtime-library/reference/qsort-s.md index 1245b030755..fcfbbe14254 100644 --- a/docs/c-runtime-library/reference/qsort-s.md +++ b/docs/c-runtime-library/reference/qsort-s.md @@ -53,11 +53,11 @@ compare( context, (void *) & elem1, (void *) & elem2 ); The routine must compare the elements and then return one of the following values: -|Return value|Description| -|------------------|-----------------| -|< 0|*element 1* less than *element 2*| -|0|*element 1* equivalent to *element 2*| -|> 0|*element 1* greater than *element 2*| +| Return value | Description | +|---|---| +| < 0 | *element 1* less than *element 2* | +| 0 | *element 1* equivalent to *element 2* | +| > 0 | *element 1* greater than *element 2* | The array is sorted in increasing order, as defined by the comparison function. To sort an array in decreasing order, reverse the sense of "greater than" and "less than" in the comparison function. @@ -67,20 +67,20 @@ By default, this function's global state is scoped to the application. To change ### Error conditions -|key|base|compare|num|width|errno| -|---------|----------|-------------|---------|-----------|-----------| -|`NULL`|any|any|any|any|`EINVAL`| -|any|`NULL`|any|!= 0|any|`EINVAL`| -|any|any|any|any|<= 0|`EINVAL`| -|any|any|`NULL`|any|any|`EINVAL`| +| key | base | compare | num | width | errno | +|---|---|---|---|---|---| +| `NULL` | any | any | any | any | `EINVAL` | +| any | `NULL` | any | != 0 | any | `EINVAL` | +| any | any | any | any | <= 0 | `EINVAL` | +| any | any | `NULL` | any | any | `EINVAL` | **`qsort_s`** has the same behavior as `qsort` but has the *`context`* parameter and sets `errno`. The *`context`* parameter allows comparison functions to use an object pointer to access object functionality or other information not accessible through an element pointer. The addition of the *`context`* parameter makes **`qsort_s`** more secure because *`context`* can be used to avoid reentrancy bugs introduced by using static variables to make shared information available to the *`compare`* function. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`qsort_s`**|\ and \| +| Routine | Required header | +|---|---| +| **`qsort_s`** | \ and \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/qsort.md b/docs/c-runtime-library/reference/qsort.md index fbe1e351449..83c657b30f6 100644 --- a/docs/c-runtime-library/reference/qsort.md +++ b/docs/c-runtime-library/reference/qsort.md @@ -50,11 +50,11 @@ compare( (void *) & elem1, (void *) & elem2 ); The routine compares the elements and returns one of the following values. -|Compare function return value|Description| -|-----------------------------------|-----------------| -|< 0|**`elem1`** less than **`elem2`**| -|0|**`elem1`** equivalent to **`elem2`**| -|> 0|**`elem1`** greater than **`elem2`**| +| Compare function return value | Description | +|---|---| +| < 0 | **`elem1`** less than **`elem2`** | +| 0 | **`elem1`** equivalent to **`elem2`** | +| > 0 | **`elem1`** greater than **`elem2`** | The array is sorted in increasing order, as defined by the comparison function. To sort an array in decreasing order, reverse the sense of "greater than" and "less than" in the comparison function. @@ -64,9 +64,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`qsort`**|`` and ``| +| Routine | Required header | +|---|---| +| **`qsort`** | `` and `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/query-new-handler.md b/docs/c-runtime-library/reference/query-new-handler.md index 1eb6cad8b7d..d78494f3fae 100644 --- a/docs/c-runtime-library/reference/query-new-handler.md +++ b/docs/c-runtime-library/reference/query-new-handler.md @@ -32,9 +32,9 @@ The C++ **`_query_new_handler`** function returns the address of the current exc ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_query_new_handler`**|\| +| Routine | Required header | +|---|---| +| **`_query_new_handler`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/query-new-mode.md b/docs/c-runtime-library/reference/query-new-mode.md index 549cc4be88a..d5feb921c31 100644 --- a/docs/c-runtime-library/reference/query-new-mode.md +++ b/docs/c-runtime-library/reference/query-new-mode.md @@ -32,9 +32,9 @@ The C++ **`_query_new_mode`** function returns an integer that indicates the **` ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_query_new_mode`**|\| +| Routine | Required header | +|---|---| +| **`_query_new_mode`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/quick-exit1.md b/docs/c-runtime-library/reference/quick-exit1.md index 2ddf7824cea..77eba98477c 100644 --- a/docs/c-runtime-library/reference/quick-exit1.md +++ b/docs/c-runtime-library/reference/quick-exit1.md @@ -41,9 +41,9 @@ After the registered functions have been called, **`quick_exit`** invokes `_Exit ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`quick_exit`**|\ or \| +| Routine | Required header | +|---|---| +| **`quick_exit`** | \ or \ | For more information about compatibility, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/raise.md b/docs/c-runtime-library/reference/raise.md index c89abf02cad..6135eabf602 100644 --- a/docs/c-runtime-library/reference/raise.md +++ b/docs/c-runtime-library/reference/raise.md @@ -37,14 +37,14 @@ If successful, **`raise`** returns 0. Otherwise, it returns a nonzero value. The **`raise`** function sends *`sig`* to the executing program. If a previous call to `signal` has installed a signal-handling function for *`sig`*, **`raise`** executes that function. If no handler function has been installed, the default action associated with the signal value *`sig`* is taken, as follows. -|Signal|Meaning|Default| -|------------|-------------|-------------| -|`SIGABRT`|Abnormal termination|Terminates the calling program with exit code 3| -|`SIGFPE`|Floating-point error|Terminates the calling program| -|`SIGILL`|Illegal instruction|Terminates the calling program| -|`SIGINT`|CTRL+C interrupt|Terminates the calling program| -|`SIGSEGV`|Illegal storage access|Terminates the calling program| -|`SIGTERM`|Termination request sent to the program|Ignores the signal| +| Signal | Description | Default behavior | +|---|---|---| +| `SIGABRT` | Abnormal termination | Terminates the calling program with exit code 3 | +| `SIGFPE` | Floating-point error | Terminates the calling program | +| `SIGILL` | Illegal instruction | Terminates the calling program | +| `SIGINT` | CTRL+C interrupt | Terminates the calling program | +| `SIGSEGV` | Illegal storage access | Terminates the calling program | +| `SIGTERM` | Termination request sent to the program | Ignores the signal | If the argument isn't a valid signal as specified above, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If not handled, the function sets `errno` to `EINVAL` and returns a nonzero value. @@ -52,9 +52,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`raise`**|\| +| Routine | Required header | +|---|---| +| **`raise`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rand-s.md b/docs/c-runtime-library/reference/rand-s.md index d3e14dc2632..a67942946aa 100644 --- a/docs/c-runtime-library/reference/rand-s.md +++ b/docs/c-runtime-library/reference/rand-s.md @@ -45,9 +45,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`rand_s`**|``| +| Routine | Required header | +|---|---| +| **`rand_s`** | `` | For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rand.md b/docs/c-runtime-library/reference/rand.md index bde561a4d5d..50d7aca158e 100644 --- a/docs/c-runtime-library/reference/rand.md +++ b/docs/c-runtime-library/reference/rand.md @@ -33,9 +33,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`rand`**|``| +| Routine | Required header | +|---|---| +| **`rand`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/read.md b/docs/c-runtime-library/reference/read.md index 80b188f55f2..58051d6e191 100644 --- a/docs/c-runtime-library/reference/read.md +++ b/docs/c-runtime-library/reference/read.md @@ -54,9 +54,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_read`**|``| +| Routine | Required header | +|---|---| +| **`_read`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/realloc-dbg.md b/docs/c-runtime-library/reference/realloc-dbg.md index 15214de34fe..ed270641f34 100644 --- a/docs/c-runtime-library/reference/realloc-dbg.md +++ b/docs/c-runtime-library/reference/realloc-dbg.md @@ -61,9 +61,9 @@ For information about how memory blocks are allocated, initialized, and managed ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_realloc_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_realloc_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/realloc.md b/docs/c-runtime-library/reference/realloc.md index 54eefd6131d..73162c4c323 100644 --- a/docs/c-runtime-library/reference/realloc.md +++ b/docs/c-runtime-library/reference/realloc.md @@ -68,9 +68,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`realloc`**|`` and ``| +| Routine | Required header | +|---|---| +| **`realloc`** | `` and `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/recalloc-dbg.md b/docs/c-runtime-library/reference/recalloc-dbg.md index 9f581936a29..dc7477217e7 100644 --- a/docs/c-runtime-library/reference/recalloc-dbg.md +++ b/docs/c-runtime-library/reference/recalloc-dbg.md @@ -67,9 +67,9 @@ For information about how memory blocks are allocated, initialized, and managed ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_recalloc_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_recalloc_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/recalloc.md b/docs/c-runtime-library/reference/recalloc.md index aa70120dd8d..703ba37d48f 100644 --- a/docs/c-runtime-library/reference/recalloc.md +++ b/docs/c-runtime-library/reference/recalloc.md @@ -69,9 +69,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_recalloc`**|\ and \| +| Routine | Required header | +|---|---| +| **`_recalloc`** | \ and \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/remainder-remainderf-remainderl.md b/docs/c-runtime-library/reference/remainder-remainderf-remainderl.md index 7b905165410..f7011eba881 100644 --- a/docs/c-runtime-library/reference/remainder-remainderf-remainderl.md +++ b/docs/c-runtime-library/reference/remainder-remainderf-remainderl.md @@ -50,10 +50,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header (C)|Required header (C++)| -|--------------|---------------------|-| -|**`remainder`**, **`remainderf`**, **`remainderl`**|\|\ or \| -|**`remainder`** macro | \ || +| Function | Required header (C) | Required header (C++) | +|---|---|---| +| **`remainder`**, **`remainderf`**, **`remainderl`** | \ | \ or \ | +| **`remainder`** macro | \ | | For compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/remove-wremove.md b/docs/c-runtime-library/reference/remove-wremove.md index ec451031773..42b3cc2cf0f 100644 --- a/docs/c-runtime-library/reference/remove-wremove.md +++ b/docs/c-runtime-library/reference/remove-wremove.md @@ -43,16 +43,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tremove`**|**`remove`**|**`remove`**|**`_wremove`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tremove` | **`remove`** | **`remove`** | **`_wremove`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`remove`**|`` or ``| -|**`_wremove`**|`` or ``| +| Routine | Required header | +|---|---| +| **`remove`** | `` or `` | +| **`_wremove`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/remquo-remquof-remquol.md b/docs/c-runtime-library/reference/remquo-remquof-remquol.md index 75f125e80ea..744555ef579 100644 --- a/docs/c-runtime-library/reference/remquo-remquof-remquol.md +++ b/docs/c-runtime-library/reference/remquo-remquof-remquol.md @@ -53,10 +53,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|Required header (C)|Required header (C++)| -|--------------|---------------------|-| -|**`remquo`**, **`remquof`**, **`remquol`**|\|\ or \| -|**`remquo`** macro | \ || +| Function | Required header (C) | Required header (C++) | +|---|---|---| +| **`remquo`**, **`remquof`**, **`remquol`** | \ | \ or \ | +| **`remquo`** macro | \ | | For compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rename-wrename.md b/docs/c-runtime-library/reference/rename-wrename.md index a88ac8fece2..7fcd7a12ba0 100644 --- a/docs/c-runtime-library/reference/rename-wrename.md +++ b/docs/c-runtime-library/reference/rename-wrename.md @@ -39,8 +39,8 @@ Pointer to new name. Each of these functions returns 0 if it's successful. On an error, the function returns a nonzero value and sets `errno` to one of the following values: -|errno value|Condition| -|-|-| +| `errno` value | Condition | +|---|---| | `EACCES` | File or directory specified by *`newname`* already exists or couldn't be created (invalid path); or *`oldname`* is a directory and *`newname`* specifies a different path. | | `ENOENT` | File or path specified by *`oldname`* not found. | | `EINVAL` | Name contains invalid characters. | @@ -57,16 +57,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_trename`**|**`rename`**|**`rename`**|**`_wrename`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_trename` | **`rename`** | **`rename`** | **`_wrename`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`rename`**|`` or ``| -|**`_wrename`**|`` or ``| +| Routine | Required header | +|---|---| +| **`rename`** | `` or `` | +| **`_wrename`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/resetstkoflw.md b/docs/c-runtime-library/reference/resetstkoflw.md index f39339cd641..e8c87354c1f 100644 --- a/docs/c-runtime-library/reference/resetstkoflw.md +++ b/docs/c-runtime-library/reference/resetstkoflw.md @@ -79,9 +79,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_resetstkoflw`**|\| +| Routine | Required header | +|---|---| +| **`_resetstkoflw`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rewind.md b/docs/c-runtime-library/reference/rewind.md index 990de8089bf..d414499cc0e 100644 --- a/docs/c-runtime-library/reference/rewind.md +++ b/docs/c-runtime-library/reference/rewind.md @@ -45,9 +45,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`rewind`**|\| +| Routine | Required header | +|---|---| +| **`rewind`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rint-rintf-rintl.md b/docs/c-runtime-library/reference/rint-rintf-rintl.md index 9d15db8f9b8..7eb918bb199 100644 --- a/docs/c-runtime-library/reference/rint-rintf-rintl.md +++ b/docs/c-runtime-library/reference/rint-rintf-rintl.md @@ -35,10 +35,10 @@ The floating-point value to round. The **`rint`** functions return a floating-point value that represents the nearest integer to *`x`*. Halfway values are rounded according to the current setting of the floating-point rounding mode, the same as the `nearbyint` functions. Unlike the `nearbyint` functions, the **`rint`** functions may raise the `FE_INEXACT` floating-point exception if the result differs in value from the argument. There's no error return. -|Input|SEH Exception|`_matherr` Exception| -|-----------|-------------------|--------------------------| -|± ∞, QNAN, IND|none|none| -|Denormals|EXCEPTION_FLT_UNDERFLOW|none| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± INF, QNaN, IND | none | none | +| Denormals | `EXCEPTION_FLT_UNDERFLOW` | none | ## Remarks @@ -50,10 +50,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`rint`**, **`rintf`**, **`rintl`**|\|\| -|**`rint`** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`rint`**, **`rintf`**, **`rintl`** | \ | \ | +| **`rint`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rmdir-wrmdir.md b/docs/c-runtime-library/reference/rmdir-wrmdir.md index 71110b7c90f..7482303c1d7 100644 --- a/docs/c-runtime-library/reference/rmdir-wrmdir.md +++ b/docs/c-runtime-library/reference/rmdir-wrmdir.md @@ -34,8 +34,8 @@ Path of the directory to be removed. Each of these functions returns 0 if the directory is successfully deleted. A return value of -1 indicates an error and `errno` is set to one of the following values: -|errno value|Condition| -|-|-| +| `errno` value | Condition | +|---|---| | `ENOTEMPTY` | Given path isn't a directory, the directory isn't empty, or the directory is either the current working directory or the root directory. | | `ENOENT` | Path is invalid. | | `EACCES` | A program has an open handle to the directory. | @@ -52,16 +52,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_trmdir`|**`_rmdir`**|**`_rmdir`**|**`_wrmdir`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_trmdir` | **`_rmdir`** | **`_rmdir`** | **`_wrmdir`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_rmdir`**|\| -|**`_wrmdir`**|\ or \| +| Routine | Required header | +|---|---| +| **`_rmdir`** | \ | +| **`_wrmdir`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rmtmp.md b/docs/c-runtime-library/reference/rmtmp.md index bd6ddd4980d..e373fe0ca11 100644 --- a/docs/c-runtime-library/reference/rmtmp.md +++ b/docs/c-runtime-library/reference/rmtmp.md @@ -33,9 +33,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_rmtmp`**|\| +| Routine | Required header | +|---|---| +| **`_rmtmp`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rotl-rotl64-rotr-rotr64.md b/docs/c-runtime-library/reference/rotl-rotl64-rotr-rotr64.md index 6dffc508ebc..dfdbaae96f2 100644 --- a/docs/c-runtime-library/reference/rotl-rotl64-rotr-rotr64.md +++ b/docs/c-runtime-library/reference/rotl-rotl64-rotr-rotr64.md @@ -54,10 +54,10 @@ The **`_rotl`** and **`_rotr`** functions rotate the unsigned *`value`* by *`shi ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_rotl`**, **`_rotl64`**|\| -|**`_rotr`**, **`_rotr64`**|\| +| Routine | Required header | +|---|---| +| **`_rotl`**, **`_rotl64`** | \ | +| **`_rotr`**, **`_rotr64`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/round-roundf-roundl.md b/docs/c-runtime-library/reference/round-roundf-roundl.md index 3bc969dd9bd..fd072b1e7f2 100644 --- a/docs/c-runtime-library/reference/round-roundf-roundl.md +++ b/docs/c-runtime-library/reference/round-roundf-roundl.md @@ -44,9 +44,9 @@ The floating-point value to round. The **`round`** functions return a floating-point value that represents the nearest integer to *`x`*. Halfway values are rounded away from zero, regardless of the setting of the floating-point rounding mode. There's no error return. -|Input|SEH Exception|`Matherr` Exception| -|-----------|-------------------|-----------------------| -|± QNAN, IND|none|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | `_DOMAIN` | ## Remarks @@ -58,10 +58,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`round`**, **`roundf`**, **`roundl`**|``| -|**`round`** macro | `` | +| Routine | Required header | +|---|---| +| **`round`**, **`roundf`**, **`roundl`** | `` | +| **`round`** macro | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rpt-rptf-rptw-rptfw-macros.md b/docs/c-runtime-library/reference/rpt-rptf-rptw-rptfw-macros.md index 94398fbc025..e8c4e0bcf06 100644 --- a/docs/c-runtime-library/reference/rpt-rptf-rptw-rptfw-macros.md +++ b/docs/c-runtime-library/reference/rpt-rptf-rptw-rptfw-macros.md @@ -63,11 +63,11 @@ The `_RPT` macros call the [`_CrtDbgReport`](crtdbgreport-crtdbgreportw.md) func If an `_RPT` macro is called, and `_CrtSetReportMode` and `_CrtSetReportFile` haven't been called, messages are displayed as follows: -|Report type|Output destination| -|-----------------|------------------------| -|`_CRT_WARN`|Warning text isn't displayed.| -|`_CRT_ERROR`|A pop-up window. Same as if `_CrtSetReportMode(_CRT_ERROR, _CRTDBG_MODE_WNDW);` had been specified.| -|`_CRT_ASSERT`|Same as `_CRT_ERROR`.| +| Report type | Output destination | +|---|---| +| `_CRT_WARN` | Warning text isn't displayed. | +| `_CRT_ERROR` | A pop-up window. Same as if `_CrtSetReportMode(_CRT_ERROR, _CRTDBG_MODE_WNDW);` had been specified. | +| `_CRT_ASSERT` | Same as `_CRT_ERROR`. | When the destination is a debug message window and the user chooses the **Retry** button, `_CrtDbgReport` or `_CrtDbgReportW` returns 1. This return value causes these macros to start the debugger, if just-in-time (JIT) debugging is enabled. For more information about using these macros as a debugging error handling mechanism, see [Using macros for verification and reporting](/visualstudio/debugger/macros-for-reporting). @@ -75,12 +75,12 @@ Two other macros exist that generate a debug report. The [`_ASSERT`](assert-asse ## Requirements -|Macro|Required header| -|-----------|---------------------| -|`_RPT` macros|\| -|`_RPTF` macros|\| -|`_RPTW` macros|\| -|`_RPTFW` macros|\| +| Macro | Required header | +|---|---| +| `_RPT` macros | \ | +| `_RPTF` macros | \ | +| `_RPTW` macros | \ | +| `_RPTFW` macros | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rtc-geterrdesc.md b/docs/c-runtime-library/reference/rtc-geterrdesc.md index 065ce001c60..74eb5e71941 100644 --- a/docs/c-runtime-library/reference/rtc-geterrdesc.md +++ b/docs/c-runtime-library/reference/rtc-geterrdesc.md @@ -33,9 +33,9 @@ A character string that contains a short description of one of the error types d ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_RTC_GetErrDesc`**|\| +| Routine | Required header | +|---|---| +| **`_RTC_GetErrDesc`** | \ | For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rtc-numerrors.md b/docs/c-runtime-library/reference/rtc-numerrors.md index 5d1e1ff52c6..d512c8f4027 100644 --- a/docs/c-runtime-library/reference/rtc-numerrors.md +++ b/docs/c-runtime-library/reference/rtc-numerrors.md @@ -27,9 +27,9 @@ An integer whose value represents the total number of errors that can be detecte ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_RTC_NumErrors`**|\| +| Routine | Required header | +|---|---| +| **`_RTC_NumErrors`** | \ | For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rtc-seterrorfunc.md b/docs/c-runtime-library/reference/rtc-seterrorfunc.md index 3dc255ce04a..decf0fe6e55 100644 --- a/docs/c-runtime-library/reference/rtc-seterrorfunc.md +++ b/docs/c-runtime-library/reference/rtc-seterrorfunc.md @@ -37,9 +37,9 @@ Don't use this function; instead, use `_RTC_SetErrorFuncW`. It's retained only f ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_RTC_SetErrorFunc`**|\| +| Routine | Required header | +|---|---| +| **`_RTC_SetErrorFunc`** | \ | For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rtc-seterrorfuncw.md b/docs/c-runtime-library/reference/rtc-seterrorfuncw.md index fbd4e9f18d3..5505a8b5427 100644 --- a/docs/c-runtime-library/reference/rtc-seterrorfuncw.md +++ b/docs/c-runtime-library/reference/rtc-seterrorfuncw.md @@ -76,9 +76,9 @@ For an example that shows how to use `_RTC_error_fnW`, see [Native runtime check ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_RTC_SetErrorFuncW`**|\| +| Routine | Required header | +|---|---| +| **`_RTC_SetErrorFuncW`** | \ | For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/rtc-seterrortype.md b/docs/c-runtime-library/reference/rtc-seterrortype.md index fd2d964ba8f..29ed6bd05db 100644 --- a/docs/c-runtime-library/reference/rtc-seterrortype.md +++ b/docs/c-runtime-library/reference/rtc-seterrortype.md @@ -45,9 +45,9 @@ Before you can call this function, you must first call one of the run-time error ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_RTC_SetErrorType`**|\| +| Routine | Required header | +|---|---| +| **`_RTC_SetErrorType`** | \ | For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/scalb.md b/docs/c-runtime-library/reference/scalb.md index b5ab0242ed5..8ea6e2c29a6 100644 --- a/docs/c-runtime-library/reference/scalb.md +++ b/docs/c-runtime-library/reference/scalb.md @@ -48,9 +48,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_scalb`**, **`_scalbf`**|``| +| Routine | Required header | +|---|---| +| **`_scalb`**, **`_scalbf`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md b/docs/c-runtime-library/reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md index f1cef7e4371..bf06b8aba2e 100644 --- a/docs/c-runtime-library/reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md +++ b/docs/c-runtime-library/reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md @@ -92,10 +92,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`scalbn`**, **`scalbnf`**, **`scalbnl`**, **`scalbln`**, **`scalblnf`**, **`scalblnl`**|\|\| -|**scalbn() or scalbln** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`scalbn`**, **`scalbnf`**, **`scalbnl`**, **`scalbln`**, **`scalblnf`**, **`scalblnl`** | \ | \ | +| **`scalbn`** or **`scalbln`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/scanf-s-scanf-s-l-wscanf-s-wscanf-s-l.md b/docs/c-runtime-library/reference/scanf-s-scanf-s-l-wscanf-s-wscanf-s-l.md index c7140add51a..db73e93f9df 100644 --- a/docs/c-runtime-library/reference/scanf-s-scanf-s-l-wscanf-s-wscanf-s-l.md +++ b/docs/c-runtime-library/reference/scanf-s-scanf-s-l-wscanf-s-wscanf-s-l.md @@ -101,19 +101,19 @@ For more information, see [`scanf` Width Specification](../scanf-width-specifica ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tscanf_s`**|**`scanf_s`**|**`scanf_s`**|**`wscanf_s`**| -|**`_tscanf_s_l`**|**`_scanf_s_l`**|**`_scanf_s_l`**|**`_wscanf_s_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tscanf_s` | **`scanf_s`** | **`scanf_s`** | **`wscanf_s`** | +| `_tscanf_s_l` | **`_scanf_s_l`** | **`_scanf_s_l`** | **`_wscanf_s_l`** | For more information, see [Format specification fields: `scanf` and `wscanf` functions](../format-specification-fields-scanf-and-wscanf-functions.md). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`scanf_s`**, **`_scanf_s_l`**|``| -|**`wscanf_s`**, **`_wscanf_s_l`**|`` or ``| +| Routine | Required header | +|---|---| +| **`scanf_s`**, **`_scanf_s_l`** | `` | +| **`wscanf_s`**, **`_wscanf_s_l`** | `` or `` | The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles **`stdin`**, **`stdout`**, and **`stderr`** must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/scanf-scanf-l-wscanf-wscanf-l.md b/docs/c-runtime-library/reference/scanf-scanf-l-wscanf-wscanf-l.md index 843b255f40b..2cc46c3217e 100644 --- a/docs/c-runtime-library/reference/scanf-scanf-l-wscanf-wscanf-l.md +++ b/docs/c-runtime-library/reference/scanf-scanf-l-wscanf-wscanf-l.md @@ -72,7 +72,7 @@ The versions of these functions with the **`_l`** suffix are identical except th ### Generic-text routine mappings -| `TCHAR.H` routine | `_UNICODE` & `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | |---|---|---|---| | **`_tscanf`** | **`scanf`** | **`scanf`** | **`wscanf`** | | **`_tscanf_l`** | **`_scanf_l`** | **`_scanf_l`** | **`_wscanf_l`** | diff --git a/docs/c-runtime-library/reference/scprintf-p-scprintf-p-l-scwprintf-p-scwprintf-p-l.md b/docs/c-runtime-library/reference/scprintf-p-scprintf-p-l-scwprintf-p-scwprintf-p-l.md index ac24b44f25f..8456b644e99 100644 --- a/docs/c-runtime-library/reference/scprintf-p-scprintf-p-l-scwprintf-p-scwprintf-p-l.md +++ b/docs/c-runtime-library/reference/scprintf-p-scprintf-p-l-scwprintf-p-scwprintf-p-l.md @@ -70,17 +70,17 @@ The versions of these functions with the `_l` suffix are identical except that t ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_sctprintf_p`|**`_scprintf_p`**|**`_scprintf_p`**|**`_scwprintf_p`**| -|`_sctprintf_p_l`|**`_scprintf_p_l`**|**`_scprintf_p_l`**|**`_scwprintf_p_l`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_sctprintf_p` | **`_scprintf_p`** | **`_scprintf_p`** | **`_scwprintf_p`** | +| `_sctprintf_p_l` | **`_scprintf_p_l`** | **`_scprintf_p_l`** | **`_scwprintf_p_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_scprintf_p`**, **`_scprintf_p_l`**|\| -|**`_scwprintf_p`**, **`_scwprintf_p_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`_scprintf_p`**, **`_scprintf_p_l`** | \ | +| **`_scwprintf_p`**, **`_scwprintf_p_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/scprintf-scprintf-l-scwprintf-scwprintf-l.md b/docs/c-runtime-library/reference/scprintf-scprintf-l-scwprintf-scwprintf-l.md index 8145abc60a5..49789f506dc 100644 --- a/docs/c-runtime-library/reference/scprintf-scprintf-l-scwprintf-scwprintf-l.md +++ b/docs/c-runtime-library/reference/scprintf-scprintf-l-scwprintf-scwprintf-l.md @@ -70,17 +70,17 @@ The versions of these functions with the `_l` suffix are identical except that t ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_sctprintf`|**`_scprintf`**|**`_scprintf`**|**`_scwprintf`**| -|`_sctprintf_l`|**`_scprintf_l`**|**`_scprintf_l`**|**`_scwprintf_l`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_sctprintf` | **`_scprintf`** | **`_scprintf`** | **`_scwprintf`** | +| `_sctprintf_l` | **`_scprintf_l`** | **`_scprintf_l`** | **`_scwprintf_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_scprintf`**, **`_scprintf_l`**|\| -|**`_scwprintf`**, **`_scwprintf_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`_scprintf`**, **`_scprintf_l`** | \ | +| **`_scwprintf`**, **`_scwprintf_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/searchenv-s-wsearchenv-s.md b/docs/c-runtime-library/reference/searchenv-s-wsearchenv-s.md index 39dedda7a64..b9db0489999 100644 --- a/docs/c-runtime-library/reference/searchenv-s-wsearchenv-s.md +++ b/docs/c-runtime-library/reference/searchenv-s-wsearchenv-s.md @@ -68,11 +68,11 @@ If *`filename`* is an empty string, the return value is `ENOENT`. ### Error conditions -|*`filename`*|*`varname`*|*`pathname`*|*`numberOfElements`*|Return value|Contents of *`pathname`*| -|----------------|---------------|----------------|------------------------|------------------|----------------------------| -|any|any|`NULL`|any|`EINVAL`|n/a| -|`NULL`|any|any|any|`EINVAL`|not changed| -|any|any|any|<= 0|`EINVAL`|not changed| +| *`filename`* | *`varname`* | *`pathname`* | *`numberOfElements`* | Return value | Contents of *`pathname`* | +|---|---|---|---|---|---| +| any | any | `NULL` | any | `EINVAL` | n/a | +| `NULL` | any | any | any | `EINVAL` | not changed | +| any | any | any | <= 0 | `EINVAL` | not changed | If any of these error conditions occurs, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions set `errno` to `EINVAL` and return `EINVAL`. @@ -92,16 +92,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tsearchenv_s`|**`_searchenv_s`**|**`_searchenv_s`**|**`_wsearchenv_s`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tsearchenv_s` | **`_searchenv_s`** | **`_searchenv_s`** | **`_wsearchenv_s`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_searchenv_s`**|\| -|**`_wsearchenv_s`**|\ or \| +| Routine | Required header | +|---|---| +| **`_searchenv_s`** | \ | +| **`_wsearchenv_s`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/searchenv-wsearchenv.md b/docs/c-runtime-library/reference/searchenv-wsearchenv.md index 7ee0bad5d52..86859fde51c 100644 --- a/docs/c-runtime-library/reference/searchenv-wsearchenv.md +++ b/docs/c-runtime-library/reference/searchenv-wsearchenv.md @@ -77,16 +77,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tsearchenv`|**`_searchenv`**|**`_searchenv`**|**`_wsearchenv`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tsearchenv` | **`_searchenv`** | **`_searchenv`** | **`_wsearchenv`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_searchenv`**|\| -|**`_wsearchenv`**|\ or \| +| Routine | Required header | +|---|---| +| **`_searchenv`** | \ | +| **`_wsearchenv`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/security-init-cookie.md b/docs/c-runtime-library/reference/security-init-cookie.md index 3df58937782..d7a8743b593 100644 --- a/docs/c-runtime-library/reference/security-init-cookie.md +++ b/docs/c-runtime-library/reference/security-init-cookie.md @@ -33,9 +33,9 @@ See the examples in [C Runtime Error R6035](../../error-messages/tool-errors/c-r ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`__security_init_cookie`**|``| +| Routine | Required header | +|---|---| +| **`__security_init_cookie`** | `` | **`__security_init_cookie`** is a Microsoft extension to the standard C Runtime Library. For compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/seh-filter-dll-seh-filter-exe.md b/docs/c-runtime-library/reference/seh-filter-dll-seh-filter-exe.md index c96b83116be..312690bf0b4 100644 --- a/docs/c-runtime-library/reference/seh-filter-dll-seh-filter-exe.md +++ b/docs/c-runtime-library/reference/seh-filter-dll-seh-filter-exe.md @@ -43,18 +43,18 @@ An integer that indicates the action to be taken, based on the result of excepti These methods are called by the exception-filter expression of the [try-except Statement](../../cpp/try-except-statement.md). The method consults a constant internal table to identify the exception and determine the appropriate action, as shown here. The exception numbers are defined in winnt.h and the signal numbers are defined in signal.h. -|Exception Number (unsigned long)|Signal Number| -|----------------------------------------|-------------------| -|STATUS_ACCESS_VIOLATION|SIGSEGV| -|STATUS_ILLEGAL_INSTRUCTION|SIGILL| -|STATUS_PRIVILEGED_INSTRUCTION|SIGILL| -|STATUS_FLOAT_DENORMAL_OPERAND|SIGFPE| -|STATUS_FLOAT_DIVIDE_BY_ZERO|SIGFPE| -|STATUS_FLOAT_INEXACT_RESULT|SIGFPE| -|STATUS_FLOAT_INVALID_OPERATION|SIGFPE| -|STATUS_FLOAT_OVERFLOW|SIGFPE| -|STATUS_FLOAT_STACK_CHECK|SIGFPE| -|STATUS_FLOAT_UNDERFLOW|SIGFPE| +| Exception number (unsigned long) | Signal number | +|---|---| +| `STATUS_ACCESS_VIOLATION` | `SIGSEGV` | +| `STATUS_ILLEGAL_INSTRUCTION` | `SIGILL` | +| `STATUS_PRIVILEGED_INSTRUCTION` | `SIGILL` | +| `STATUS_FLOAT_DENORMAL_OPERAND` | `SIGFPE` | +| `STATUS_FLOAT_DIVIDE_BY_ZERO` | `SIGFPE` | +| `STATUS_FLOAT_INEXACT_RESULT` | `SIGFPE` | +| `STATUS_FLOAT_INVALID_OPERATION` | `SIGFPE` | +| `STATUS_FLOAT_OVERFLOW` | `SIGFPE` | +| `STATUS_FLOAT_STACK_CHECK` | `SIGFPE` | +| `STATUS_FLOAT_UNDERFLOW` | `SIGFPE` | 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). diff --git a/docs/c-runtime-library/reference/set-controlfp.md b/docs/c-runtime-library/reference/set-controlfp.md index 2596bb2cab3..b7cfc47680a 100644 --- a/docs/c-runtime-library/reference/set-controlfp.md +++ b/docs/c-runtime-library/reference/set-controlfp.md @@ -43,9 +43,9 @@ This function is deprecated when compiling with [/clr (Common Language Runtime C ## Requirements -|Routine|Required header|Compatibility| -|-------------|---------------------|-------------------| -|**`_set_controlfp`**|\|x86 processor only| +| Routine | Required header | Compatibility | +|---|---|---| +| **`_set_controlfp`** | \ | x86 processor only | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/set-doserrno.md b/docs/c-runtime-library/reference/set-doserrno.md index 5f4f70809c8..f583908e986 100644 --- a/docs/c-runtime-library/reference/set-doserrno.md +++ b/docs/c-runtime-library/reference/set-doserrno.md @@ -37,9 +37,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_set_doserrno`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_set_doserrno`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/set-errno.md b/docs/c-runtime-library/reference/set-errno.md index 9c68400b118..162ff5b1848 100644 --- a/docs/c-runtime-library/reference/set-errno.md +++ b/docs/c-runtime-library/reference/set-errno.md @@ -55,9 +55,9 @@ Oops: Illegal byte sequence ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_set_errno`**|\|\| +| Routine | Required header | Optional header | +|---|---|---| +| **`_set_errno`** | \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/set-error-mode.md b/docs/c-runtime-library/reference/set-error-mode.md index 396721d16d4..cdbce0d93f7 100644 --- a/docs/c-runtime-library/reference/set-error-mode.md +++ b/docs/c-runtime-library/reference/set-error-mode.md @@ -40,12 +40,12 @@ Controls the error output sink by setting the value of `__error_mode`. For examp The *`mode_val`* parameter can be set to one of the following values. -|Value|Description| -|---------------|-----------------| -|`_OUT_TO_DEFAULT`|Error sink is determined by `__app_type`.| -|`_OUT_TO_STDERR`|Error sink is a standard error.| -|`_OUT_TO_MSGBOX`|Error sink is a message box.| -|`_REPORT_ERRMODE`|Report the current `__error_mode` value.| +| Value | Description | +|---|---| +| `_OUT_TO_DEFAULT` | Error sink is determined by `__app_type`. | +| `_OUT_TO_STDERR` | Error sink is a standard error. | +| `_OUT_TO_MSGBOX` | Error sink is a message box. | +| `_REPORT_ERRMODE` | Report the current `__error_mode` value. | If a value is passed in other than the listed ones, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, **`_set_error_mode`** sets `errno` to `EINVAL` and returns -1. @@ -53,9 +53,9 @@ When it's used with an [`assert`](assert-macro-assert-wassert.md), **`_set_error ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_set_error_mode`**|\| +| Routine | Required header | +|---|---| +| **`_set_error_mode`** | \ | ## Example diff --git a/docs/c-runtime-library/reference/set-fmode.md b/docs/c-runtime-library/reference/set-fmode.md index 9d7ab22862e..537cd8c3a61 100644 --- a/docs/c-runtime-library/reference/set-fmode.md +++ b/docs/c-runtime-library/reference/set-fmode.md @@ -41,9 +41,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_set_fmode`**|\|\, \| +| Routine | Required header | Optional header | +|---|---|---| +| **`_set_fmode`** | \ | \, \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/set-invalid-parameter-handler-set-thread-local-invalid-parameter-handler.md b/docs/c-runtime-library/reference/set-invalid-parameter-handler-set-thread-local-invalid-parameter-handler.md index 5bbd22639b6..b80e217a940 100644 --- a/docs/c-runtime-library/reference/set-invalid-parameter-handler-set-thread-local-invalid-parameter-handler.md +++ b/docs/c-runtime-library/reference/set-invalid-parameter-handler-set-thread-local-invalid-parameter-handler.md @@ -58,9 +58,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_set_invalid_parameter_handler`**, **`_set_thread_local_invalid_parameter_handler`**|C: \

C++: \ or \| +| Routine | Required header | +|---|---| +| **`_set_invalid_parameter_handler`**, **`_set_thread_local_invalid_parameter_handler`** | C: \

C++: \ or \ | The **`_set_invalid_parameter_handler`** and **`_set_thread_local_invalid_parameter_handler`** functions are Microsoft-specific. For compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/set-new-mode.md b/docs/c-runtime-library/reference/set-new-mode.md index 1078477e910..99f91ea8ea9 100644 --- a/docs/c-runtime-library/reference/set-new-mode.md +++ b/docs/c-runtime-library/reference/set-new-mode.md @@ -45,9 +45,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_set_new_mode`**|\| +| Routine | Required header | +|---|---| +| **`_set_new_mode`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/set-printf-count-output.md b/docs/c-runtime-library/reference/set-printf-count-output.md index 7f5e5092155..dece4a51476 100644 --- a/docs/c-runtime-library/reference/set-printf-count-output.md +++ b/docs/c-runtime-library/reference/set-printf-count-output.md @@ -37,9 +37,9 @@ Because of security reasons, support for the **%n** format specifier is disabled ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_set_printf_count_output`**|\| +| Routine | Required header | +|---|---| +| **`_set_printf_count_output`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/set-se-translator.md b/docs/c-runtime-library/reference/set-se-translator.md index f2a6943ea6b..7a50b53d13e 100644 --- a/docs/c-runtime-library/reference/set-se-translator.md +++ b/docs/c-runtime-library/reference/set-se-translator.md @@ -54,9 +54,9 @@ When you use **`_set_se_translator`** from managed code (code compiled with `/cl ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_set_se_translator`**|``| +| Routine | Required header | +|---|---| +| **`_set_se_translator`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/set-sse2-enable.md b/docs/c-runtime-library/reference/set-sse2-enable.md index c6558f6958c..abf620f2a6b 100644 --- a/docs/c-runtime-library/reference/set-sse2-enable.md +++ b/docs/c-runtime-library/reference/set-sse2-enable.md @@ -60,9 +60,9 @@ The SSE2 implementation is only used if all exceptions are masked. Use [`_contro ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_set_SSE2_enable`**|\| +| Routine | Required header | +|---|---| +| **`_set_SSE2_enable`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/set-terminate-crt.md b/docs/c-runtime-library/reference/set-terminate-crt.md index e1c9d5b1932..3ad3c3e8ecf 100644 --- a/docs/c-runtime-library/reference/set-terminate-crt.md +++ b/docs/c-runtime-library/reference/set-terminate-crt.md @@ -50,9 +50,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`set_terminate`**|\| +| Routine | Required header | +|---|---| +| **`set_terminate`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/set-unexpected-crt.md b/docs/c-runtime-library/reference/set-unexpected-crt.md index 4c5a9eb3bc4..370eeb75bb8 100644 --- a/docs/c-runtime-library/reference/set-unexpected-crt.md +++ b/docs/c-runtime-library/reference/set-unexpected-crt.md @@ -49,9 +49,9 @@ There's a single **`set_unexpected`** handler for all dynamically linked DLLs or ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`set_unexpected`**|``| +| Routine | Required header | +|---|---| +| **`set_unexpected`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/setbuf.md b/docs/c-runtime-library/reference/setbuf.md index 15568c4f281..764f89efe79 100644 --- a/docs/c-runtime-library/reference/setbuf.md +++ b/docs/c-runtime-library/reference/setbuf.md @@ -41,9 +41,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`setbuf`**|\| +| Routine | Required header | +|---|---| +| **`setbuf`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/setjmp.md b/docs/c-runtime-library/reference/setjmp.md index 6c0ae30f599..b378023bd59 100644 --- a/docs/c-runtime-library/reference/setjmp.md +++ b/docs/c-runtime-library/reference/setjmp.md @@ -53,9 +53,9 @@ For more information, see [Using `setjmp` and `longjmp`](../../cpp/using-setjmp- ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`setjmp`**|\| +| Routine | Required header | +|---|---| +| **`setjmp`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/setlocale-wsetlocale.md b/docs/c-runtime-library/reference/setlocale-wsetlocale.md index 09f9d04238c..21b23d65055 100644 --- a/docs/c-runtime-library/reference/setlocale-wsetlocale.md +++ b/docs/c-runtime-library/reference/setlocale-wsetlocale.md @@ -53,26 +53,26 @@ sets all categories, returning only the string en-US ``` -You can copy the string returned by `setlocale` to restore that part of the program's locale information. Global or thread local storage is used for the string returned by `setlocale`. Later calls to `setlocale` overwrite the string, which invalidates string pointers returned by earlier calls. +You can copy the string returned by **`setlocale`** to restore that part of the program's locale information. Global or thread local storage is used for the string returned by **`setlocale`**. Later calls to **`setlocale`** overwrite the string, which invalidates string pointers returned by earlier calls. ## Remarks -Use the `setlocale` function to set, change, or query some or all of the current program locale information specified by *`locale`* and *`category`*. *`locale`* refers to the locality (country/region and language) for which you can customize certain aspects of your program. Some locale-dependent categories include the formatting of dates and the display format for monetary values. If you set *`locale`* to the default string for a language that has multiple forms supported on your computer, you should check the `setlocale` return value to see which language is in effect. For example, if you set *`locale`* to `"chinese"` the return value could be either `"chinese-simplified"` or `"chinese-traditional"`. +Use the **`setlocale`** function to set, change, or query some or all of the current program locale information specified by *`locale`* and *`category`*. *`locale`* refers to the locality (country/region and language) for which you can customize certain aspects of your program. Some locale-dependent categories include the formatting of dates and the display format for monetary values. If you set *`locale`* to the default string for a language that has multiple forms supported on your computer, you should check the **`setlocale`** return value to see which language is in effect. For example, if you set *`locale`* to `"chinese"` the return value could be either `"chinese-simplified"` or `"chinese-traditional"`. -`_wsetlocale` is a wide-character version of `setlocale`; the *`locale`* argument and return value of `_wsetlocale` are wide-character strings. `_wsetlocale` and `setlocale` behave identically otherwise. +**`_wsetlocale`** is a wide-character version of **`setlocale`**; the *`locale`* argument and return value of **`_wsetlocale`** are wide-character strings. **`_wsetlocale`** and **`setlocale`** behave identically otherwise. 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). ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tsetlocale`|`setlocale`|`setlocale`|`_wsetlocale`| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tsetlocale` | **`setlocale`** | **`setlocale`** | **`_wsetlocale`** | The *`category`* argument specifies the parts of a program's locale information that are affected. The macros used for *`category`* and the parts of the program they affect are as follows: -|*`category`* flag|Affects| -|-|-| +| *`category`* flag | Affects | +|---|---| | `LC_ALL` | All categories, as listed below. | | `LC_COLLATE` | The `strcoll`, `_stricoll`, `wcscoll`, `_wcsicoll`, `strxfrm`, `_strncoll`, `_strnicoll`, `_wcsncoll`, `_wcsnicoll`, and `wcsxfrm` functions. | | `LC_CTYPE` | The character-handling functions (except `isdigit`, `isxdigit`, `mbstowcs`, and `mbtowc`, which are unaffected). | @@ -88,9 +88,9 @@ At program startup, the equivalent of the following statement is executed: `setlocale( LC_ALL, "C" );` -The *`locale`* argument can take a locale name, a language string, a language string and country/region code, a code page, or a language string, country/region code, and code page. The available locale names, languages, country/region codes, and code pages include all the ones supported by the Windows NLS API. The set of locale names supported by `setlocale` is described in [Locale names, Languages, and Country/Region strings](../locale-names-languages-and-country-region-strings.md). The set of language and country/region strings supported by `setlocale` are listed in [Language strings](../language-strings.md) and [Country/Region strings](../country-region-strings.md). We recommend the locale name form for performance and for maintainability of locale strings embedded in code or serialized to storage. The locale name strings are less likely to be changed by an operating system update than the language and country/region name form. +The *`locale`* argument can take a locale name, a language string, a language string and country/region code, a code page, or a language string, country/region code, and code page. The available locale names, languages, country/region codes, and code pages include all the ones supported by the Windows NLS API. The set of locale names supported by **`setlocale`** is described in [Locale names, Languages, and Country/Region strings](../locale-names-languages-and-country-region-strings.md). The set of language and country/region strings supported by **`setlocale`** are listed in [Language strings](../language-strings.md) and [Country/Region strings](../country-region-strings.md). We recommend the locale name form for performance and for maintainability of locale strings embedded in code or serialized to storage. The locale name strings are less likely to be changed by an operating system update than the language and country/region name form. -A null pointer that's passed as the *`locale`* argument tells `setlocale` to query instead of to set the international environment. If the *`locale`* argument is a null pointer, the program's current locale setting isn't changed. Instead, `setlocale` returns a pointer to the string that's associated with the *`category`* of the thread's current locale. If the *`category`* argument is `LC_ALL`, the function returns a string that indicates the current setting of each category, separated by semicolons. For example, the sequence of calls +A null pointer that's passed as the *`locale`* argument tells **`setlocale`** to query instead of to set the international environment. If the *`locale`* argument is a null pointer, the program's current locale setting isn't changed. Instead, **`setlocale`** returns a pointer to the string that's associated with the *`category`* of the thread's current locale. If the *`category`* argument is `LC_ALL`, the function returns a string that indicates the current setting of each category, separated by semicolons. For example, the sequence of calls ```C // Set all categories and return "en-US" @@ -146,7 +146,7 @@ The following examples pertain to the `LC_ALL` category. Either of the strings " - `setlocale( LC_ALL, "" );` - Sets the locale to the language that's indicated by *``*, and uses the default country/region for the specified language and the user-default ANSI code page for that country/region as obtained from the host operating system. For example, the following calls to `setlocale` are functionally equivalent: + Sets the locale to the language that's indicated by *``*, and uses the default country/region for the specified language and the user-default ANSI code page for that country/region as obtained from the host operating system. For example, the following calls to **`setlocale`** are functionally equivalent: `setlocale( LC_ALL, "en-US" );` @@ -160,7 +160,7 @@ The following examples pertain to the `LC_ALL` category. Either of the strings " Sets the code page to the value indicated by *``*, together with the default country/region and language (as defined by the host operating system) for the specified code page. -The category must be either `LC_ALL` or `LC_CTYPE` to effect a change of code page. For example, if the default country/region and language of the host operating system are "`United States`" and "`English`", the following two calls to `setlocale` are functionally equivalent: +The category must be either `LC_ALL` or `LC_CTYPE` to effect a change of code page. For example, if the default country/region and language of the host operating system are "`United States`" and "`English`", the following two calls to **`setlocale`** are functionally equivalent: `setlocale( LC_ALL, ".1252" );` @@ -168,11 +168,11 @@ The category must be either `LC_ALL` or `LC_CTYPE` to effect a change of code pa For more information, see the [`setlocale`](../../preprocessor/setlocale.md) pragma directive in the [C/C++ Preprocessor Reference](../../preprocessor/c-cpp-preprocessor-reference.md). -The function [`_configthreadlocale`](configthreadlocale.md) is used to control whether `setlocale` affects the locale of all threads in a program or only the locale of the calling thread. +The function [`_configthreadlocale`](configthreadlocale.md) is used to control whether **`setlocale`** affects the locale of all threads in a program or only the locale of the calling thread. ## UTF-8 support -Starting in Windows 10 version 1803 (10.0.17134.0), the Universal C Runtime supports using a UTF-8 code page. The change means that `char` strings passed to C runtime functions can expect strings in the UTF-8 encoding. To enable UTF-8 mode, use `".UTF8"` as the code page when using `setlocale`. For example, `setlocale(LC_ALL, ".UTF8")` will use the current default Windows ANSI code page (ACP) for the locale and UTF-8 for the code page. +Starting in Windows 10 version 1803 (10.0.17134.0), the Universal C Runtime supports using a UTF-8 code page. The change means that `char` strings passed to C runtime functions can expect strings in the UTF-8 encoding. To enable UTF-8 mode, use `".UTF8"` as the code page when using **`setlocale`**. For example, `setlocale(LC_ALL, ".UTF8")` will use the current default Windows ANSI code page (ACP) for the locale and UTF-8 for the code page. The string to specify UTF-8 mode is: @@ -195,16 +195,16 @@ UTF-8 mode is also enabled for functions that have historically translated `char The following aspects of the C Runtime can't use UTF-8 because they're set during program startup and must use the default Windows ANSI code page (ACP): [`__argv`](../argc-argv-wargv.md), [`_acmdln`](../acmdln-tcmdln-wcmdln.md), and [`_pgmptr`](../pgmptr-wpgmptr.md). -Previous to this support, [`mbrtoc16`, `mbrtoc32`](../reference/mbrtoc16-mbrtoc323.md), [`c16rtomb`, and `c32rtomb`](../reference/c16rtomb-c32rtomb1.md) existed to translate between UTF-8 narrow strings, UTF-16 (same encoding as `wchar_t` on Windows platforms) and UTF-32. For compatibility reasons, these APIs still only translate to and from UTF-8 and not the code page set via `setlocale`. +Previous to this support, [`mbrtoc16`, `mbrtoc32`](../reference/mbrtoc16-mbrtoc323.md), [`c16rtomb`, and `c32rtomb`](../reference/c16rtomb-c32rtomb1.md) existed to translate between UTF-8 narrow strings, UTF-16 (same encoding as `wchar_t` on Windows platforms) and UTF-32. For compatibility reasons, these APIs still only translate to and from UTF-8 and not the code page set via **`setlocale`**. To use this feature on an OS prior to Windows 10, you must use [app-local deployment](../../windows/universal-crt-deployment.md#local-deployment) or link statically using version 1803 (10.0.17134.0) of the Windows SDK or later. For Windows 10 operating systems prior to 1803 (10.0.17134.0), only static linking is supported. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`setlocale`|``| -|`_wsetlocale`|`` or ``| +| Routine | Required header | +|---|---| +| **`setlocale`** | `` | +| **`_wsetlocale`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/setmaxstdio.md b/docs/c-runtime-library/reference/setmaxstdio.md index 80e09d44436..d7d3b227fea 100644 --- a/docs/c-runtime-library/reference/setmaxstdio.md +++ b/docs/c-runtime-library/reference/setmaxstdio.md @@ -47,9 +47,9 @@ Because stream I/O-level functions, such as **`fopen`**, are built on top of the ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_setmaxstdio`**|``| +| Routine | Required header | +|---|---| +| **`_setmaxstdio`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/setmbcp.md b/docs/c-runtime-library/reference/setmbcp.md index 60a8f3e3642..a2b8777d63a 100644 --- a/docs/c-runtime-library/reference/setmbcp.md +++ b/docs/c-runtime-library/reference/setmbcp.md @@ -53,9 +53,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_setmbcp`**|\| +| Routine | Required header | +|---|---| +| **`_setmbcp`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/setmode.md b/docs/c-runtime-library/reference/setmode.md index 6d919444b78..9bf4f750618 100644 --- a/docs/c-runtime-library/reference/setmode.md +++ b/docs/c-runtime-library/reference/setmode.md @@ -57,9 +57,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header|Optional Headers| -|-------------|---------------------|----------------------| -|**`_setmode`**|``|``| +| Routine | Required header | Optional Headers | +|---|---|---| +| **`_setmode`** | `` | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/setvbuf.md b/docs/c-runtime-library/reference/setvbuf.md index a1b1d359e98..5314573b358 100644 --- a/docs/c-runtime-library/reference/setvbuf.md +++ b/docs/c-runtime-library/reference/setvbuf.md @@ -53,8 +53,8 @@ The **`setvbuf`** function allows the program to control both buffering and buff The mode must be `_IOFBF`, `_IOLBF`, or `_IONBF`. If *`mode`* is `_IOFBF` or `_IOLBF`, then *`size`* is used as the size of the buffer. If *`mode`* is `_IONBF`, the stream is unbuffered, and both *`size`* and *`buffer`* are ignored. Values for *`mode`* and their meanings are: -|*`mode`* value|Meaning| -|-|-| +| *`mode`* value | Meaning | +|---|---| | `_IOFBF` | Full buffering; that is, *`buffer`* is used as the buffer and *`size`* is used as the size of the buffer. If *`buffer`* is `NULL`, this mode uses an automatically allocated buffer that's *`size`* bytes long. | | `_IOLBF` | For some systems, this mode provides line buffering. However, for Win32, the behavior is the same as `_IOFBF` - Full Buffering. | | `_IONBF` | No buffer is used, regardless of *`buffer`* or *`size`*. | @@ -63,9 +63,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`setvbuf`**|\| +| Routine | Required header | +|---|---| +| **`setvbuf`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/signal.md b/docs/c-runtime-library/reference/signal.md index e7c1b7e812c..5c04a53d90b 100644 --- a/docs/c-runtime-library/reference/signal.md +++ b/docs/c-runtime-library/reference/signal.md @@ -40,14 +40,14 @@ For more information about return codes, see [`errno`, `_doserrno`, `_sys_errlis The **`signal`** function enables a process to choose one of several ways to handle an interrupt signal from the operating system. The *`sig`* argument is the interrupt to which **`signal`** responds; it must be one of the following manifest constants, which are defined in **`SIGNAL.H`**. -|*`sig`* value|Description| -|-----------------|-----------------| -|`SIGABRT`|Abnormal termination| -|`SIGFPE`|Floating-point error| -|`SIGILL`|Illegal instruction| -|`SIGINT`|CTRL+C signal| -|`SIGSEGV`|Illegal storage access| -|`SIGTERM`|Termination request| +| *`sig`* value | Description | +|---|---| +| `SIGABRT` | Abnormal termination | +| `SIGFPE` | Floating-point error | +| `SIGILL` | Illegal instruction | +| `SIGINT` | CTRL+C signal | +| `SIGSEGV` | Illegal storage access | +| `SIGTERM` | Termination request | If *`sig`* isn't one of the above values, the invalid parameter handler is invoked, as defined in [Parameter validation](../parameter-validation.md) . If execution is allowed to continue, this function sets `errno` to `EINVAL` and returns `SIG_ERR`. @@ -90,9 +90,9 @@ Signal settings aren't preserved in spawned processes that are created by calls ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`signal`**|``| +| Routine | Required header | +|---|---| +| **`signal`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/signbit.md b/docs/c-runtime-library/reference/signbit.md index 85aecf1528b..7030b5d1bf1 100644 --- a/docs/c-runtime-library/reference/signbit.md +++ b/docs/c-runtime-library/reference/signbit.md @@ -44,9 +44,9 @@ The floating-point value to test. ## Requirements -|Function|Required header (C)|Required header (C++)| -|--------------|---------------------------|-------------------------------| -|**`signbit`**|\|\ or \| +| Function | Required header (C) | Required header (C++) | +|---|---|---| +| **`signbit`** | \ | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/sin-sinf-sinl.md b/docs/c-runtime-library/reference/sin-sinf-sinl.md index b1d8d3f270f..743722880b8 100644 --- a/docs/c-runtime-library/reference/sin-sinf-sinl.md +++ b/docs/c-runtime-library/reference/sin-sinf-sinl.md @@ -36,10 +36,10 @@ Angle in radians. 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. -|Input|SEH Exception|`Matherr` Exception| -|-----------|-------------------|-----------------------| -|± `QNAN`,`IND`|None|`_DOMAIN`| -|± ∞ (`sin`, `sinf`, `sinl`)|`INVALID`|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | None | `_DOMAIN` | +| ± INF (`sin`, `sinf`, `sinl`) | `INVALID` | `_DOMAIN` | For more information about return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -53,10 +53,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header (C)|Required header (C++)| -|-|-|-| -|**`sin`**, **`sinf`**, **`sinl`**|``|`` or ``| -|**`sin()`** macro | `` || +| Routine | Required header (C) | Required header (C++) | +|---|---|---| +| **`sin`**, **`sinf`**, **`sinl`** | `` | `` or `` | +| **`sin`** macro | `` | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/sinh-sinhf-sinhl.md b/docs/c-runtime-library/reference/sinh-sinhf-sinhl.md index c6c8ea73c9b..6bd8e3dcf82 100644 --- a/docs/c-runtime-library/reference/sinh-sinhf-sinhl.md +++ b/docs/c-runtime-library/reference/sinh-sinhf-sinhl.md @@ -34,10 +34,10 @@ Angle in radians. The **`sinh`** functions return the hyperbolic sine of *`x`*. By default, if the result is too large, **`sinh`** sets `errno` to `ERANGE` and returns ±`HUGE_VAL`. -|Input|SEH exception|`Matherr` exception| -|-----------|-------------------|-----------------------| -|± `QNAN`,`IND`|None|`_DOMAIN`| -|`|x| ≥ 7.104760e+002`|`OVERFLOW+INEXACT`|`OVERFLOW`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | None | `_DOMAIN` | +| `|x| ≥ 7.104760e+002` | `OVERFLOW`+`INEXACT` | `OVERFLOW` | For more information about return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -51,10 +51,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header (C)|Required header (C++)| -|-|-|-| -|**`sinh`**, **`sinhf`**, **`sinhl`**|``|`` or ``| -|**`sinh()`** macro | `` || +| Routine | Required header (C) | Required header (C++) | +|---|---|---| +| **`sinh`**, **`sinhf`**, **`sinhl`** | `` | `` or `` | +| **`sinh`** macro | `` | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/snprintf-s-snprintf-s-l-snwprintf-s-snwprintf-s-l.md b/docs/c-runtime-library/reference/snprintf-s-snprintf-s-l-snwprintf-s-snwprintf-s-l.md index 34d2a460cb6..a187f9cac44 100644 --- a/docs/c-runtime-library/reference/snprintf-s-snprintf-s-l-snwprintf-s-snwprintf-s-l.md +++ b/docs/c-runtime-library/reference/snprintf-s-snprintf-s-l-snwprintf-s-snwprintf-s-l.md @@ -112,17 +112,17 @@ In C++, using these functions is simplified by template overloads; the overloads ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_sntprintf_s`**|**`_snprintf_s`**|**`_snprintf_s`**|**`_snwprintf_s`**| -|**`_sntprintf_s_l`**|**`_snprintf_s_l`**|**`_snprintf_s_l`**|**`_snwprintf_s_l`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_sntprintf_s` | **`_snprintf_s`** | **`_snprintf_s`** | **`_snwprintf_s`** | +| `_sntprintf_s_l` | **`_snprintf_s_l`** | **`_snprintf_s_l`** | **`_snwprintf_s_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_snprintf_s`**, **`_snprintf_s_l`**|``| -|**`_snwprintf_s`**, **`_snwprintf_s_l`**|`` or ``| +| Routine | Required header | +|---|---| +| **`_snprintf_s`**, **`_snprintf_s_l`** | `` | +| **`_snwprintf_s`**, **`_snwprintf_s_l`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md b/docs/c-runtime-library/reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md index 521548437e9..0d5234db5d9 100644 --- a/docs/c-runtime-library/reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md +++ b/docs/c-runtime-library/reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md @@ -134,17 +134,17 @@ In C++, these functions have template overloads that invoke the newer, more secu ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|**`_sntprintf`**|**`_snprintf`**|**`_snprintf`**|**`_snwprintf`**| -|**`_sntprintf_l`**|**`_snprintf_l`**|**`_snprintf_l`**|**`_snwprintf_l`**| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_sntprintf` | **`_snprintf`** | **`_snprintf`** | **`_snwprintf`** | +| `_sntprintf_l` | **`_snprintf_l`** | **`_snprintf_l`** | **`_snwprintf_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`snprintf`**, **`_snprintf`**, **`_snprintf_l`**|``| -|**`_snwprintf`**, **`_snwprintf_l`**|`` or ``| +| Routine | Required header | +|---|---| +| **`snprintf`**, **`_snprintf`**, **`_snprintf_l`** | `` | +| **`_snwprintf`**, **`_snwprintf_l`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/snscanf-s-snscanf-s-l-snwscanf-s-snwscanf-s-l.md b/docs/c-runtime-library/reference/snscanf-s-snscanf-s-l-snwscanf-s-snwscanf-s-l.md index 0ff5f7b807e..5b5fe1eb53e 100644 --- a/docs/c-runtime-library/reference/snscanf-s-snscanf-s-l-snwscanf-s-snwscanf-s-l.md +++ b/docs/c-runtime-library/reference/snscanf-s-snscanf-s-l-snwscanf-s-snwscanf-s-l.md @@ -79,17 +79,17 @@ The versions of these functions with the `_l` suffix are identical except that t ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_sntscanf_s`|**`_snscanf_s`**|**`_snscanf_s`**|**`_snwscanf_s`**| -|`_sntscanf_s_l`|**`_snscanf_s_l`**|**`_snscanf_s_l`**|**`_snwscanf_s_l`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_sntscanf_s` | **`_snscanf_s`** | **`_snscanf_s`** | **`_snwscanf_s`** | +| `_sntscanf_s_l` | **`_snscanf_s_l`** | **`_snscanf_s_l`** | **`_snwscanf_s_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_snscanf_s`**, **`_snscanf_s_l`**|\| -|**`_snwscanf_s`**, **`_snwscanf_s_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`_snscanf_s`**, **`_snscanf_s_l`** | \ | +| **`_snwscanf_s`**, **`_snwscanf_s_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/snscanf-snscanf-l-snwscanf-snwscanf-l.md b/docs/c-runtime-library/reference/snscanf-snscanf-l-snwscanf-snwscanf-l.md index c4aaeef817c..332bc229ee3 100644 --- a/docs/c-runtime-library/reference/snscanf-snscanf-l-snwscanf-snwscanf-l.md +++ b/docs/c-runtime-library/reference/snscanf-snscanf-l-snwscanf-snwscanf-l.md @@ -78,17 +78,17 @@ The versions of these functions with the `_l` suffix are identical except that t ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_sntscanf`|**`_snscanf`**|**`_snscanf`**|**`_snwscanf`**| -|`_sntscanf_l`|**`_snscanf_l`**|**`_snscanf_l`**|**`_snwscanf_l`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_sntscanf` | **`_snscanf`** | **`_snscanf`** | **`_snwscanf`** | +| `_sntscanf_l` | **`_snscanf_l`** | **`_snscanf_l`** | **`_snwscanf_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_snscanf`**, **`_snscanf_l`**|\| -|**`_snwscanf`**, **`_snwscanf_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`_snscanf`**, **`_snscanf_l`** | \ | +| **`_snwscanf`**, **`_snwscanf_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/spawnl-wspawnl.md b/docs/c-runtime-library/reference/spawnl-wspawnl.md index ebdb09c18e4..8cbc9171a7e 100644 --- a/docs/c-runtime-library/reference/spawnl-wspawnl.md +++ b/docs/c-runtime-library/reference/spawnl-wspawnl.md @@ -71,10 +71,10 @@ Each of these functions creates and executes a new process, passing each command ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_spawnl`**|\| -|**`_wspawnl`**|\ or \| +| Routine | Required header | +|---|---| +| **`_spawnl`** | \ | +| **`_wspawnl`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/spawnle-wspawnle.md b/docs/c-runtime-library/reference/spawnle-wspawnle.md index 2ff7688f376..74aeaa3b39a 100644 --- a/docs/c-runtime-library/reference/spawnle-wspawnle.md +++ b/docs/c-runtime-library/reference/spawnle-wspawnle.md @@ -76,10 +76,10 @@ These functions validate their parameters. If either *`cmdname`* or *`arg0`* is ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_spawnle`**|\| -|**`_wspawnle`**|\ or \| +| Routine | Required header | +|---|---| +| **`_spawnle`** | \ | +| **`_wspawnle`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/spawnlp-wspawnlp.md b/docs/c-runtime-library/reference/spawnlp-wspawnlp.md index 83742e2e1cf..d12f2116a1b 100644 --- a/docs/c-runtime-library/reference/spawnlp-wspawnlp.md +++ b/docs/c-runtime-library/reference/spawnlp-wspawnlp.md @@ -71,10 +71,10 @@ These functions validate their parameters. If either *`cmdname`* or *`arg0`* is ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_spawnlp`**|\| -|**`_wspawnlp`**|\ or \| +| Routine | Required header | +|---|---| +| **`_spawnlp`** | \ | +| **`_wspawnlp`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/spawnlpe-wspawnlpe.md b/docs/c-runtime-library/reference/spawnlpe-wspawnlpe.md index a71347b2400..ba64988fa69 100644 --- a/docs/c-runtime-library/reference/spawnlpe-wspawnlpe.md +++ b/docs/c-runtime-library/reference/spawnlpe-wspawnlpe.md @@ -76,10 +76,10 @@ These functions validate their parameters. If either *`cmdname`* or *`arg0`* is ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_spawnlpe`**|\| -|**`_wspawnlpe`**|\ or \| +| Routine | Required header | +|---|---| +| **`_spawnlpe`** | \ | +| **`_wspawnlpe`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/spawnv-wspawnv.md b/docs/c-runtime-library/reference/spawnv-wspawnv.md index 3b66e6b4281..d569cc9e5f9 100644 --- a/docs/c-runtime-library/reference/spawnv-wspawnv.md +++ b/docs/c-runtime-library/reference/spawnv-wspawnv.md @@ -67,10 +67,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_spawnv`**|\ or \| -|**`_wspawnv`**|\ or \| +| Routine | Required header | +|---|---| +| **`_spawnv`** | \ or \ | +| **`_wspawnv`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/spawnve-wspawnve.md b/docs/c-runtime-library/reference/spawnve-wspawnve.md index be3dd6ff9ee..7481e8af7cf 100644 --- a/docs/c-runtime-library/reference/spawnve-wspawnve.md +++ b/docs/c-runtime-library/reference/spawnve-wspawnve.md @@ -72,10 +72,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_spawnve`**|\ or \| -|**`_wspawnve`**|\ or \| +| Routine | Required header | +|---|---| +| **`_spawnve`** | \ or \ | +| **`_wspawnve`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/spawnvp-wspawnvp.md b/docs/c-runtime-library/reference/spawnvp-wspawnvp.md index 950eb261205..c47739ca306 100644 --- a/docs/c-runtime-library/reference/spawnvp-wspawnvp.md +++ b/docs/c-runtime-library/reference/spawnvp-wspawnvp.md @@ -67,10 +67,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_spawnvp`**|\ or \| -|**`_wspawnvp`**|\ or \| +| Routine | Required header | +|---|---| +| **`_spawnvp`** | \ or \ | +| **`_wspawnvp`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/spawnvpe-wspawnvpe.md b/docs/c-runtime-library/reference/spawnvpe-wspawnvpe.md index a4ab14074bd..38aa84f49c4 100644 --- a/docs/c-runtime-library/reference/spawnvpe-wspawnvpe.md +++ b/docs/c-runtime-library/reference/spawnvpe-wspawnvpe.md @@ -72,10 +72,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_spawnvpe`**|\ or \| -|**`_wspawnvpe`**|\ or \| +| Routine | Required header | +|---|---| +| **`_spawnvpe`** | \ or \ | +| **`_wspawnvpe`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/splitpath-s-wsplitpath-s.md b/docs/c-runtime-library/reference/splitpath-s-wsplitpath-s.md index adc249cf218..49ba5d660c4 100644 --- a/docs/c-runtime-library/reference/splitpath-s-wsplitpath-s.md +++ b/docs/c-runtime-library/reference/splitpath-s-wsplitpath-s.md @@ -92,17 +92,17 @@ Zero if successful; an error code on failure. ### Error conditions -|Condition|Return Value| -|---------------|------------------| -|*`path`* is `NULL`|`EINVAL`| -|*`drive`* is `NULL`, *`driveNumberOfElements`* is non-zero|`EINVAL`| -|*`drive`* is non-`NULL`, *`driveNumberOfElements`* is zero|`EINVAL`| -|*`dir`* is `NULL`, *`dirNumberOfElements`* is non-zero|`EINVAL`| -|*`dir`* is non-`NULL`, *`dirNumberOfElements`* is zero|`EINVAL`| -|*`fname`* is `NULL`, *`nameNumberOfElements`* is non-zero|`EINVAL`| -|*`fname`* is non-`NULL`, *`nameNumberOfElements`* is zero|`EINVAL`| -|*`ext`* is `NULL`, *`extNumberOfElements`* is non-zero|`EINVAL`| -|*`ext`* is non-`NULL`, *`extNumberOfElements`* is zero|`EINVAL`| +| Condition | Return value | +|---|---| +| *`path`* is `NULL` | `EINVAL` | +| *`drive`* is `NULL`, *`driveNumberOfElements`* is non-zero | `EINVAL` | +| *`drive`* is non-`NULL`, *`driveNumberOfElements`* is zero | `EINVAL` | +| *`dir`* is `NULL`, *`dirNumberOfElements`* is non-zero | `EINVAL` | +| *`dir`* is non-`NULL`, *`dirNumberOfElements`* is zero | `EINVAL` | +| *`fname`* is `NULL`, *`nameNumberOfElements`* is non-zero | `EINVAL` | +| *`fname`* is non-`NULL`, *`nameNumberOfElements`* is zero | `EINVAL` | +| *`ext`* is `NULL`, *`extNumberOfElements`* is non-zero | `EINVAL` | +| *`ext`* is non-`NULL`, *`extNumberOfElements`* is zero | `EINVAL` | If any of the above conditions occurs, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md) . If execution is allowed to continue, these functions set `errno` to `EINVAL` and return `EINVAL`. @@ -116,20 +116,20 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tsplitpath_s`**|**`_splitpath_s`**|**`_splitpath_s`**|**`_wsplitpath_s`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tsplitpath_s` | **`_splitpath_s`** | **`_splitpath_s`** | **`_wsplitpath_s`** | Each component of the full path is stored in a separate buffer; the manifest constants `_MAX_DRIVE`, `_MAX_DIR`, `_MAX_FNAME`, and `_MAX_EXT` (defined in `STDLIB.H`) specify the maximum allowable size for each file component. File components larger than the corresponding manifest constants cause heap corruption. The following table lists the values of the manifest constants. -|Name|Value| -|----------|-----------| -|`_MAX_DRIVE`|3| -|`_MAX_DIR`|256| -|`_MAX_FNAME`|256| -|`_MAX_EXT`|256| +| Name | Value | +|---|---| +| `_MAX_DRIVE` | 3 | +| `_MAX_DIR` | 256 | +| `_MAX_FNAME` | 256 | +| `_MAX_EXT` | 256 | If the full path doesn't contain a component (for example, a filename), **`_splitpath_s`** assigns an empty string to the corresponding buffer. @@ -139,10 +139,10 @@ The debug library versions of these functions first fill the buffer with 0xFE. T ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_splitpath_s`**|``| -|**`_wsplitpath_s`**|`` or ``| +| Routine | Required header | +|---|---| +| **`_splitpath_s`** | `` | +| **`_wsplitpath_s`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/splitpath-wsplitpath.md b/docs/c-runtime-library/reference/splitpath-wsplitpath.md index 44ab422d9f9..0e3b18466fe 100644 --- a/docs/c-runtime-library/reference/splitpath-wsplitpath.md +++ b/docs/c-runtime-library/reference/splitpath-wsplitpath.md @@ -60,9 +60,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tsplitpath`**|**`_splitpath`**|**`_splitpath`**|**`_wsplitpath`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tsplitpath` | **`_splitpath`** | **`_splitpath`** | **`_wsplitpath`** | Each component of the full path is stored in a separate buffer; the manifest constants `_MAX_DRIVE`, `_MAX_DIR`, `_MAX_FNAME`, and `_MAX_EXT` (defined in `STDLIB.H`) specify the maximum size for each file component. File components that are larger than the corresponding manifest constants cause heap corruption. @@ -70,12 +70,12 @@ Each buffer must be as large as its corresponding manifest constant to avoid pot The following table lists the values of the manifest constants. -|Name|Value| -|----------|-----------| -|`_MAX_DRIVE`|3| -|`_MAX_DIR`|256| -|`_MAX_FNAME`|256| -|`_MAX_EXT`|256| +| Name | Value | +|---|---| +| `_MAX_DRIVE` | 3 | +| `_MAX_DIR` | 256 | +| `_MAX_FNAME` | 256 | +| `_MAX_EXT` | 256 | If the full path doesn't contain a component (for example, a filename), **`_splitpath`** assigns empty strings to the corresponding buffers. @@ -85,10 +85,10 @@ If *`path`* is `NULL`, the invalid parameter handler is invoked, as described in ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_splitpath`**|``| -|**`_wsplitpath`**|`` or ``| +| Routine | Required header | +|---|---| +| **`_splitpath`** | `` | +| **`_wsplitpath`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/sprintf-p-sprintf-p-l-swprintf-p-swprintf-p-l.md b/docs/c-runtime-library/reference/sprintf-p-sprintf-p-l-swprintf-p-swprintf-p-l.md index 51d59aceda5..030e72c577d 100644 --- a/docs/c-runtime-library/reference/sprintf-p-sprintf-p-l-swprintf-p-swprintf-p-l.md +++ b/docs/c-runtime-library/reference/sprintf-p-sprintf-p-l-swprintf-p-swprintf-p-l.md @@ -80,17 +80,17 @@ The **`_sprintf_p`** function formats and stores a series of characters and valu ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_stprintf_p`**|**`_sprintf_p`**|**`_sprintf_p`**|**`_swprintf_p`**| -|**`_stprintf_p_l`**|**`_sprintf_p_l`**|**`_sprintf_p_l`**|**`_swprintf_p_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_stprintf_p` | **`_sprintf_p`** | **`_sprintf_p`** | **`_swprintf_p`** | +| `_stprintf_p_l` | **`_sprintf_p_l`** | **`_sprintf_p_l`** | **`_swprintf_p_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_sprintf_p`**, **`_sprintf_p_l`**|``| -|**`_swprintf_p`**, **`_swprintf_p_l`**|`` or ``| +| Routine | Required header | +|---|---| +| **`_sprintf_p`**, **`_sprintf_p_l`** | `` | +| **`_swprintf_p`**, **`_swprintf_p_l`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md b/docs/c-runtime-library/reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md index ac8e1d21fd3..5e3ff04ff2a 100644 --- a/docs/c-runtime-library/reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md +++ b/docs/c-runtime-library/reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md @@ -100,17 +100,17 @@ There are versions of **`sprintf_s`** that offer more control over what happens ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_stprintf_s`|**`sprintf_s`**|**`sprintf_s`**|**`swprintf_s`**| -|`_stprintf_s_l`|**`_sprintf_s_l`**|**`_sprintf_s_l`**|**`_swprintf_s_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_stprintf_s` | **`sprintf_s`** | **`sprintf_s`** | **`swprintf_s`** | +| `_stprintf_s_l` | **`_sprintf_s_l`** | **`_sprintf_s_l`** | **`_swprintf_s_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`sprintf_s`**, **`_sprintf_s_l`**|C: \

C++: \ or \| -|**`swprintf_s`**, **`_swprintf_s_l`**|C: \ or \

C++: \, \, \ or \| +| Routine | Required header | +|---|---| +| **`sprintf_s`**, **`_sprintf_s_l`** | C: \

C++: \ or \ | +| **`swprintf_s`**, **`_swprintf_s_l`** | C: \ or \

C++: \, \, \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md b/docs/c-runtime-library/reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md index db00de8c6a0..8fadaa493fd 100644 --- a/docs/c-runtime-library/reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md +++ b/docs/c-runtime-library/reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md @@ -103,17 +103,17 @@ In C++, these functions have template overloads that invoke the newer, secure co ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_stprintf`**|**`sprintf`**|**`sprintf`**|**`_swprintf`**| -|**`_stprintf_l`**|**`_sprintf_l`**|**`_sprintf_l`**|**`__swprintf_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_stprintf`** | **`sprintf`** | **`sprintf`** | **`_swprintf`** | +| **`_stprintf_l`** | **`_sprintf_l`** | **`_sprintf_l`** | **`__swprintf_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`sprintf`**, **`_sprintf_l`**|``| -|**`swprintf`**, **`_swprintf_l`**|`` or ``| +| Routine | Required header | +|---|---| +| **`sprintf`**, **`_sprintf_l`** | `` | +| **`swprintf`**, **`_swprintf_l`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/sqrt-sqrtf-sqrtl.md b/docs/c-runtime-library/reference/sqrt-sqrtf-sqrtl.md index 71bc41bfca3..08954ef8d2b 100644 --- a/docs/c-runtime-library/reference/sqrt-sqrtf-sqrtl.md +++ b/docs/c-runtime-library/reference/sqrt-sqrtf-sqrtl.md @@ -51,18 +51,18 @@ By default, this function's global state is scoped to the application. To change The **`sqrt`** functions return the square-root of *`x`*. By default, if *`x`* is negative, **`sqrt`** returns an indefinite `NaN`. -|Input|SEH Exception|**`_matherr`** Exception| -|-----------|-------------------|--------------------------| -|± `QNAN`,`IND`|none|`_DOMAIN`| -|- ∞|none|`_DOMAIN`| -|`x<0`|none|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | `_DOMAIN` | +| - INF | none | `_DOMAIN` | +| `x < 0` | none | `_DOMAIN` | ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`sqrt`**, **`sqrtf`**, **`sqrtl`**|``|``| -|**`sqrt()`** macro | `` || +| Function | C header | C++ header | +|---|---|---| +| **`sqrt`**, **`sqrtf`**, **`sqrtl`** | `` | `` | +| **`sqrt`** macro | `` | | For compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/srand.md b/docs/c-runtime-library/reference/srand.md index fb150ad01aa..ae624d195bd 100644 --- a/docs/c-runtime-library/reference/srand.md +++ b/docs/c-runtime-library/reference/srand.md @@ -34,9 +34,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`srand`**|``| +| Routine | Required header | +|---|---| +| **`srand`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/sscanf-s-sscanf-s-l-swscanf-s-swscanf-s-l.md b/docs/c-runtime-library/reference/sscanf-s-sscanf-s-l-swscanf-s-swscanf-s-l.md index fb496bb1158..36b42b032c4 100644 --- a/docs/c-runtime-library/reference/sscanf-s-sscanf-s-l-swscanf-s-swscanf-s-l.md +++ b/docs/c-runtime-library/reference/sscanf-s-sscanf-s-l-swscanf-s-swscanf-s-l.md @@ -101,17 +101,17 @@ The versions of these functions that have the **`_l`** suffix are identical exce ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_stscanf_s`**|**`sscanf_s`**|**`sscanf_s`**|**`swscanf_s`**| -|**`_stscanf_s_l`**|**`_sscanf_s_l`**|**`_sscanf_s_l`**|**`_swscanf_s_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_stscanf_s` | **`sscanf_s`** | **`sscanf_s`** | **`swscanf_s`** | +| `_stscanf_s_l` | **`_sscanf_s_l`** | **`_sscanf_s_l`** | **`_swscanf_s_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`sscanf_s`**, **`_sscanf_s_l`**|``| -|**`swscanf_s`**, **`_swscanf_s_l`**|`` or ``| +| Routine | Required header | +|---|---| +| **`sscanf_s`**, **`_sscanf_s_l`** | `` | +| **`swscanf_s`**, **`_swscanf_s_l`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/sscanf-sscanf-l-swscanf-swscanf-l.md b/docs/c-runtime-library/reference/sscanf-sscanf-l-swscanf-swscanf-l.md index ebe77e488f5..e51dab81d46 100644 --- a/docs/c-runtime-library/reference/sscanf-sscanf-l-swscanf-swscanf-l.md +++ b/docs/c-runtime-library/reference/sscanf-sscanf-l-swscanf-swscanf-l.md @@ -78,17 +78,17 @@ The versions of these functions with the **`_l`** suffix are identical except th ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_stscanf`**|**`sscanf`**|**`sscanf`**|**`swscanf`**| -|**`_stscanf_l`**|**`_sscanf_l`**|**`_sscanf_l`**|**`_swscanf_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_stscanf` | **`sscanf`** | **`sscanf`** | **`swscanf`** | +| `_stscanf_l` | **`_sscanf_l`** | **`_sscanf_l`** | **`_swscanf_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`sscanf`**, **`_sscanf_l`**|``| -|**`swscanf`**, **`_swscanf_l`**|`` or ``| +| Routine | Required header | +|---|---| +| **`sscanf`**, **`_sscanf_l`** | `` | +| **`swscanf`**, **`_swscanf_l`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/stat-functions.md b/docs/c-runtime-library/reference/stat-functions.md index fe38253d2dc..d2f410a4cce 100644 --- a/docs/c-runtime-library/reference/stat-functions.md +++ b/docs/c-runtime-library/reference/stat-functions.md @@ -102,31 +102,31 @@ By default, this function's global state is scoped to the application. To change ### Time type and file length type variations of `_stat` -|Functions|`_USE_32BIT_TIME_T` defined?|Time type|File length type| -|---------------|------------------------------------|---------------|----------------------| -|**`_stat`**, **`_wstat`**|Not defined|64-bit|32-bit| -|**`_stat`**, **`_wstat`**|Defined|32-bit|32-bit| -|**`_stat32`**, **`_wstat32`**|Not affected by the macro definition|32-bit|32-bit| -|**`_stat64`**, **`_wstat64`**|Not affected by the macro definition|64-bit|64-bit| -|**`_stati64`**, **`_wstati64`**|Not defined|64-bit|64-bit| -|**`_stati64`**, **`_wstati64`**|Defined|32-bit|64-bit| -|**`_stat32i64`**, **`_wstat32i64`**|Not affected by the macro definition|32-bit|64-bit| -|**`_stat64i32`**, **`_wstat64i32`**|Not affected by the macro definition|64-bit|32-bit| +| Functions | `_USE_32BIT_TIME_T` defined | Time type | File length type | +|---|---|---|---| +| **`_stat`**, **`_wstat`** | Not defined | 64-bit | 32-bit | +| **`_stat`**, **`_wstat`** | Defined | 32-bit | 32-bit | +| **`_stat32`**, **`_wstat32`** | Not affected by the macro definition | 32-bit | 32-bit | +| **`_stat64`**, **`_wstat64`** | Not affected by the macro definition | 64-bit | 64-bit | +| **`_stati64`**, **`_wstati64`** | Not defined | 64-bit | 64-bit | +| **`_stati64`**, **`_wstati64`** | Defined | 32-bit | 64-bit | +| **`_stat32i64`**, **`_wstat32i64`** | Not affected by the macro definition | 32-bit | 64-bit | +| **`_stat64i32`**, **`_wstat64i32`** | Not affected by the macro definition | 64-bit | 32-bit | ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tstat`**|**`_stat`**|**`_stat`**|**`_wstat`**| -|**`_tstat64`**|**`_stat64`**|**`_stat64`**|**`_wstat64`**| -|**`_tstati64`**|**`_stati64`**|**`_stati64`**|**`_wstati64`**| -|**`_tstat32i64`**|**`_stat32i64`**|**`_stat32i64`**|**`_wstat32i64`**| -|**`_tstat64i32`**|**`_stat64i32`**|**`_stat64i32`**|**`_wstat64i32`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tstat` | **`_stat`** | **`_stat`** | **`_wstat`** | +| `_tstat64` | **`_stat64`** | **`_stat64`** | **`_wstat64`** | +| `_tstati64` | **`_stati64`** | **`_stati64`** | **`_wstati64`** | +| `_tstat32i64` | **`_stat32i64`** | **`_stat32i64`** | **`_wstat32i64`** | +| `_tstat64i32` | **`_stat64i32`** | **`_stat64i32`** | **`_wstat64i32`** | The **`_stat`** structure, defined in **`SYS\STAT.H`**, includes the following fields. -|Field|Description| -|-|-| +| Field | Description | +|---|---| | **`st_gid`** | Numeric identifier of group that owns the file (UNIX-specific) This field will always be zero on Windows systems. A redirected file is classified as a Windows file. | | **`st_atime`** | Time of last access of file. Valid on NTFS but not on FAT formatted disk drives. | | **`st_ctime`** | Time of creation of file. Valid on NTFS but not on FAT formatted disk drives. | @@ -143,10 +143,10 @@ If *`path`* refers to a device, the **`st_size`**, various time fields, **`st_de ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`_stat`**, **`_stat32`**, **`_stat64`**, **`_stati64`**, **`_stat32i64`**, **`_stat64i32`**|`` followed by ``|``| -|**`_wstat`**, **`_wstat32`**, **`_wstat64`**, **`_wstati64`**, **`_wstat32i64`**, **`_wstat64i32`**|`` followed by `` or ``|``| +| Routine | Required header | Optional headers | +|---|---|---| +| **`_stat`**, **`_stat32`**, **`_stat64`**, **`_stati64`**, **`_stat32i64`**, **`_stat64i32`** | `` followed by `` | `` | +| **`_wstat`**, **`_wstat32`**, **`_wstat64`**, **`_wstati64`**, **`_wstat32i64`**, **`_wstat64i32`** | `` followed by `` or `` | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/static-assert-macro.md b/docs/c-runtime-library/reference/static-assert-macro.md index ed50c4a6808..2ecae090835 100644 --- a/docs/c-runtime-library/reference/static-assert-macro.md +++ b/docs/c-runtime-library/reference/static-assert-macro.md @@ -54,11 +54,11 @@ int main() ## Requirements -|Macro|Required header| -|-----------|---------------------| -|`_STATIC_ASSERT`|\| +| Macro | Required header | +|---|---| +| **`_STATIC_ASSERT`** | \ | ## See also [Alphabetical function reference](crt-alphabetical-function-reference.md)\ -[_ASSERT, _ASSERTE, _ASSERT_EXPR Macros](assert-asserte-assert-expr-macros.md) +[`_ASSERT`, `_ASSERTE`, `_ASSERT_EXPR` macros](assert-asserte-assert-expr-macros.md) diff --git a/docs/c-runtime-library/reference/status87-statusfp-statusfp2.md b/docs/c-runtime-library/reference/status87-statusfp-statusfp2.md index 4e11973dcfb..3dee203f57f 100644 --- a/docs/c-runtime-library/reference/status87-statusfp-statusfp2.md +++ b/docs/c-runtime-library/reference/status87-statusfp-statusfp2.md @@ -46,9 +46,9 @@ These functions aren't useful for [/clr (Common Language Runtime Compilation)](. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_status87`**, **`_statusfp`**, **`_statusfp2`**|\| +| Routine | Required header | +|---|---| +| **`_status87`**, **`_statusfp`**, **`_statusfp2`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strcat-s-wcscat-s-mbscat-s.md b/docs/c-runtime-library/reference/strcat-s-wcscat-s-mbscat-s.md index af18b6de423..51bb719193a 100644 --- a/docs/c-runtime-library/reference/strcat-s-wcscat-s-mbscat-s.md +++ b/docs/c-runtime-library/reference/strcat-s-wcscat-s-mbscat-s.md @@ -84,11 +84,11 @@ Zero if successful; an error code on failure. ### Error conditions -|*`strDestination`*|*`numberOfElements`*|*`strSource`*|Return value|Contents of *`strDestination`*| -|----------------------|------------------------|-----------------|------------------|----------------------------------| -|`NULL` or unterminated|any|any|`EINVAL`|not modified| -|any|any|`NULL`|`EINVAL`|*`strDestination[0]`* set to 0| -|any|0, or too small|any|`ERANGE`|*`strDestination[0]`* set to 0| +| *`strDestination`* | *`numberOfElements`* | *`strSource`* | Return value | Contents of *`strDestination`* | +|---|---|---|---|---| +| `NULL` or unterminated | any | any | `EINVAL` | not modified | +| any | any | `NULL` | `EINVAL` | *`strDestination[0]`* set to 0 | +| any | 0, or too small | any | `ERANGE` | *`strDestination[0]`* set to 0 | ## Remarks @@ -117,17 +117,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcscat_s`**|**`strcat_s`**|**`_mbscat_s`**|**`wcscat_s`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcscat_s` | **`strcat_s`** | **`_mbscat_s`** | **`wcscat_s`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strcat_s`**|``| -|**`wcscat_s`**|`` or ``| -|**`_mbscat_s`**|``| +| Routine | Required header | +|---|---| +| **`strcat_s`** | `` | +| **`wcscat_s`** | `` or `` | +| **`_mbscat_s`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strcat-wcscat-mbscat.md b/docs/c-runtime-library/reference/strcat-wcscat-mbscat.md index d5933465db6..5e202c05d3a 100644 --- a/docs/c-runtime-library/reference/strcat-wcscat-mbscat.md +++ b/docs/c-runtime-library/reference/strcat-wcscat-mbscat.md @@ -74,17 +74,17 @@ In C++, these functions have template overloads that invoke the newer, secure co ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcscat`**|**`strcat`**|**`_mbscat`**|**`wcscat`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcscat` | **`strcat`** | **`_mbscat`** | **`wcscat`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strcat`**|``| -|**`wcscat`**|`` or ``| -|**`_mbscat`**|``| +| Routine | Required header | +|---|---| +| **`strcat`** | `` | +| **`wcscat`** | `` or `` | +| **`_mbscat`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strchr-wcschr-mbschr-mbschr-l.md b/docs/c-runtime-library/reference/strchr-wcschr-mbschr-mbschr-l.md index da3cf56372d..438a03d696a 100644 --- a/docs/c-runtime-library/reference/strchr-wcschr-mbschr-mbschr-l.md +++ b/docs/c-runtime-library/reference/strchr-wcschr-mbschr-mbschr-l.md @@ -15,7 +15,7 @@ ms.assetid: 2639905d-e983-43b7-b885-abef32cfac43 Finds a character in a string, by using the current locale or a specified `LC_CTYPE` conversion-state category. > [!IMPORTANT] -> `_mbschr` and `_mbschr_l` 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). +> **`_mbschr`** and **`_mbschr_l`** 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). ## Syntax @@ -90,9 +90,9 @@ Each of these functions returns a pointer to the first occurrence of *`c`* in *` ## Remarks -The `strchr` function finds the first occurrence of *`c`* in *`str`*, or it returns `NULL` if *`c`* isn't found. The null terminating character is included in the search. +The **`strchr`** function finds the first occurrence of *`c`* in *`str`*, or it returns `NULL` if *`c`* isn't found. The null terminating character is included in the search. -`wcschr`, `_mbschr` and `_mbschr_l` are wide-character and multibyte-character versions of `strchr`. The arguments and return value of `wcschr` are wide-character strings. The arguments and return value of `_mbschr` are multibyte-character strings. `_mbschr` recognizes multibyte-character sequences. Also, if the string is a null pointer, `_mbschr` invokes the invalid parameter handler, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `_mbschr` returns `NULL` and sets `errno` to `EINVAL`. `strchr` and `wcschr` don't validate their parameters. These three functions behave identically otherwise. +**`wcschr`**, **`_mbschr`** and **`_mbschr_l`** are wide-character and multibyte-character versions of **`strchr`**. The arguments and return value of **`wcschr`** are wide-character strings. The arguments and return value of **`_mbschr`** are multibyte-character strings. **`_mbschr`** recognizes multibyte-character sequences. Also, if the string is a null pointer, **`_mbschr`** invokes the invalid parameter handler, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, **`_mbschr`** returns `NULL` and sets `errno` to `EINVAL`. **`strchr`** and **`wcschr`** don't validate their parameters. These three functions behave identically otherwise. The output value is affected by the setting of the `LC_CTYPE` category setting of the locale; for more information, see [`setlocale`](setlocale-wsetlocale.md). The versions of these functions without the **`_l`** suffix use the current locale for this locale-dependent behavior; the versions with the **`_l`** suffix are identical except that they use the locale parameter passed in instead. For more information, see [Locale](../locale.md). @@ -102,18 +102,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcschr`|`strchr`|`_mbschr`|`wcschr`| -|**_n/a**|**n/a**|`_mbschr_l`|**n/a**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcschr` | **`strchr`** | **`_mbschr`** | **`wcschr`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`strchr`|``| -|`wcschr`|`` or ``| -|`_mbschr`, `_mbschr_l`|``| +| Routine | Required header | +|---|---| +| **`strchr`** | `` | +| **`wcschr`** | `` or `` | +| **`_mbschr`**, **`_mbschr_l`** | `` | For more information about compatibility, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strcmp-wcscmp-mbscmp.md b/docs/c-runtime-library/reference/strcmp-wcscmp-mbscmp.md index 29b650fd222..4655742ddeb 100644 --- a/docs/c-runtime-library/reference/strcmp-wcscmp-mbscmp.md +++ b/docs/c-runtime-library/reference/strcmp-wcscmp-mbscmp.md @@ -51,11 +51,11 @@ Locale to use. The return value for each of these functions indicates the ordinal relation of *`string1`* to *`string2`*. -|Value|Relationship of `string1` to `string2`| -|-----------|----------------------------------------| -|< 0|*`string1`* is less than *`string2`*| -|0|*`string1`* is identical to *`string2`*| -|> 0|*`string1`* is greater than *`string2`*| +| Value | Relationship of `string1` to `string2` | +|---|---| +| < 0 | *`string1`* is less than *`string2`* | +| 0 | *`string1`* is identical to *`string2`* | +| > 0 | *`string1`* is greater than *`string2`* | On a parameter validation error, **`_mbscmp`** and **`_mbscmp_l`** return `_NLSCMPERROR`, which is defined in `` and ``. @@ -67,9 +67,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcscmp`**|**`strcmp`**|**`_mbscmp`**|**`wcscmp`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcscmp` | **`strcmp`** | **`_mbscmp`** | **`wcscmp`** | The **`strcmp`** functions differ from the **`strcoll`** functions in that **`strcmp`** comparisons are ordinal, and aren't affected by locale. **`strcoll`** compares strings lexicographically by using the `LC_COLLATE` category of the current locale. For more information about the `LC_COLLATE` category, see [`setlocale`, `_wsetlocale`](setlocale-wsetlocale.md). @@ -81,11 +81,11 @@ The **`strcmp`** functions are case-sensitive. **`_stricmp`**, **`_wcsicmp`**, a ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strcmp`**|``| -|**`wcscmp`**|`` or ``| -|**`_mbscmp`**|``| +| Routine | Required header | +|---|---| +| **`strcmp`** | `` | +| **`wcscmp`** | `` or `` | +| **`_mbscmp`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md b/docs/c-runtime-library/reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md index 76bc393d0f7..e6a21b10fda 100644 --- a/docs/c-runtime-library/reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md +++ b/docs/c-runtime-library/reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md @@ -61,11 +61,11 @@ Locale to use. Each of these functions returns a value indicating the relationship of *`string1`* to *`string2`*, as follows. -|Return value|Relationship of string1 to string2| -|------------------|----------------------------------------| -|< 0|*`string1`* less than *`string2`*| -|0|*`string1`* identical to *`string2`*| -|> 0|*`string1`* greater than *`string2`*| +| Return value | Relationship of *`string1`* to *`string2`* | +|---|---| +| < 0 | *`string1`* less than *`string2`* | +| 0 | *`string1`* identical to *`string2`* | +| > 0 | *`string1`* greater than *`string2`* | Each of these functions returns `_NLSCMPERROR` on an error. To use `_NLSCMPERROR`, include either STRING.H or MBSTRING.H. **`wcscoll`** can fail if either *`string1`* or *`string2`* is `NULL` or contains wide-character codes outside the domain of the collating sequence. When an error occurs, **`wcscoll`** may set `errno` to `EINVAL`. To check for an error on a call to **`wcscoll`**, set `errno` to 0 and then check `errno` after calling **`wcscoll`**. @@ -81,19 +81,19 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcscoll`|**`strcoll`**|**`_mbscoll`**|**`wcscoll`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcscoll` | **`strcoll`** | **`_mbscoll`** | **`wcscoll`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strcoll`**|\| -|**`wcscoll`**|\, \| -|**`_mbscoll`**, **`_mbscoll_l`**|\| -|**`_strcoll_l`**|\| -|**`_wcscoll_l`**|\, \| +| Routine | Required header | +|---|---| +| **`strcoll`** | \ | +| **`wcscoll`** | \, \ | +| **`_mbscoll`**, **`_mbscoll_l`** | \ | +| **`_strcoll_l`** | \ | +| **`_wcscoll_l`** | \, \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strcpy-s-wcscpy-s-mbscpy-s.md b/docs/c-runtime-library/reference/strcpy-s-wcscpy-s-mbscpy-s.md index e71b32d95d7..028610e385b 100644 --- a/docs/c-runtime-library/reference/strcpy-s-wcscpy-s-mbscpy-s.md +++ b/docs/c-runtime-library/reference/strcpy-s-wcscpy-s-mbscpy-s.md @@ -88,11 +88,11 @@ Zero if successful; otherwise, an error. ### Error conditions -|*`dest`*|*`dest_size`*|*`src`*|Return value|Contents of *`dest`*| -|----------------------|------------------------|-----------------|------------------|----------------------------------| -|`NULL`|any|any|`EINVAL`|not modified| -|any|any|`NULL`|`EINVAL`|*`dest[0]`* set to 0| -|any|0, or too small|any|`ERANGE`|*`dest[0]`* set to 0| +| *`dest`* | *`dest_size`* | *`src`* | Return value | Contents of *`dest`* | +|---|---|---|---|---| +| `NULL` | any | any | `EINVAL` | not modified | +| any | any | `NULL` | `EINVAL` | *`dest[0]`* set to 0 | +| any | 0, or too small | any | `ERANGE` | *`dest[0]`* set to 0 | ## Remarks @@ -112,17 +112,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcscpy_s`**|**`strcpy_s`**|**`_mbscpy_s`**|**`wcscpy_s`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tcscpy_s`** | **`strcpy_s`** | **`_mbscpy_s`** | **`wcscpy_s`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strcpy_s`**|``| -|**`wcscpy_s`**|`` or ``| -|**`_mbscpy_s`**|``| +| Routine | Required header | +|---|---| +| **`strcpy_s`** | `` | +| **`wcscpy_s`** | `` or `` | +| **`_mbscpy_s`** | `` | These functions are Microsoft-specific. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strcpy-wcscpy-mbscpy.md b/docs/c-runtime-library/reference/strcpy-wcscpy-mbscpy.md index f4097409629..7e7a1d471b4 100644 --- a/docs/c-runtime-library/reference/strcpy-wcscpy-mbscpy.md +++ b/docs/c-runtime-library/reference/strcpy-wcscpy-mbscpy.md @@ -76,17 +76,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcscpy`**|**`strcpy`**|**`_mbscpy`**|**`wcscpy`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcscpy` | **`strcpy`** | **`_mbscpy`** | **`wcscpy`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strcpy`**|``| -|**`wcscpy`**|`` or ``| -|**`_mbscpy`**|``| +| Routine | Required header | +|---|---| +| **`strcpy`** | `` | +| **`wcscpy`** | `` or `` | +| **`_mbscpy`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strcspn-wcscspn-mbscspn-mbscspn-l.md b/docs/c-runtime-library/reference/strcspn-wcscspn-mbscspn-mbscspn-l.md index 498f62f8166..7729056b6c4 100644 --- a/docs/c-runtime-library/reference/strcspn-wcscspn-mbscspn-mbscspn-l.md +++ b/docs/c-runtime-library/reference/strcspn-wcscspn-mbscspn-mbscspn-l.md @@ -68,18 +68,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcscspn`|**`strcspn`**|**`_mbscspn`**|**`wcscspn`**| -|n/a|n/a|**`_mbscspn_l`**|n/a| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcscspn` | **`strcspn`** | **`_mbscspn`** | **`wcscspn`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strcspn`**|\| -|**`wcscspn`**|\ or \| -|**`_mbscspn`**, **`_mbscspn_l`**|\| +| Routine | Required header | +|---|---| +| **`strcspn`** | \ | +| **`wcscspn`** | \ or \ | +| **`_mbscspn`**, **`_mbscspn_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strdate-s-wstrdate-s.md b/docs/c-runtime-library/reference/strdate-s-wstrdate-s.md index 9c7b8f021d0..fcab22129d7 100644 --- a/docs/c-runtime-library/reference/strdate-s-wstrdate-s.md +++ b/docs/c-runtime-library/reference/strdate-s-wstrdate-s.md @@ -49,12 +49,12 @@ Zero if successful. The return value is an error code if there's a failure. Erro ## Error conditions -|*`buffer`*|*`size`*|Return|Contents of *`buffer`*| -|--------------|------------------------|------------|--------------------------| -|`NULL`|(any)|`EINVAL`|Not modified| -|Not `NULL` (pointing to valid buffer)|0|`EINVAL`|Not modified| -|Not `NULL` (pointing to valid buffer)|0 < *`size`* < 9|`EINVAL`|Empty string| -|Not `NULL` (pointing to valid buffer)|*`size`* >= 9|0|Current date formatted as specified in the remarks| +| *`buffer`* | *`size`* | Return | Contents of *`buffer`* | +|---|---|---|---| +| `NULL` | (any) | `EINVAL` | Not modified | +| Not `NULL` (pointing to valid buffer) | 0 | `EINVAL` | Not modified | +| Not `NULL` (pointing to valid buffer) | 0 < *`size`* < 9 | `EINVAL` | Empty string | +| Not `NULL` (pointing to valid buffer) | *`size`* >= 9 | 0 | Current date formatted as specified in the remarks | ## Security issues @@ -78,17 +78,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mapping: -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tstrdate_s`|**`_strdate_s`**|**`_strdate_s`**|**`_wstrdate_s`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tstrdate_s` | **`_strdate_s`** | **`_strdate_s`** | **`_wstrdate_s`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strdate`**|\| -|**`_wstrdate`**|\ or \| -|**`_strdate_s`**|\| +| Routine | Required header | +|---|---| +| **`_strdate`** | \ | +| **`_wstrdate`** | \ or \ | +| **`_strdate_s`** | \ | ## Example diff --git a/docs/c-runtime-library/reference/strdate-wstrdate.md b/docs/c-runtime-library/reference/strdate-wstrdate.md index 9d2477686df..b2bcfd8afa3 100644 --- a/docs/c-runtime-library/reference/strdate-wstrdate.md +++ b/docs/c-runtime-library/reference/strdate-wstrdate.md @@ -58,16 +58,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tstrdate`|**`_strdate`**|**`_strdate`**|**`_wstrdate`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tstrdate` | **`_strdate`** | **`_strdate`** | **`_wstrdate`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strdate`**|\| -|**`_wstrdate`**|\ or \| +| Routine | Required header | +|---|---| +| **`_strdate`** | \ | +| **`_wstrdate`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strdec-wcsdec-mbsdec-mbsdec-l.md b/docs/c-runtime-library/reference/strdec-wcsdec-mbsdec-mbsdec-l.md index 071bcfb60af..6a87fe75ee6 100644 --- a/docs/c-runtime-library/reference/strdec-wcsdec-mbsdec-mbsdec-l.md +++ b/docs/c-runtime-library/reference/strdec-wcsdec-mbsdec-mbsdec-l.md @@ -69,9 +69,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcsdec`|**`_strdec`**|**`_mbsdec`**|**`_wcsdec`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsdec` | **`_strdec`** | **`_mbsdec`** | **`_wcsdec`** | **`_strdec`** and **`_wcsdec`** are single-byte-character and wide-character versions of **`_mbsdec`** and **`_mbsdec_l`**. **`_strdec`** and **`_wcsdec`** are provided only for this mapping and shouldn't be used otherwise. @@ -79,12 +79,12 @@ For more information, see [Using generic-text mappings](../using-generic-text-ma ## Requirements -|Routine|Required header|Optional header| -|-------------|---------------------|---------------------| -|**`_mbsdec`**|\|\| -|**`_mbsdec_l`**|\|\| -|**`_strdec`**|\|| -|**`_wcsdec`**|\|| +| Routine | Required header | Optional header | +|---|---|---| +| **`_mbsdec`** | \ | \ | +| **`_mbsdec_l`** | \ | \ | +| **`_strdec`** | \ | | +| **`_wcsdec`** | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strdup-dbg-wcsdup-dbg.md b/docs/c-runtime-library/reference/strdup-dbg-wcsdup-dbg.md index 899363b1d82..07f652b47cb 100644 --- a/docs/c-runtime-library/reference/strdup-dbg-wcsdup-dbg.md +++ b/docs/c-runtime-library/reference/strdup-dbg-wcsdup-dbg.md @@ -57,15 +57,15 @@ You don't need to call these functions explicitly in most cases. Instead, you ca ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsdup_dbg`|**`_strdup_dbg`**|`_mbsdup`|**`_wcsdup_dbg`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsdup_dbg` | **`_strdup_dbg`** | `_mbsdup` | **`_wcsdup_dbg`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strdup_dbg`**, **`_wcsdup_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_strdup_dbg`**, **`_wcsdup_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strdup-wcsdup-mbsdup.md b/docs/c-runtime-library/reference/strdup-wcsdup-mbsdup.md index 955c9d828b5..5c50625ff8a 100644 --- a/docs/c-runtime-library/reference/strdup-wcsdup-mbsdup.md +++ b/docs/c-runtime-library/reference/strdup-wcsdup-mbsdup.md @@ -50,9 +50,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcsdup`**|**`_strdup`**|**`_mbsdup`**|**`_wcsdup`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsdup` | **`_strdup`** | **`_mbsdup`** | **`_wcsdup`** | Because **`_strdup`** calls **`malloc`** to allocate storage space for the copy of *`strSource`*, it's good practice always to release this memory by calling the [`free`](free.md) routine on the pointer that's returned by the call to **`_strdup`**. @@ -60,11 +60,11 @@ If `_DEBUG` and `_CRTDBG_MAP_ALLOC` are defined, **`_strdup`** and **`_wcsdup`** ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strdup`**|``| -|**`_wcsdup`**|`` or ``| -|**`_mbsdup`**|``| +| Routine | Required header | +|---|---| +| **`_strdup`** | `` | +| **`_wcsdup`** | `` or `` | +| **`_mbsdup`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strerror-s-strerror-s-wcserror-s-wcserror-s.md b/docs/c-runtime-library/reference/strerror-s-strerror-s-wcserror-s-wcserror-s.md index d931e2b100f..f789aa97a6b 100644 --- a/docs/c-runtime-library/reference/strerror-s-strerror-s-wcserror-s-wcserror-s.md +++ b/docs/c-runtime-library/reference/strerror-s-strerror-s-wcserror-s-wcserror-s.md @@ -85,10 +85,10 @@ Zero if successful, an error code on failure. ### Error conditions -|*`buffer`*|*`sizeInBytes`*/*`sizeInWords`*|*`strErrMsg`*|Contents of *`buffer`*| -|--------------|------------------------|-----------------|--------------------------| -|`NULL`|any|any|n/a| -|any|0|any|not modified| +| *`buffer`* | *`sizeInBytes`*/*`sizeInWords`* | *`strErrMsg`* | Contents of *`buffer`* | +|---|---|---|---| +| `NULL` | any | any | n/a | +| any | 0 | any | not modified | ## Remarks @@ -124,16 +124,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcserror_s`|**`strerror_s`**|**`strerror_s`**|**`_wcserror_s`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcserror_s` | **`strerror_s`** | **`strerror_s`** | **`_wcserror_s`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strerror_s`**, **`_strerror_s`**|\| -|**`_wcserror_s`**, **`__wcserror_s`**|\ or \| +| Routine | Required header | +|---|---| +| **`strerror_s`**, **`_strerror_s`** | \ | +| **`_wcserror_s`**, **`__wcserror_s`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strerror-strerror-wcserror-wcserror.md b/docs/c-runtime-library/reference/strerror-strerror-wcserror-wcserror.md index f341c9b8a3d..d9c37818363 100644 --- a/docs/c-runtime-library/reference/strerror-strerror-wcserror-wcserror.md +++ b/docs/c-runtime-library/reference/strerror-strerror-wcserror-wcserror.md @@ -65,17 +65,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcserror`|**`strerror`**|**`strerror`**|**`_wcserror`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcserror` | **`strerror`** | **`strerror`** | **`_wcserror`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strerror`**|\| -|**`_strerror`**|\| -|**`_wcserror`**, **`__wcserror`**|\| +| Routine | Required header | +|---|---| +| **`strerror`** | \ | +| **`_strerror`** | \ | +| **`_wcserror`**, **`__wcserror`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strftime-wcsftime-strftime-l-wcsftime-l.md b/docs/c-runtime-library/reference/strftime-wcsftime-strftime-l-wcsftime-l.md index 72f6ca86a95..ea53901a2de 100644 --- a/docs/c-runtime-library/reference/strftime-wcsftime-strftime-l-wcsftime-l.md +++ b/docs/c-runtime-library/reference/strftime-wcsftime-strftime-l-wcsftime-l.md @@ -80,62 +80,62 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcsftime`**|**`strftime`**|**`strftime`**|**`wcsftime`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tcsftime`** | **`strftime`** | **`strftime`** | **`wcsftime`** | The *`format`* argument consists of one or more codes; as in **`printf`**, the formatting codes are preceded by a percent sign (**`%`**). Characters that don't begin with **`%`** are copied unchanged to *`strDest`*. The `LC_TIME` category of the current locale affects the output formatting of **`strftime`**. (For more information on `LC_TIME`, see [`setlocale`](setlocale-wsetlocale.md).) The **`strftime`** and **`wcsftime`** functions use the currently set locale. The **`_strftime_l`** and **`_wcsftime_l`** versions of these functions are identical except that they take the locale as a parameter and use that instead of the currently set locale. For more information, see [Locale](../locale.md). The **`strftime`** functions support these formatting codes: -|Code|Replacement string| -|-|-| -|**`%a`**|Abbreviated weekday name in the locale| -|**`%A`**|Full weekday name in the locale| -|**`%b`**|Abbreviated month name in the locale| -|**`%B`**|Full month name in the locale| -|**`%c`**|Date and time representation appropriate for locale| -|**`%C`**|The year divided by 100 and truncated to an integer, as a decimal number (00−99)| -|**`%d`**|Day of month as a decimal number (01 - 31)| -|**`%D`**|Equivalent to **`%m/%d/%y`**| -|**`%e`**|Day of month as a decimal number (1 - 31), where single digits are preceded by a space| -|**`%F`**|Equivalent to **`%Y-%m-%d`**| -|**`%g`**|The last 2 digits of the ISO 8601 week-based year as a decimal number (00 - 99)| -|**`%G`**|The ISO 8601 week-based year as a decimal number| -|**`%h`**|Abbreviated month name (equivalent to **`%b`**)| -|**`%H`**|Hour in 24-hour format (00 - 23)| -|**`%I`**|Hour in 12-hour format (01 - 12)| -|**`%j`**|Day of the year as a decimal number (001 - 366)| -|**`%m`**|Month as a decimal number (01 - 12)| -|**`%M`**|Minute as a decimal number (00 - 59)| -|**`%n`**|A newline character (**`\n`**)| -|**`%p`**|The locale's A.M./P.M. indicator for 12-hour clock| -|**`%r`**|The locale's 12-hour clock time| -|**`%R`**|Equivalent to **`%H:%M`**| -|**`%S`**|Second as a decimal number (00 - 59)| -|**`%t`**|A horizontal tab character (**`\t`**)| -|**`%T`**|Equivalent to **`%H:%M:%S`**, the ISO 8601 time format| -|**`%u`**|ISO 8601 weekday as a decimal number (1 - 7; Monday is 1)| -|**`%U`**|Week number of the year as a decimal number (00 - 53), where the first Sunday is the first day of week 1| -|**`%V`**|ISO 8601 week number as a decimal number (00 - 53)| -|**`%w`**|Weekday as a decimal number (0 - 6; Sunday is 0)| -|**`%W`**|Week number of the year as a decimal number (00 - 53), where the first Monday is the first day of week 1| -|**`%x`**|Date representation for the locale| -|**`%X`**|Time representation for the locale| -|**`%y`**|Year without century, as decimal number (00 - 99)| -|**`%Y`**|Year with century, as decimal number| -|**`%z`**|The offset from UTC in ISO 8601 format; no characters if time zone is unknown| -|**`%Z`**|Either the locale's time-zone name or time zone abbreviation, depending on registry settings; no characters if time zone is unknown| -|**`%%`**|Percent sign| +| Code | Replacement string | +|---|---| +| **`%a`** | Abbreviated weekday name in the locale | +| **`%A`** | Full weekday name in the locale | +| **`%b`** | Abbreviated month name in the locale | +| **`%B`** | Full month name in the locale | +| **`%c`** | Date and time representation appropriate for locale | +| **`%C`** | The year divided by 100 and truncated to an integer, as a decimal number (00−99) | +| **`%d`** | Day of month as a decimal number (01 - 31) | +| **`%D`** | Equivalent to **`%m/%d/%y`** | +| **`%e`** | Day of month as a decimal number (1 - 31), where single digits are preceded by a space | +| **`%F`** | Equivalent to **`%Y-%m-%d`** | +| **`%g`** | The last 2 digits of the ISO 8601 week-based year as a decimal number (00 - 99) | +| **`%G`** | The ISO 8601 week-based year as a decimal number | +| **`%h`** | Abbreviated month name (equivalent to **`%b`**) | +| **`%H`** | Hour in 24-hour format (00 - 23) | +| **`%I`** | Hour in 12-hour format (01 - 12) | +| **`%j`** | Day of the year as a decimal number (001 - 366) | +| **`%m`** | Month as a decimal number (01 - 12) | +| **`%M`** | Minute as a decimal number (00 - 59) | +| **`%n`** | A newline character (**`\n`**) | +| **`%p`** | The locale's A.M./P.M. indicator for 12-hour clock | +| **`%r`** | The locale's 12-hour clock time | +| **`%R`** | Equivalent to **`%H:%M`** | +| **`%S`** | Second as a decimal number (00 - 59) | +| **`%t`** | A horizontal tab character (**`\t`**) | +| **`%T`** | Equivalent to **`%H:%M:%S`**, the ISO 8601 time format | +| **`%u`** | ISO 8601 weekday as a decimal number (1 - 7; Monday is 1) | +| **`%U`** | Week number of the year as a decimal number (00 - 53), where the first Sunday is the first day of week 1 | +| **`%V`** | ISO 8601 week number as a decimal number (00 - 53) | +| **`%w`** | Weekday as a decimal number (0 - 6; Sunday is 0) | +| **`%W`** | Week number of the year as a decimal number (00 - 53), where the first Monday is the first day of week 1 | +| **`%x`** | Date representation for the locale | +| **`%X`** | Time representation for the locale | +| **`%y`** | Year without century, as decimal number (00 - 99) | +| **`%Y`** | Year with century, as decimal number | +| **`%z`** | The offset from UTC in ISO 8601 format; no characters if time zone is unknown | +| **`%Z`** | Either the locale's time-zone name or time zone abbreviation, depending on registry settings; no characters if time zone is unknown | +| **`%%`** | Percent sign | As in the **`printf`** function, the **`#`** flag may prefix any formatting code. In that case, the meaning of the format code is changed as follows. -|Format code|Meaning| -|-----------------|-------------| -|**`%#a`**, **`%#A`**, **`%#b`**, **`%#B`**, **`%#g`**, **`%#G`**, **`%#h`**, **`%#n`**, **`%#p`**, **`%#t`**, **`%#u`**, **`%#w`**, **`%#X`**, **`%#z`**, **`%#Z`**, **`%#%`**|**`#`** flag is ignored.| -|**`%#c`**|Long date and time representation, appropriate for the locale. For example: "Tuesday, March 14, 1995, 12:41:29".| -|**`%#x`**|Long date representation, appropriate to the locale. For example: "Tuesday, March 14, 1995".| -|**`%#d`**, **`%#D`**, **`%#e`**, **`%#F`**, **`%#H`**, **`%#I`**, **`%#j`**, **`%#m`**, **`%#M`**, **`%#r`**, **`%#R`**, **`%#S`**, **`%#T`**, **`%#U`**, **`%#V`**, **`%#W`**, **`%#y`**, **`%#Y`**|Remove leading zeros or spaces (if any).| +| Format code | Meaning | +|---|---| +| **`%#a`**, **`%#A`**, **`%#b`**, **`%#B`**, **`%#g`**, **`%#G`**, **`%#h`**, **`%#n`**, **`%#p`**, **`%#t`**, **`%#u`**, **`%#w`**, **`%#X`**, **`%#z`**, **`%#Z`**, **`%#%`** | **`#`** flag is ignored. | +| **`%#c`** | Long date and time representation, appropriate for the locale. For example: "Tuesday, March 14, 1995, 12:41:29". | +| **`%#x`** | Long date representation, appropriate to the locale. For example: "Tuesday, March 14, 1995". | +| **`%#d`**, **`%#D`**, **`%#e`**, **`%#F`**, **`%#H`**, **`%#I`**, **`%#j`**, **`%#m`**, **`%#M`**, **`%#r`**, **`%#R`**, **`%#S`**, **`%#T`**, **`%#U`**, **`%#V`**, **`%#W`**, **`%#y`**, **`%#Y`** | Remove leading zeros or spaces (if any). | The ISO 8601 week and week-based year produced by **`%V`**, **`%g`**, and **`%G`**, uses a week that begins on Monday. Week 1 is the week that contains the fourth day of January, which is the first week that includes at least four days of the year. If the first Monday of the year is the 2nd, 3rd, or 4th, the preceding days are part of the last week of the preceding year. For those days, **`%V`** is replaced by 53, and both **`%g`** and **`%G`** are replaced by the digits of the preceding year. @@ -144,12 +144,12 @@ The ISO 8601 week and week-based year produced by **`%V`**, **`%g`**, and **`%G` ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strftime`**|``| -|**`wcsftime`**|`` or ``| -|**`_strftime_l`**|``| -|**`_wcsftime_l`**|`` or ``| +| Routine | Required header | +|---|---| +| **`strftime`** | `` | +| **`wcsftime`** | `` or `` | +| **`_strftime_l`** | `` | +| **`_wcsftime_l`** | `` or `` | The **`_strftime_l`** and **`_wcsftime_l`** functions are Microsoft-specific. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/stricmp-wcsicmp-mbsicmp-stricmp-l-wcsicmp-l-mbsicmp-l.md b/docs/c-runtime-library/reference/stricmp-wcsicmp-mbsicmp-stricmp-l-wcsicmp-l-mbsicmp-l.md index f92a10e820a..faa3e411a91 100644 --- a/docs/c-runtime-library/reference/stricmp-wcsicmp-mbsicmp-stricmp-l-wcsicmp-l-mbsicmp-l.md +++ b/docs/c-runtime-library/reference/stricmp-wcsicmp-mbsicmp-stricmp-l-wcsicmp-l-mbsicmp-l.md @@ -61,11 +61,11 @@ Locale to use. The return value indicates the relation of *`string1`* to *`string2`* as follows. -|Return value|Description| -|------------------|-----------------| -|< 0|*`string1`* less than *`string2`*| -|0|*`string1`* identical to *`string2`*| -|> 0|*`string1`* greater than *`string2`*| +| Return value | Description | +|---|---| +| < 0 | *`string1`* less than *`string2`* | +| 0 | *`string1`* identical to *`string2`* | +| > 0 | *`string1`* greater than *`string2`* | On an error, **`_mbsicmp`** returns `_NLSCMPERROR`, which is defined in `` and ``. @@ -112,17 +112,17 @@ All of these functions validate their parameters. If either *`string1`* or *`str ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcsicmp`**|**`_stricmp`**|**`_mbsicmp`**|**`_wcsicmp`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsicmp` | **`_stricmp`** | **`_mbsicmp`** | **`_wcsicmp`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_stricmp`**, **`_stricmp_l`**|``| -|**`_wcsicmp`**, **`_wcsicmp_l`**|`` or ``| -|**`_mbsicmp`**, **`_mbsicmp_l`**|``| +| Routine | Required header | +|---|---| +| **`_stricmp`**, **`_stricmp_l`** | `` | +| **`_wcsicmp`**, **`_wcsicmp_l`** | `` or `` | +| **`_mbsicmp`**, **`_mbsicmp_l`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md b/docs/c-runtime-library/reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md index d59a167fcdf..f4c212e553c 100644 --- a/docs/c-runtime-library/reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md +++ b/docs/c-runtime-library/reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md @@ -61,12 +61,12 @@ The locale to use. Each of these functions returns a value indicating the relationship of *`string1`* to *`string2`*, as follows. -|Return value|Relationship of string1 to string2| -|------------------|----------------------------------------| -|< 0|*`string1`* less than *`string2`*| -|0|*`string1`* identical to *`string2`*| -|> 0|*`string1`* greater than *`string2`*| -|`_NLSCMPERROR`|An error occurred.| +| Return value | Relationship of *`string1`* to *`string2`* | +|---|---| +| < 0 | *`string1`* less than *`string2`* | +| 0 | *`string1`* identical to *`string2`* | +| > 0 | *`string1`* greater than *`string2`* | +| `_NLSCMPERROR` | An error occurred. | Each of these functions returns `_NLSCMPERROR`. To use `_NLSCMPERROR`, include either \ or \. **`_wcsicoll`** can fail if either *`string1`* or *`string2`* contains wide-character codes outside the domain of the collating sequence. When an error occurs, **`_wcsicoll`** may set `errno` to `EINVAL`. To check for an error on a call to **`_wcsicoll`**, set `errno` to 0 and then check `errno` after calling **`_wcsicoll`**. @@ -82,17 +82,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsicoll`|**`_stricoll`**|**`_mbsicoll`**|**`_wcsicoll`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsicoll` | **`_stricoll`** | **`_mbsicoll`** | **`_wcsicoll`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_stricoll`**, **`_stricoll_l`**|\| -|**`_wcsicoll`**, **`_wcsicoll_l`**|\, \| -|**`_mbsicoll`**, **`_mbsicoll_l`**|\| +| Routine | Required header | +|---|---| +| **`_stricoll`**, **`_stricoll_l`** | \ | +| **`_wcsicoll`**, **`_wcsicoll_l`** | \, \ | +| **`_mbsicoll`**, **`_mbsicoll_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strinc-wcsinc-mbsinc-mbsinc-l.md b/docs/c-runtime-library/reference/strinc-wcsinc-mbsinc-mbsinc-l.md index 816fbbc86d2..a741d1935ae 100644 --- a/docs/c-runtime-library/reference/strinc-wcsinc-mbsinc-mbsinc-l.md +++ b/docs/c-runtime-library/reference/strinc-wcsinc-mbsinc-mbsinc-l.md @@ -64,12 +64,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsinc`**|\| -|**`_mbsinc_l`**|\| -|**`_strinc`**|\| -|**`_wcsinc`**|\| +| Routine | Required header | +|---|---| +| **`_mbsinc`** | \ | +| **`_mbsinc_l`** | \ | +| **`_strinc`** | \ | +| **`_wcsinc`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strlen-wcslen-mbslen-mbslen-l-mbstrlen-mbstrlen-l.md b/docs/c-runtime-library/reference/strlen-wcslen-mbslen-mbslen-l-mbstrlen-mbstrlen-l.md index 74fcf05c8d5..ebe6326cfde 100644 --- a/docs/c-runtime-library/reference/strlen-wcslen-mbslen-mbslen-l-mbstrlen-mbstrlen-l.md +++ b/docs/c-runtime-library/reference/strlen-wcslen-mbslen-mbslen-l-mbstrlen-mbstrlen-l.md @@ -64,11 +64,11 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcslen`**|**`strlen`**|**`strlen`**|**`wcslen`**| -|**`_tcsclen`**|**`strlen`**|**`_mbslen`**|**`wcslen`**| -|**`_tcsclen_l`**|**`strlen`**|**`_mbslen_l`**|**`wcslen`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcslen` | **`strlen`** | **`strlen`** | **`wcslen`** | +| `_tcsclen` | **`strlen`** | **`_mbslen`** | **`wcslen`** | +| `_tcsclen_l` | **`strlen`** | **`_mbslen_l`** | **`wcslen`** | **`_mbslen`** and **`_mbslen_l`** return the number of multibyte characters in a multibyte-character string but they don't test for multibyte-character validity. **`_mbstrlen`** and **`_mbstrlen_l`** test for multibyte-character validity and recognize multibyte-character sequences. If the string passed to **`_mbstrlen`** or **`_mbstrlen_l`** contains an invalid multibyte character for the code page, the function returns -1 and sets `errno` to `EILSEQ`. @@ -76,12 +76,12 @@ The output value is affected by the setting of the `LC_CTYPE` category setting o ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strlen`**|``| -|**`wcslen`**|`` or ``| -|**`_mbslen`**, **`_mbslen_l`**|``| -|**`_mbstrlen`**, **`_mbstrlen_l`**|``| +| Routine | Required header | +|---|---| +| **`strlen`** | `` | +| **`wcslen`** | `` or `` | +| **`_mbslen`**, **`_mbslen_l`** | `` | +| **`_mbstrlen`**, **`_mbstrlen_l`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strlwr-s-strlwr-s-l-mbslwr-s-mbslwr-s-l-wcslwr-s-wcslwr-s-l.md b/docs/c-runtime-library/reference/strlwr-s-strlwr-s-l-mbslwr-s-mbslwr-s-l-wcslwr-s-wcslwr-s-l.md index 4a05049a83c..4fac7aec67c 100644 --- a/docs/c-runtime-library/reference/strlwr-s-strlwr-s-l-mbslwr-s-mbslwr-s-l-wcslwr-s-wcslwr-s-l.md +++ b/docs/c-runtime-library/reference/strlwr-s-strlwr-s-l-mbslwr-s-mbslwr-s-l-wcslwr-s-wcslwr-s-l.md @@ -107,18 +107,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcslwr_s`|**`_strlwr_s`**|**`_mbslwr_s`**|**`_wcslwr_s`**| -|`_tcslwr_s_l`|**`_strlwr_s_l`**|**`_mbslwr_s_l`**|**`_wcslwr_s_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcslwr_s` | **`_strlwr_s`** | **`_mbslwr_s`** | **`_wcslwr_s`** | +| `_tcslwr_s_l` | **`_strlwr_s_l`** | **`_mbslwr_s_l`** | **`_wcslwr_s_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strlwr_s`**, **`_strlwr_s_l`**|\| -|**`_mbslwr_s`**, **`_mbslwr_s_l`**|\| -|**`_wcslwr_s`**, **`_wcslwr_s_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`_strlwr_s`**, **`_strlwr_s_l`** | \ | +| **`_mbslwr_s`**, **`_mbslwr_s_l`** | \ | +| **`_wcslwr_s`**, **`_wcslwr_s_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strlwr-wcslwr-mbslwr-strlwr-l-wcslwr-l-mbslwr-l.md b/docs/c-runtime-library/reference/strlwr-wcslwr-mbslwr-strlwr-l-wcslwr-l-mbslwr-l.md index 607411d4077..8a579d3a773 100644 --- a/docs/c-runtime-library/reference/strlwr-wcslwr-mbslwr-strlwr-l-wcslwr-l-mbslwr-l.md +++ b/docs/c-runtime-library/reference/strlwr-wcslwr-mbslwr-strlwr-l-wcslwr-l-mbslwr-l.md @@ -96,18 +96,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcslwr`|**`_strlwr`**|**`_mbslwr`**|**`_wcslwr`**| -|`_tcslwr_l`|**`_strlwr_l`**|**`_mbslwr_l`**|**`_wcslwr_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcslwr` | **`_strlwr`** | **`_mbslwr`** | **`_wcslwr`** | +| `_tcslwr_l` | **`_strlwr_l`** | **`_mbslwr_l`** | **`_wcslwr_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strlwr`**, **`_strlwr_l`**|\| -|**`_wcslwr`**, **`_wcslwr_l`**|\ or \| -|**`_mbslwr`**, **`_mbslwr_l`**|\| +| Routine | Required header | +|---|---| +| **`_strlwr`**, **`_strlwr_l`** | \ | +| **`_wcslwr`**, **`_wcslwr_l`** | \ or \ | +| **`_mbslwr`**, **`_mbslwr_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strncat-s-strncat-s-l-wcsncat-s-wcsncat-s-l-mbsncat-s-mbsncat-s-l.md b/docs/c-runtime-library/reference/strncat-s-strncat-s-l-wcsncat-s-wcsncat-s-l-mbsncat-s-mbsncat-s-l.md index c6865469b7e..5a5f4a6e0aa 100644 --- a/docs/c-runtime-library/reference/strncat-s-strncat-s-l-wcsncat-s-wcsncat-s-l-mbsncat-s-mbsncat-s-l.md +++ b/docs/c-runtime-library/reference/strncat-s-strncat-s-l-wcsncat-s-wcsncat-s-l-mbsncat-s-mbsncat-s-l.md @@ -123,11 +123,11 @@ Returns 0 if successful, an error code on failure. ### Error conditions -|*`strDestination`*|*`numberOfElements`*|*`strSource`*|Return value|Contents of *`strDestination`*| -|----------------------|------------------------|-----------------|------------------|----------------------------------| -|`NULL` or unterminated|any|any|`EINVAL`|not modified| -|any|any|`NULL`|`EINVAL`|not modified| -|any|0, or too small|any|`ERANGE`|not modified| +| *`strDestination`* | *`numberOfElements`* | *`strSource`* | Return value | Contents of *`strDestination`* | +|---|---|---|---|---| +| `NULL` or unterminated | any | any | `EINVAL` | not modified | +| any | any | `NULL` | `EINVAL` | not modified | +| any | 0, or too small | any | `ERANGE` | not modified | ## Remarks @@ -173,20 +173,20 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsncat_s`|**`strncat_s`**|**`_mbsnbcat_s`**|**`wcsncat_s`**| -|`_tcsncat_s_l`|**`_strncat_s_l`**|**`_mbsnbcat_s_l`**|**`_wcsncat_s_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsncat_s` | **`strncat_s`** | **`_mbsnbcat_s`** | **`wcsncat_s`** | +| `_tcsncat_s_l` | **`_strncat_s_l`** | **`_mbsnbcat_s_l`** | **`_wcsncat_s_l`** | **`_strncat_s_l`** and **`_wcsncat_s_l`** have no locale dependence; they're only provided for **`_tcsncat_s_l`**. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strncat_s`**|\| -|**`wcsncat_s`**|\ or \| -|**`_mbsncat_s`**, **`_mbsncat_s_l`**|\| +| Routine | Required header | +|---|---| +| **`strncat_s`** | \ | +| **`wcsncat_s`** | \ or \ | +| **`_mbsncat_s`**, **`_mbsncat_s_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strncat-strncat-l-wcsncat-wcsncat-l-mbsncat-mbsncat-l.md b/docs/c-runtime-library/reference/strncat-strncat-l-wcsncat-wcsncat-l-mbsncat-mbsncat-l.md index cd2e2e51b0c..16bcbe241a1 100644 --- a/docs/c-runtime-library/reference/strncat-strncat-l-wcsncat-wcsncat-l-mbsncat-mbsncat-l.md +++ b/docs/c-runtime-library/reference/strncat-strncat-l-wcsncat-wcsncat-l-mbsncat-mbsncat-l.md @@ -103,7 +103,7 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings | `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | -|--|--|--|--| +|---|---|---|---| | **`_tcsncat`** | **`strncat`** | **`_mbsnbcat`** | **`wcsncat`** | | **`_tcsncat_l`** | **`_strncat_l`** | **`_mbsnbcat_l`** | **`_wcsncat_l`** | @@ -112,12 +112,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strncat`**|\| -|**`wcsncat`**|\ or \| -|**`_mbsncat`**|\| -|**`_mbsncat_l`**|\| +| Routine | Required header | +|---|---| +| **`strncat`** | \ | +| **`wcsncat`** | \ or \ | +| **`_mbsncat`** | \ | +| **`_mbsncat_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). @@ -173,15 +173,15 @@ You can see that `BadAppend` caused a buffer overrun. ## See also [String manipulation](../string-manipulation-crt.md)\ -[`_mbsnbcat, _mbsnbcat_l`](mbsnbcat-mbsnbcat-l.md)\ -[`strcat, wcscat, _mbscat`](strcat-wcscat-mbscat.md)\ -[`strcmp, wcscmp, _mbscmp`](strcmp-wcscmp-mbscmp.md)\ -[`strcpy, wcscpy, _mbscpy`](strcpy-wcscpy-mbscpy.md)\ -[`strncmp, wcsncmp, _mbsncmp, _mbsncmp_l`](strncmp-wcsncmp-mbsncmp-mbsncmp-l.md)\ -[`strncpy, _strncpy_l, wcsncpy, _wcsncpy_l, _mbsncpy, _mbsncpy_l`](strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md)\ -[`_strnicmp, _wcsnicmp, _mbsnicmp, _strnicmp_l, _wcsnicmp_l, _mbsnicmp_l`](strnicmp-wcsnicmp-mbsnicmp-strnicmp-l-wcsnicmp-l-mbsnicmp-l.md)\ -[`strrchr, wcsrchr, _mbsrchr, _mbsrchr_l`](strrchr-wcsrchr-mbsrchr-mbsrchr-l.md)\ -[`_strset, _strset_l, _wcsset, _wcsset_l, _mbsset, _mbsset_l`](strset-strset-l-wcsset-wcsset-l-mbsset-mbsset-l.md)\ -[`strspn, wcsspn, _mbsspn, _mbsspn_l`](strspn-wcsspn-mbsspn-mbsspn-l.md)\ +[`_mbsnbcat`, `_mbsnbcat_l`](mbsnbcat-mbsnbcat-l.md)\ +[`strcat`, `wcscat`, `_mbscat`](strcat-wcscat-mbscat.md)\ +[`strcmp`, `wcscmp`, `_mbscmp`](strcmp-wcscmp-mbscmp.md)\ +[`strcpy`, `wcscpy`, `_mbscpy`](strcpy-wcscpy-mbscpy.md)\ +[`strncmp`, `wcsncmp`, `_mbsncmp`, `_mbsncmp_l`](strncmp-wcsncmp-mbsncmp-mbsncmp-l.md)\ +[`strncpy`, `_strncpy_l`, `wcsncpy`, `_wcsncpy_l`, `_mbsncpy`, `_mbsncpy_l`](strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md)\ +[`_strnicmp`, `_wcsnicmp`, `_mbsnicmp`, `_strnicmp_l`, `_wcsnicmp_l`, `_mbsnicmp_l`](strnicmp-wcsnicmp-mbsnicmp-strnicmp-l-wcsnicmp-l-mbsnicmp-l.md)\ +[`strrchr`, `wcsrchr`, `_mbsrchr`, `_mbsrchr_l`](strrchr-wcsrchr-mbsrchr-mbsrchr-l.md)\ +[`_strset`, `_strset_l`, `_wcsset`, `_wcsset_l`, `_mbsset`, `_mbsset_l`](strset-strset-l-wcsset-wcsset-l-mbsset-mbsset-l.md)\ +[`strspn`, `wcsspn`, `_mbsspn`, `_mbsspn_l`](strspn-wcsspn-mbsspn-mbsspn-l.md)\ [Locale](../locale.md)\ [Interpretation of multibyte-character sequences](../interpretation-of-multibyte-character-sequences.md)\ diff --git a/docs/c-runtime-library/reference/strncmp-wcsncmp-mbsncmp-mbsncmp-l.md b/docs/c-runtime-library/reference/strncmp-wcsncmp-mbsncmp-mbsncmp-l.md index a6d29b1cff0..99cad4957d3 100644 --- a/docs/c-runtime-library/reference/strncmp-wcsncmp-mbsncmp-mbsncmp-l.md +++ b/docs/c-runtime-library/reference/strncmp-wcsncmp-mbsncmp-mbsncmp-l.md @@ -62,11 +62,11 @@ Locale to use. The return value indicates the relation of the substrings of *`string1`* and *`string2`* as follows. -|Return value|Description| -|------------------|-----------------| -|< 0|*`string1`* substring less than *`string2`* substring| -|0|*`string1`* substring identical to *`string2`* substring| -|> 0|*`string1`* substring greater than *`string2`* substring| +| Return value | Description | +|---|---| +| < 0 | *`string1`* substring less than *`string2`* substring | +| 0 | *`string1`* substring identical to *`string2`* substring | +| > 0 | *`string1`* substring greater than *`string2`* substring | On a parameter validation error, **`_mbsncmp`** and **`_mbsncmp_l`** return **`_NLSCMPERROR`**, which is defined in `` and ``. @@ -84,20 +84,19 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcsnccmp`**|**`strncmp`**|**`_mbsncmp`**|**`wcsncmp`**| -|**`_tcsncmp`**|**`strncmp`**|**`_mbsnbcmp`**|**`wcsncmp`**| -|**`_tccmp`**|Maps to macro or inline function|**`_mbsncmp`**|Maps to macro or inline function| -|**not applicable**|**not applicable**|**`_mbsncmp_l`**|**not applicable**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsnccmp` | **`strncmp`** | **`_mbsncmp`** | **`wcsncmp`** | +| `_tcsncmp` | **`strncmp`** | **`_mbsnbcmp`** | **`wcsncmp`** | +| `_tccmp` | Maps to macro or inline function | **`_mbsncmp`** | Maps to macro or inline function | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strncmp`**|``| -|**`wcsncmp`**|`` or ``| -|**`_mbsncmp`**, **`_mbsncmp_l`**|``| +| Routine | Required header | +|---|---| +| **`strncmp`** | `` | +| **`wcsncmp`** | `` or `` | +| **`_mbsncmp`**, **`_mbsncmp_l`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strncnt-wcsncnt-mbsnbcnt-mbsnbcnt-l-mbsnccnt-mbsnccnt-l.md b/docs/c-runtime-library/reference/strncnt-wcsncnt-mbsnbcnt-mbsnbcnt-l-mbsnccnt-mbsnccnt-l.md index 0ddb41f17c3..ce8b1e1d1e7 100644 --- a/docs/c-runtime-library/reference/strncnt-wcsncnt-mbsnbcnt-mbsnbcnt-l-mbsnccnt-mbsnccnt-l.md +++ b/docs/c-runtime-library/reference/strncnt-wcsncnt-mbsnbcnt-mbsnbcnt-l-mbsnccnt-mbsnccnt-l.md @@ -79,24 +79,24 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|-------------|--------------------------------------|--------------------|-----------------------| -|`_tcsnbcnt`|**`_strncnt`**|**`_mbsnbcnt`**|**`_wcsncnt`**| -|`_tcsnccnt`|**`_strncnt`**|**`_mbsnbcnt`**|n/a| -|**`_wcsncnt`**|n/a|n/a|**`_mbsnbcnt`**| -|**`_wcsncnt`**|n/a|n/a|**`_mbsnccnt`**| -|n/a|n/a|**`_mbsnbcnt_l`**|**`_mbsnccnt_l`**| +| Routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsnbcnt` | **`_strncnt`** | **`_mbsnbcnt`** | **`_wcsncnt`** | +| `_tcsnccnt` | **`_strncnt`** | **`_mbsnbcnt`** | n/a | +| **`_wcsncnt`** | n/a | n/a | **`_mbsnbcnt`** | +| **`_wcsncnt`** | n/a | n/a | **`_mbsnccnt`** | +| n/a | n/a | **`_mbsnbcnt_l`** | **`_mbsnccnt_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsnbcnt`**|\| -|**`_mbsnbcnt_l`**|\| -|**`_mbsnccnt`**|\| -|**`_mbsnccnt_l`**|\| -|**`_strncnt`**|\| -|**`_wcsncnt`**|\| +| Routine | Required header | +|---|---| +| **`_mbsnbcnt`** | \ | +| **`_mbsnbcnt_l`** | \ | +| **`_mbsnccnt`** | \ | +| **`_mbsnccnt_l`** | \ | +| **`_strncnt`** | \ | +| **`_wcsncnt`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md b/docs/c-runtime-library/reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md index 0eef897f83b..7c20a38a1af 100644 --- a/docs/c-runtime-library/reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md +++ b/docs/c-runtime-library/reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md @@ -70,11 +70,11 @@ The locale to use. Each of these functions returns a value that indicates the relationship of the substrings of *`string1`* and *`string2`*, as follows. -|Return value|Relationship of string1 to string2| -|------------------|----------------------------------------| -|< 0|*`string1`* is less than *`string2`*.| -|0|*`string1`* is identical to *`string2`*.| -|> 0|*`string1`* is greater than *`string2`*.| +| Return value | Relationship of *`string1`* to *`string2`* | +|---|---| +| < 0 | *`string1`* is less than *`string2`*. | +| 0 | *`string1`* is identical to *`string2`*. | +| > 0 | *`string1`* is greater than *`string2`*. | Each of these functions returns `_NLSCMPERROR`. To use `_NLSCMPERROR`, include either STRING.h or MBSTRING.h. **`_wcsncoll`** can fail if either *`string1`* or *`string2`* contains wide-character codes that are outside the domain of the collating sequence. When an error occurs, **`_wcsncoll`** may set `errno` to `EINVAL`. To check for an error on a call to **`_wcsncoll`**, set `errno` to 0, and then check `errno` after the **`_wcsncoll`** call. @@ -88,18 +88,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsnccoll`|**`_strncoll`**|**`_mbsncoll`**|**`_wcsncoll`**| -|`_tcsncoll`|**`_strncoll`**|[`_mbsnbcoll`](mbsnbcoll-mbsnbcoll-l-mbsnbicoll-mbsnbicoll-l.md)|**`_wcsncoll`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsnccoll` | **`_strncoll`** | **`_mbsncoll`** | **`_wcsncoll`** | +| `_tcsncoll` | **`_strncoll`** | [`_mbsnbcoll`](mbsnbcoll-mbsnbcoll-l-mbsnbicoll-mbsnbicoll-l.md) | **`_wcsncoll`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strncoll`**, **`_strncoll_l`**|\| -|**`_wcsncoll`**, **`_wcsncoll_l`**|\ or \| -|**`_mbsncoll`**, **`_mbsncoll_l`**|\| +| Routine | Required header | +|---|---| +| **`_strncoll`**, **`_strncoll_l`** | \ | +| **`_wcsncoll`**, **`_wcsncoll_l`** | \ or \ | +| **`_mbsncoll`**, **`_mbsncoll_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strncpy-s-strncpy-s-l-wcsncpy-s-wcsncpy-s-l-mbsncpy-s-mbsncpy-s-l.md b/docs/c-runtime-library/reference/strncpy-s-strncpy-s-l-wcsncpy-s-wcsncpy-s-l-mbsncpy-s-mbsncpy-s-l.md index b4640f7838d..c46cd5ef1fa 100644 --- a/docs/c-runtime-library/reference/strncpy-s-strncpy-s-l-wcsncpy-s-wcsncpy-s-l-mbsncpy-s-mbsncpy-s-l.md +++ b/docs/c-runtime-library/reference/strncpy-s-strncpy-s-l-wcsncpy-s-wcsncpy-s-l-mbsncpy-s-mbsncpy-s-l.md @@ -123,12 +123,12 @@ Zero if successful, `STRUNCATE` if truncation occurred, otherwise an error code. ### Error conditions -|*`strDest`*|*`numberOfElements`*|*`strSource`*|Return value|Contents of *`strDest`*| -|---------------|------------------------|-----------------|------------------|---------------------------| -|`NULL`|any|any|`EINVAL`|not modified| -|any|any|`NULL`|`EINVAL`|*`strDest[0]`* set to 0| -|any|0|any|`EINVAL`|not modified| -|not `NULL`|too small|any|`ERANGE`|*`strDest[0]`* set to 0| +| *`strDest`* | *`numberOfElements`* | *`strSource`* | Return value | Contents of *`strDest`* | +|---|---|---|---|---| +| `NULL` | any | any | `EINVAL` | not modified | +| any | any | `NULL` | `EINVAL` | *`strDest[0]`* set to 0 | +| any | 0 | any | `EINVAL` | not modified | +| not `NULL` | too small | any | `ERANGE` | *`strDest[0]`* set to 0 | ## Remarks @@ -170,21 +170,21 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcsncpy_s`**|**`strncpy_s`**|**`_mbsnbcpy_s`**|**`wcsncpy_s`**| -|**`_tcsncpy_s_l`**|**`_strncpy_s_l`**|**`_mbsnbcpy_s_l`**|**`_wcsncpy_s_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsncpy_s` | **`strncpy_s`** | **`_mbsnbcpy_s`** | **`wcsncpy_s`** | +| `_tcsncpy_s_l` | **`_strncpy_s_l`** | **`_mbsnbcpy_s_l`** | **`_wcsncpy_s_l`** | > [!NOTE] -> **`_strncpy_s_l`**, **`_wcsncpy_s_l`** and **`_mbsncpy_s_l`** have no locale dependence and are provided just for **`_tcsncpy_s_l`** and are not intended to be called directly. +> **`_strncpy_s_l`**, **`_wcsncpy_s_l`** and **`_mbsncpy_s_l`** have no locale dependence. They're provided just for `_tcsncpy_s_l` and aren't intended to be called directly. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strncpy_s`**, **`_strncpy_s_l`**|``| -|**`wcsncpy_s`**, **`_wcsncpy_s_l`**|`` or ``| -|**`_mbsncpy_s`**, **`_mbsncpy_s_l`**|``| +| Routine | Required header | +|---|---| +| **`strncpy_s`**, **`_strncpy_s_l`** | `` | +| **`wcsncpy_s`**, **`_wcsncpy_s_l`** | `` or `` | +| **`_mbsncpy_s`**, **`_mbsncpy_s_l`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md b/docs/c-runtime-library/reference/strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md index e4a76df9f05..aa0d33ccd0a 100644 --- a/docs/c-runtime-library/reference/strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md +++ b/docs/c-runtime-library/reference/strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md @@ -131,21 +131,21 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcsncpy`**|**`strncpy`**|**`_mbsnbcpy`**|**`wcsncpy`**| -|**`_tcsncpy_l`**|**`_strncpy_l`**|**`_mbsnbcpy_l`**|**`_wcsncpy_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsncpy` | **`strncpy`** | **`_mbsnbcpy`** | **`wcsncpy`** | +| `_tcsncpy_l` | **`_strncpy_l`** | **`_mbsnbcpy_l`** | **`_wcsncpy_l`** | > [!NOTE] > **`_strncpy_l`** and **`_wcsncpy_l`** have no locale dependence; they are provided just for **`_tcsncpy_l`** and are not intended to be called directly. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strncpy`**|``| -|**`wcsncpy`**|`` or ``| -|**`_mbsncpy`**, **`_mbsncpy_l`**|``| +| Routine | Required header | +|---|---| +| **`strncpy`** | `` | +| **`wcsncpy`** | `` or `` | +| **`_mbsncpy`**, **`_mbsncpy_l`** | `` | For more platform compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strnextc-wcsnextc-mbsnextc-mbsnextc-l.md b/docs/c-runtime-library/reference/strnextc-wcsnextc-mbsnextc-mbsnextc-l.md index 6303b35dbde..61f098070a7 100644 --- a/docs/c-runtime-library/reference/strnextc-wcsnextc-mbsnextc-mbsnextc-l.md +++ b/docs/c-runtime-library/reference/strnextc-wcsnextc-mbsnextc-mbsnextc-l.md @@ -59,9 +59,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcsnextc`|**`_strnextc`**|**`_mbsnextc`**|**`_wcsnextc`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsnextc` | **`_strnextc`** | **`_mbsnextc`** | **`_wcsnextc`** | **`_strnextc`** and **`_wcsnextc`** are single-byte-character string and wide-character string versions of **`_mbsnextc`**. **`_wcsnextc`** returns the integer value of the next wide character in *`str`*; **`_strnextc`** returns the integer value of the next single-byte character in *`str`*. **`_strnextc`** and **`_wcsnextc`** are provided only for this mapping and shouldn't be used otherwise. For more information, see [Using generic-text mappings](../using-generic-text-mappings.md) and [Generic-text mappings](../generic-text-mappings.md). @@ -69,12 +69,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsnextc`**|\| -|**`_mbsnextc_l`**|\| -|**`_strnextc`**|\| -|**`_wcsnextc`**|\| +| Routine | Required header | +|---|---| +| **`_mbsnextc`** | \ | +| **`_mbsnextc_l`** | \ | +| **`_strnextc`** | \ | +| **`_wcsnextc`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strnicmp-wcsnicmp-mbsnicmp-strnicmp-l-wcsnicmp-l-mbsnicmp-l.md b/docs/c-runtime-library/reference/strnicmp-wcsnicmp-mbsnicmp-strnicmp-l-wcsnicmp-l-mbsnicmp-l.md index 88ad6a374cb..2fd8abb92e4 100644 --- a/docs/c-runtime-library/reference/strnicmp-wcsnicmp-mbsnicmp-strnicmp-l-wcsnicmp-l-mbsnicmp-l.md +++ b/docs/c-runtime-library/reference/strnicmp-wcsnicmp-mbsnicmp-strnicmp-l-wcsnicmp-l-mbsnicmp-l.md @@ -70,11 +70,11 @@ Locale to use. Indicates the relationship between the substrings, as follows. -|Return value|Description| -|------------------|-----------------| -|< 0|*`string1`* substring is less than *`string2`* substring.| -|0|*`string1`* substring is identical to *`string2`* substring.| -|> 0|*`string1`* substring is greater than *`string2`* substring.| +| Return value | Description | +|---|---| +| < 0 | *`string1`* substring is less than *`string2`* substring. | +| 0 | *`string1`* substring is identical to *`string2`* substring. | +| > 0 | *`string1`* substring is greater than *`string2`* substring. | On a parameter validation error, these functions return `_NLSCMPERROR`, which is defined in \ and \. @@ -92,19 +92,19 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsncicmp`|**`_strnicmp`**|**`_mbsnicmp`**|**`_wcsnicmp`**| -|`_tcsnicmp`|**`_strnicmp`**|**`_mbsnbicmp`**|**`_wcsnicmp`**| -|`_tcsncicmp_l`|**`_strnicmp_l`**|**`_mbsnicmp_l`**|**`_wcsnicmp_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsncicmp` | **`_strnicmp`** | **`_mbsnicmp`** | **`_wcsnicmp`** | +| `_tcsnicmp` | **`_strnicmp`** | **`_mbsnbicmp`** | **`_wcsnicmp`** | +| `_tcsncicmp_l` | **`_strnicmp_l`** | **`_mbsnicmp_l`** | **`_wcsnicmp_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strnicmp`**, **`_strnicmp_l`**|\| -|**`_wcsnicmp`**, **`_wcsnicmp_l`**|\ or \| -|**`_mbsnicmp`**, **`_mbsnicmp_l`**|\| +| Routine | Required header | +|---|---| +| **`_strnicmp`**, **`_strnicmp_l`** | \ | +| **`_wcsnicmp`**, **`_wcsnicmp_l`** | \ or \ | +| **`_mbsnicmp`**, **`_mbsnicmp_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md b/docs/c-runtime-library/reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md index 6d010f05804..0fad403f045 100644 --- a/docs/c-runtime-library/reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md +++ b/docs/c-runtime-library/reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md @@ -70,11 +70,11 @@ The locale to use. Each of these functions returns a value indicating the relationship of the substrings of *`string1`* and *`string2`*, as follows. -|Return value|Relationship of string1 to string2| -|------------------|----------------------------------------| -|< 0|*`string1`* less than *`string2`*| -|0|*`string1`* identical to *`string2`*| -|> 0|*`string1`* greater than *`string2`*| +| Return value | Relationship of string1 to string2 | +|---|---| +| < 0 | *`string1`* less than *`string2`* | +| 0 | *`string1`* identical to *`string2`* | +| > 0 | *`string1`* greater than *`string2`* | Each of these functions returns `_NLSCMPERROR`. To use `_NLSCMPERROR`, include either STRING.H or MBSTRING.H. **`_wcsnicoll`** can fail if either *`string1`* or *`string2`* contains wide-character codes outside the domain of the collating sequence. When an error occurs, **`_wcsnicoll`** may set `errno` to `EINVAL`. To check for an error on a call to **`_wcsnicoll`**, set `errno` to 0 and then check `errno` after calling **`_wcsnicoll`**. @@ -88,19 +88,19 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsncicoll`|**`_strnicoll`**|**`_mbsnbicoll`**|**`_wcsnicoll`**| -|`_tcsnicoll`|**`_strnicoll`**|[`_mbsnbicoll`](mbsnbcoll-mbsnbcoll-l-mbsnbicoll-mbsnbicoll-l.md)|**`_wcsnicoll`**| -|`_tcsnicoll_l`|**`_strnicoll_l`**|**`_mbsnbicoll_l`**|**`_wcsnicoll_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsncicoll` | **`_strnicoll`** | **`_mbsnbicoll`** | **`_wcsnicoll`** | +| `_tcsnicoll` | **`_strnicoll`** | [`_mbsnbicoll`](mbsnbcoll-mbsnbcoll-l-mbsnbicoll-mbsnbicoll-l.md) | **`_wcsnicoll`** | +| `_tcsnicoll_l` | **`_strnicoll_l`** | **`_mbsnbicoll_l`** | **`_wcsnicoll_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strnicoll`**, **`_strnicoll_l`**|\| -|**`_wcsnicoll`**, **`_wcsnicoll_l`**|\ or \| -|**`_mbsnicoll`**, **`_mbsnicoll_l`**|\| +| Routine | Required header | +|---|---| +| **`_strnicoll`**, **`_strnicoll_l`** | \ | +| **`_wcsnicoll`**, **`_wcsnicoll_l`** | \ or \ | +| **`_mbsnicoll`**, **`_mbsnicoll_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strninc-wcsninc-mbsninc-mbsninc-l.md b/docs/c-runtime-library/reference/strninc-wcsninc-mbsninc-mbsninc-l.md index fccdfd7830b..5e37dd5b259 100644 --- a/docs/c-runtime-library/reference/strninc-wcsninc-mbsninc-mbsninc-l.md +++ b/docs/c-runtime-library/reference/strninc-wcsninc-mbsninc-mbsninc-l.md @@ -62,9 +62,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcsninc`|**`_strninc`**|**`_mbsninc`**|**`_wcsninc`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsninc` | **`_strninc`** | **`_mbsninc`** | **`_wcsninc`** | **`_strninc`** and **`_wcsninc`** are single-byte-character string and wide-character string versions of **`_mbsninc`**. **`_wcsninc`** and **`_strninc`** are provided only for this mapping and shouldn't be used otherwise. For more information, see [Using generic-text mappings](../using-generic-text-mappings.md) and [Generic-text mappings](../generic-text-mappings.md). @@ -72,12 +72,12 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsninc`**|\| -|**`_mbsninc_l`**|\| -|**`_strninc`**|\| -|**`_wcsninc`**|\| +| Routine | Required header | +|---|---| +| **`_mbsninc`** | \ | +| **`_mbsninc_l`** | \ | +| **`_strninc`** | \ | +| **`_wcsninc`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strnlen-strnlen-s.md b/docs/c-runtime-library/reference/strnlen-strnlen-s.md index 3ff39d4dfee..af6b35caa96 100644 --- a/docs/c-runtime-library/reference/strnlen-strnlen-s.md +++ b/docs/c-runtime-library/reference/strnlen-strnlen-s.md @@ -90,11 +90,11 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcsnlen`**|**`strnlen`**|**`strnlen`**|**`wcsnlen`**| -|**`_tcscnlen`**|**`strnlen`**|**`_mbsnlen`**|**`wcsnlen`**| -|**`_tcscnlen_l`**|**`strnlen`**|**`_mbsnlen_l`**|**`wcsnlen`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsnlen` | **`strnlen`** | **`strnlen`** | **`wcsnlen`** | +| `_tcscnlen` | **`strnlen`** | **`_mbsnlen`** | **`wcsnlen`** | +| `_tcscnlen_l` | **`strnlen`** | **`_mbsnlen_l`** | **`wcsnlen`** | **`_mbsnlen`** and **`_mbstrnlen`** return the number of multibyte characters in a multibyte-character string. **`_mbsnlen`** recognizes multibyte-character sequences according to the multibyte code page that's currently in use or according to the locale that's passed in; it doesn't test for multibyte-character validity. **`_mbstrnlen`** tests for multibyte-character validity and recognizes multibyte-character sequences. If the string that's passed to **`_mbstrnlen`** contains an invalid multibyte character, `errno` is set to `EILSEQ`. @@ -102,12 +102,12 @@ The output value is affected by the setting of the `LC_CTYPE` category setting o ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strnlen`**, **`strnlen_s`**|``| -|**`wcsnlen`**, **`wcsnlen_s`**|`` or ``| -|**`_mbsnlen`**, **`_mbsnlen_l`**|``| -|**`_mbstrnlen`**, **`_mbstrnlen_l`**|``| +| Routine | Required header | +|---|---| +| **`strnlen`**, **`strnlen_s`** | `` | +| **`wcsnlen`**, **`wcsnlen_s`** | `` or `` | +| **`_mbsnlen`**, **`_mbsnlen_l`** | `` | +| **`_mbstrnlen`**, **`_mbstrnlen_l`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strnset-s-strnset-s-l-wcsnset-s-wcsnset-s-l-mbsnset-s-mbsnset-s-l.md b/docs/c-runtime-library/reference/strnset-s-strnset-s-l-wcsnset-s-wcsnset-s-l-mbsnset-s-mbsnset-s-l.md index 35cf19cafa3..b46e5d3aecb 100644 --- a/docs/c-runtime-library/reference/strnset-s-strnset-s-l-wcsnset-s-wcsnset-s-l-mbsnset-s-mbsnset-s-l.md +++ b/docs/c-runtime-library/reference/strnset-s-strnset-s-l-wcsnset-s-wcsnset-s-l-mbsnset-s-mbsnset-s-l.md @@ -98,20 +98,20 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsnset_s`|**`_strnset_s`**|**`_mbsnbset_s`**|**`_wcsnset_s`**| -|`_tcsnset_s_l`|**`_strnset_s_l`**|**`_mbsnbset_s_l`**|**`_wcsnset_s_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsnset_s` | **`_strnset_s`** | **`_mbsnbset_s`** | **`_wcsnset_s`** | +| `_tcsnset_s_l` | **`_strnset_s_l`** | **`_mbsnbset_s_l`** | **`_wcsnset_s_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strnset_s`**|\| -|**`_strnset_s_l`**|\| -|**`_wcsnset_s`**|\ or \| -|**`_wcsnset_s_l`**|\| -|**`_mbsnset_s`**, **`_mbsnset_s_l`**|\| +| Routine | Required header | +|---|---| +| **`_strnset_s`** | \ | +| **`_strnset_s_l`** | \ | +| **`_wcsnset_s`** | \ or \ | +| **`_wcsnset_s_l`** | \ | +| **`_mbsnset_s`**, **`_mbsnset_s_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strnset-strnset-l-wcsnset-wcsnset-l-mbsnset-mbsnset-l.md b/docs/c-runtime-library/reference/strnset-strnset-l-wcsnset-wcsnset-l-mbsnset-mbsnset-l.md index a3a1ecde651..dffddf819f0 100644 --- a/docs/c-runtime-library/reference/strnset-strnset-l-wcsnset-wcsnset-l-mbsnset-mbsnset-l.md +++ b/docs/c-runtime-library/reference/strnset-strnset-l-wcsnset-wcsnset-l-mbsnset-mbsnset-l.md @@ -87,20 +87,20 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsnset`|**`_strnset`**|**`_mbsnbset`**|**`_wcsnset`**| -|`_tcsnset_l`|**`_strnset_l`**|**`_mbsnbset_l`**|**`_wcsnset_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsnset` | **`_strnset`** | **`_mbsnbset`** | **`_wcsnset`** | +| `_tcsnset_l` | **`_strnset_l`** | **`_mbsnbset_l`** | **`_wcsnset_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strnset`**|\| -|**`_strnset_l`**|\| -|**`_wcsnset`**|\ or \| -|**`_wcsnset_l`**|\| -|**`_mbsnset`**, **`_mbsnset_l`**|\| +| Routine | Required header | +|---|---| +| **`_strnset`** | \ | +| **`_strnset_l`** | \ | +| **`_wcsnset`** | \ or \ | +| **`_wcsnset_l`** | \ | +| **`_mbsnset`**, **`_mbsnset_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strpbrk-wcspbrk-mbspbrk-mbspbrk-l.md b/docs/c-runtime-library/reference/strpbrk-wcspbrk-mbspbrk-mbspbrk-l.md index d5c4c0cfaae..4a6e17aa7d7 100644 --- a/docs/c-runtime-library/reference/strpbrk-wcspbrk-mbspbrk-mbspbrk-l.md +++ b/docs/c-runtime-library/reference/strpbrk-wcspbrk-mbspbrk-mbspbrk-l.md @@ -15,7 +15,7 @@ ms.assetid: 80b504f7-a167-4dde-97ad-4ae3000dc810 Scans strings for characters in specified character sets. > [!IMPORTANT] -> `_mbspbrk` and `_mbspbrk_l` 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). +> **`_mbspbrk`** and **`_mbspbrk_l`** 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). ## Syntax @@ -90,13 +90,13 @@ Returns a pointer to the first occurrence of any character from *`strCharSet`* i ## Remarks -The `strpbrk` function returns a pointer to the first occurrence of a character in *`str`* that belongs to the set of characters in *`strCharSet`*. The search doesn't include the terminating null character. +The **`strpbrk`** function returns a pointer to the first occurrence of a character in *`str`* that belongs to the set of characters in *`strCharSet`*. The search doesn't include the terminating null character. -`wcspbrk` and `_mbspbrk` are wide-character and multibyte-character versions of `strpbrk`. The arguments and return value of `wcspbrk` are wide-character strings. The arguments and return value of `_mbspbrk` are multibyte-character strings. +**`wcspbrk`** and **`_mbspbrk`** are wide-character and multibyte-character versions of **`strpbrk`**. The arguments and return value of **`wcspbrk`** are wide-character strings. The arguments and return value of **`_mbspbrk`** are multibyte-character strings. -`_mbspbrk` validates its parameters. If *`str`* or *`strCharSet`* is `NULL`, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `_mbspbrk` returns `NULL` and sets `errno` to `EINVAL`. `strpbrk` and `wcspbrk` don't validate their parameters. These three functions behave identically otherwise. +**`_mbspbrk`** validates its parameters. If *`str`* or *`strCharSet`* is `NULL`, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, **`_mbspbrk`** returns `NULL` and sets `errno` to `EINVAL`. **`strpbrk`** and **`wcspbrk`** don't validate their parameters. These three functions behave identically otherwise. -`_mbspbrk` is similar to `_mbscspn` except that `_mbspbrk` returns a pointer rather than a value of type [`size_t`](../standard-types.md). +**`_mbspbrk`** is similar to `_mbscspn` except that **`_mbspbrk`** returns a pointer rather than a value of type [`size_t`](../standard-types.md). In C, these functions take a **`const`** pointer for the first argument. In C++, two overloads are available. The overload taking a pointer to **`const`** returns a pointer to **`const`**; the version that takes a pointer to non-**`const`** returns a pointer to non-**`const`**. The macro `_CRT_CONST_CORRECT_OVERLOADS` is defined if both the **`const`** and non-**`const`** versions of these functions are available. If you require the non-**`const`** behavior for both C++ overloads, define the symbol `_CONST_RETURN`. @@ -106,18 +106,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcspbrk`|`strpbrk`|`_mbspbrk`|`wcspbrk`| -|**n/a**|**n/a**|`_mbspbrk_l`|**n/a**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcspbrk` | **`strpbrk`** | **`_mbspbrk`** | **`wcspbrk`** | +| **n/a** | **n/a** | **`_mbspbrk_l`** | **n/a** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`strpbrk`|\| -|`wcspbrk`|\ or \| -|`_mbspbrk`, `_mbspbrk_l`|\| +| Routine | Required header | +|---|---| +| **`strpbrk`** | \ | +| **`wcspbrk`** | \ or \ | +| **`_mbspbrk`**, **`_mbspbrk_l`** | \ | For more information about compatibility, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strrchr-wcsrchr-mbsrchr-mbsrchr-l.md b/docs/c-runtime-library/reference/strrchr-wcsrchr-mbsrchr-mbsrchr-l.md index 36a2739abe4..4733dd7efc4 100644 --- a/docs/c-runtime-library/reference/strrchr-wcsrchr-mbsrchr-mbsrchr-l.md +++ b/docs/c-runtime-library/reference/strrchr-wcsrchr-mbsrchr-mbsrchr-l.md @@ -14,7 +14,7 @@ helpviewer_keywords: ["_mbsrchr function", "tcsrchr function", "mbsrchr_l functi Scans a string for the last occurrence of a character. > [!IMPORTANT] -> `_mbsrchr` and `_mbsrchr_l` 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). +> **`_mbsrchr`** and **`_mbsrchr_l`** 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). ## Syntax @@ -89,13 +89,13 @@ Returns a pointer to the last occurrence of *`c`* in *`str`*, or `NULL` if *`c`* ## Remarks -The `strrchr` function finds the last occurrence of *`c`* (converted to **`char`**) in *`str`*. The search includes the terminating `NULL` character. +The **`strrchr`** function finds the last occurrence of *`c`* (converted to **`char`**) in *`str`*. The search includes the terminating `NULL` character. -`wcsrchr` and `_mbsrchr` are wide-character and multibyte-character versions of `strrchr`. The arguments and return value of `wcsrchr` are wide-character strings. The arguments and return value of `_mbsrchr` are multibyte-character strings. +**`wcsrchr`** and **`_mbsrchr`** are wide-character and multibyte-character versions of **`strrchr`**. The arguments and return value of **`wcsrchr`** are wide-character strings. The arguments and return value of **`_mbsrchr`** are multibyte-character strings. In C, these functions take a **`const`** pointer for the first argument. In C++, two overloads are available. The overload taking a pointer to **`const`** returns a pointer to **`const`**; the version that takes a pointer to non-**`const`** returns a pointer to non-**`const`**. The macro `_CRT_CONST_CORRECT_OVERLOADS` is defined if both the **`const`** and non-**`const`** versions of these functions are available. If you require the non-**`const`** behavior for both C++ overloads, define the symbol `_CONST_RETURN`. -`_mbsrchr` validates its parameters. If *`str`* is `NULL`, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `errno` is set to `EINVAL` and `_mbsrchr` returns 0. `strrchr` and `wcsrchr` don't validate their parameters. These three functions behave identically otherwise. +**`_mbsrchr`** validates its parameters. If *`str`* is `NULL`, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `errno` is set to `EINVAL` and **`_mbsrchr`** returns 0. **`strrchr`** and **`wcsrchr`** don't validate their parameters. These three functions behave identically otherwise. The output value is affected by the setting of the `LC_CTYPE` category setting of the locale; for more information, see [`setlocale`](setlocale-wsetlocale.md). The versions of these functions without the **`_l`** suffix use the current locale for this locale-dependent behavior; the versions with the **`_l`** suffix are identical except that they use the locale parameter passed in instead. For more information, see [Locale](../locale.md). @@ -103,24 +103,24 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsrchr`|`strrchr`|`_mbsrchr`|`wcsrchr`| -|**n/a**|**n/a**|`_mbsrchr_l`|**n/a**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsrchr` | **`strrchr`** | **`_mbsrchr`** | **`wcsrchr`** | +| **n/a** | **n/a** | **`_mbsrchr_l`** | **n/a** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`strrchr`|``| -|`wcsrchr`|`` or ``| -|`_mbsrchr`, `_mbsrchr_l`|``| +| Routine | Required header | +|---|---| +| **`strrchr`** | `` | +| **`wcsrchr`** | `` or `` | +| **`_mbsrchr`**, **`_mbsrchr_l`** | `` | For more information about compatibility, see [Compatibility](../compatibility.md). ## Example -For an example of using `strrchr`, see [`strchr`](strchr-wcschr-mbschr-mbschr-l.md). +For an example of using **`strrchr`**, see [`strchr`](strchr-wcschr-mbschr-mbschr-l.md). ## See also diff --git a/docs/c-runtime-library/reference/strrev-wcsrev-mbsrev-mbsrev-l.md b/docs/c-runtime-library/reference/strrev-wcsrev-mbsrev-mbsrev-l.md index 88f99ad4e35..29a96ce23ad 100644 --- a/docs/c-runtime-library/reference/strrev-wcsrev-mbsrev-mbsrev-l.md +++ b/docs/c-runtime-library/reference/strrev-wcsrev-mbsrev-mbsrev-l.md @@ -62,18 +62,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsrev`|**`_strrev`**|**`_mbsrev`**|**`_wcsrev`**| -|**n/a**|**n/a**|**`_mbsrev_l`**|**n/a**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsrev` | **`_strrev`** | **`_mbsrev`** | **`_wcsrev`** | +| **n/a** | **n/a** | **`_mbsrev_l`** | **n/a** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strrev`**|\| -|**`_wcsrev`**|\ or \| -|**`_mbsrev`**, **`_mbsrev_l`**|\| +| Routine | Required header | +|---|---| +| **`_strrev`** | \ | +| **`_wcsrev`** | \ or \ | +| **`_mbsrev`**, **`_mbsrev_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strset-s-strset-s-l-wcsset-s-wcsset-s-l-mbsset-s-mbsset-s-l.md b/docs/c-runtime-library/reference/strset-s-strset-s-l-wcsset-s-wcsset-s-l-mbsset-s-mbsset-s-l.md index 1aa5460076c..95e5f3b333c 100644 --- a/docs/c-runtime-library/reference/strset-s-strset-s-l-wcsset-s-wcsset-s-l-mbsset-s-mbsset-s-l.md +++ b/docs/c-runtime-library/reference/strset-s-strset-s-l-wcsset-s-wcsset-s-l-mbsset-s-mbsset-s-l.md @@ -87,20 +87,20 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsset_s`|**`_strset_s`**|**`_mbsset_s`**|**`_wcsset_s`**| -|`_tcsset_s_l`|**`_strset_s_l`**|**`_mbsset_s_l`**|**`_wcsset_s_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsset_s` | **`_strset_s`** | **`_mbsset_s`** | **`_wcsset_s`** | +| `_tcsset_s_l` | **`_strset_s_l`** | **`_mbsset_s_l`** | **`_wcsset_s_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strset_s`**|\| -|**`_strset_s_l`**|\| -|**`_wcsset_s`**|\ or \| -|**`_wcsset_s_l`**|\| -|**`_mbsset_s`**, **`_mbsset_s_l`**|\| +| Routine | Required header | +|---|---| +| **`_strset_s`** | \ | +| **`_strset_s_l`** | \ | +| **`_wcsset_s`** | \ or \ | +| **`_wcsset_s_l`** | \ | +| **`_mbsset_s`**, **`_mbsset_s_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strset-strset-l-wcsset-wcsset-l-mbsset-mbsset-l.md b/docs/c-runtime-library/reference/strset-strset-l-wcsset-wcsset-l-mbsset-mbsset-l.md index 8a267309c9c..4e248577b6f 100644 --- a/docs/c-runtime-library/reference/strset-strset-l-wcsset-wcsset-l-mbsset-mbsset-l.md +++ b/docs/c-runtime-library/reference/strset-strset-l-wcsset-wcsset-l-mbsset-mbsset-l.md @@ -79,20 +79,20 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsset`|**`_strset`**|**`_mbsset`**|**`_wcsset`**| -|`_tcsset_l`|**`_strset_l`**|**`_mbsset_l`**|**`_wcsset_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsset` | **`_strset`** | **`_mbsset`** | **`_wcsset`** | +| `_tcsset_l` | **`_strset_l`** | **`_mbsset_l`** | **`_wcsset_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strset`**|\| -|**`_strset_l`**|\| -|**`_wcsset`**|\ or \| -|**`_wcsset_l`**|\| -|**`_mbsset`**, **`_mbsset_l`**|\| +| Routine | Required header | +|---|---| +| **`_strset`** | \ | +| **`_strset_l`** | \ | +| **`_wcsset`** | \ or \ | +| **`_wcsset_l`** | \ | +| **`_mbsset`**, **`_mbsset_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strspn-wcsspn-mbsspn-mbsspn-l.md b/docs/c-runtime-library/reference/strspn-wcsspn-mbsspn-mbsspn-l.md index fce5c2f5e14..2d03bd56e00 100644 --- a/docs/c-runtime-library/reference/strspn-wcsspn-mbsspn-mbsspn-l.md +++ b/docs/c-runtime-library/reference/strspn-wcsspn-mbsspn-mbsspn-l.md @@ -66,18 +66,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsspn`|**`strspn`**|**`_mbsspn`**|**`wcsspn`**| -|**n/a**|**n/a**|**`_mbsspn_l`**|**n/a**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsspn` | **`strspn`** | **`_mbsspn`** | **`wcsspn`** | +| **n/a** | **n/a** | **`_mbsspn_l`** | **n/a** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strspn`**|\| -|**`wcsspn`**|\ or \| -|**`_mbsspn`**, **`_mbsspn_l`**|\| +| Routine | Required header | +|---|---| +| **`strspn`** | \ | +| **`wcsspn`** | \ or \ | +| **`_mbsspn`**, **`_mbsspn_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strspnp-wcsspnp-mbsspnp-mbsspnp-l.md b/docs/c-runtime-library/reference/strspnp-wcsspnp-mbsspnp-mbsspnp-l.md index 910eae5aa61..a106a71ff3d 100644 --- a/docs/c-runtime-library/reference/strspnp-wcsspnp-mbsspnp-mbsspnp-l.md +++ b/docs/c-runtime-library/reference/strspnp-wcsspnp-mbsspnp-mbsspnp-l.md @@ -64,9 +64,9 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tcsspnp`|**`_strspnp`**|**`_mbsspnp`**|**`_wcsspnp`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsspnp` | **`_strspnp`** | **`_mbsspnp`** | **`_wcsspnp`** | **`_strspnp`** and **`_wcsspnp`** are single-byte character and wide-character versions of **`_mbsspnp`**. **`_strspnp`** and **`_wcsspnp`** behave identically to **`_mbsspnp`** otherwise; they're provided only for this mapping and shouldn't be used for any other reason. For more information, see [Using generic-text mappings](../using-generic-text-mappings.md) and [Generic-text mappings](../generic-text-mappings.md). @@ -74,11 +74,11 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_mbsspnp`**|\| -|**`_strspnp`**|\| -|**`_wcsspnp`**|\| +| Routine | Required header | +|---|---| +| **`_mbsspnp`** | \ | +| **`_strspnp`** | \ | +| **`_wcsspnp`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strstr-wcsstr-mbsstr-mbsstr-l.md b/docs/c-runtime-library/reference/strstr-wcsstr-mbsstr-mbsstr-l.md index 15c6ff25192..3c4d337e3ee 100644 --- a/docs/c-runtime-library/reference/strstr-wcsstr-mbsstr-mbsstr-l.md +++ b/docs/c-runtime-library/reference/strstr-wcsstr-mbsstr-mbsstr-l.md @@ -15,7 +15,7 @@ ms.assetid: 03d70c3f-2473-45cb-a5f8-b35beeb2748a Returns a pointer to the first occurrence of a search string in a string. > [!IMPORTANT] -> `_mbsstr` and `_mbsstr_l` 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). +> **`_mbsstr`** and **`_mbsstr_l`** 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). ## Syntax @@ -90,7 +90,7 @@ Returns a pointer to the first occurrence of *`strSearch`* in *`str`*, or `NULL` ## Remarks -The `strstr` function returns a pointer to the first occurrence of *`strSearch`* in *`str`*. The search doesn't include terminating null characters. `wcsstr` is the wide-character version of `strstr` and `_mbsstr` is the multibyte-character version. The arguments and return value of `wcsstr` are wide-character strings. The arguments and return value of `_mbsstr` are multibyte-character strings. `_mbsstr` validates its parameters. If *`str`* or *`strSearch`* is `NULL`, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md) . If execution is allowed to continue, `_mbsstr` sets `errno` to `EINVAL` and returns 0. `strstr` and `wcsstr` don't validate their parameters. These three functions behave identically otherwise. +The **`strstr`** function returns a pointer to the first occurrence of *`strSearch`* in *`str`*. The search doesn't include terminating null characters. **`wcsstr`** is the wide-character version of **`strstr`** and **`_mbsstr`** is the multibyte-character version. The arguments and return value of **`wcsstr`** are wide-character strings. The arguments and return value of **`_mbsstr`** are multibyte-character strings. **`_mbsstr`** validates its parameters. If *`str`* or *`strSearch`* is `NULL`, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md) . If execution is allowed to continue, **`_mbsstr`** sets `errno` to `EINVAL` and returns 0. **`strstr`** and **`wcsstr`** don't validate their parameters. These three functions behave identically otherwise. > [!IMPORTANT] > These functions might incur a threat from a buffer overrun problem. Buffer overrun problems can be used to attack a system because they can allow the execution of arbitrary code, which can cause an unwarranted elevation of privilege. For more information, see [Avoiding buffer overruns](/windows/win32/SecBP/avoiding-buffer-overruns). @@ -103,18 +103,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsstr`|`strstr`|`_mbsstr`|`wcsstr`| -|**n/a**|**n/a**|`_mbsstr_l`|**n/a**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsstr` | **`strstr`** | **`_mbsstr`** | **`wcsstr`** | +| **n/a** | **n/a** | **`_mbsstr_l`** | **n/a** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`strstr`|``| -|`wcsstr`|`` or ``| -|`_mbsstr`, `_mbsstr_l`|``| +| Routine | Required header | +|---|---| +| **`strstr`** | `` | +| **`wcsstr`** | `` or `` | +| **`_mbsstr`**, **`_mbsstr_l`** | `` | For more information about compatibility, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strtime-s-wstrtime-s.md b/docs/c-runtime-library/reference/strtime-s-wstrtime-s.md index 13f3db63765..97de78ba32b 100644 --- a/docs/c-runtime-library/reference/strtime-s-wstrtime-s.md +++ b/docs/c-runtime-library/reference/strtime-s-wstrtime-s.md @@ -51,12 +51,12 @@ If an error condition occurs, the invalid parameter handler is invoked, as descr ### Error conditions -|*`buffer`*|*`numberOfElements`*|Return|Contents of *`buffer`*| -|--------------|------------------------|------------|--------------------------| -|`NULL`|(any)|`EINVAL`|Not modified| -|Not `NULL` (pointing to valid buffer)|0|`EINVAL`|Not modified| -|Not `NULL` (pointing to valid buffer)|0 < size < 9|`EINVAL`|Empty string| -|Not `NULL` (pointing to valid buffer)|Size > 9|0|Current time formatted as specified in the remarks| +| *`buffer`* | *`numberOfElements`* | Return | Contents of *`buffer`* | +|---|---|---|---| +| `NULL` | (any) | `EINVAL` | Not modified | +| Not `NULL` (pointing to valid buffer) | 0 | `EINVAL` | Not modified | +| Not `NULL` (pointing to valid buffer) | 0 < size < 9 | `EINVAL` | Empty string | +| Not `NULL` (pointing to valid buffer) | Size > 9 | 0 | Current time formatted as specified in the remarks | ## Security issues @@ -78,16 +78,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mapping -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tstrtime_s`|**`_strtime_s`**|**`_strtime_s`**|**`_wstrtime_s`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tstrtime_s` | **`_strtime_s`** | **`_strtime_s`** | **`_wstrtime_s`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strtime_s`**|\| -|**`_wstrtime_s`**|\ or \| +| Routine | Required header | +|---|---| +| **`_strtime_s`** | \ | +| **`_wstrtime_s`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strtime-wstrtime.md b/docs/c-runtime-library/reference/strtime-wstrtime.md index e95183c9d49..3432f83291e 100644 --- a/docs/c-runtime-library/reference/strtime-wstrtime.md +++ b/docs/c-runtime-library/reference/strtime-wstrtime.md @@ -54,16 +54,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tstrtime`|**`_strtime`**|**`_strtime`**|**`_wstrtime`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tstrtime` | **`_strtime`** | **`_strtime`** | **`_wstrtime`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strtime`**|\| -|**`_wstrtime`**|\ or \| +| Routine | Required header | +|---|---| +| **`_strtime`** | \ | +| **`_wstrtime`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strtod-strtod-l-wcstod-wcstod-l.md b/docs/c-runtime-library/reference/strtod-strtod-l-wcstod-wcstod-l.md index 31e3c6ba487..7a44c47924b 100644 --- a/docs/c-runtime-library/reference/strtod-strtod-l-wcstod-wcstod-l.md +++ b/docs/c-runtime-library/reference/strtod-strtod-l-wcstod-wcstod-l.md @@ -66,10 +66,10 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcstod`**|**`strtod`**|**`strtod`**|**`wcstod`**| -|**`_tcstod_l`**|**`_strtod_l`**|**`_strtod_l`**|**`_wcstod_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tcstod`** | **`strtod`** | **`strtod`** | **`wcstod`** | +| **`_tcstod_l`** | **`_strtod_l`** | **`_strtod_l`** | **`_wcstod_l`** | The `LC_NUMERIC` category setting of the current locale determines recognition of the radix point character in *`strSource`*. For more information, see [`setlocale`](setlocale-wsetlocale.md). The functions without the **`_l`** suffix use the current locale; **`_strtod_l`** is identical to **`_strtod`** except the former uses the *`locale`* passed in instead. For more information, see [Locale](../locale.md). @@ -103,10 +103,10 @@ The UCRT versions of these functions don't support conversion of Fortran-style ( ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strtod`**, **`_strtod_l`**|C: `` C++: `` or `` | -|**`wcstod`**, **`_wcstod_l`**|C: `` or `` C++: ``, ``, or `` | +| Routine | Required header | +|---|---| +| **`strtod`**, **`_strtod_l`** | C: `` C++: `` or `` | +| **`wcstod`**, **`_wcstod_l`** | C: `` or `` C++: ``, ``, or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strtof-strtof-l-wcstof-wcstof-l.md b/docs/c-runtime-library/reference/strtof-strtof-l-wcstof-wcstof-l.md index 7c23efdcceb..9140e0931aa 100644 --- a/docs/c-runtime-library/reference/strtof-strtof-l-wcstof-wcstof-l.md +++ b/docs/c-runtime-library/reference/strtof-strtof-l-wcstof-wcstof-l.md @@ -64,10 +64,10 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcstof`|**`strtof`**|**`strtof`**|**`wcstof`**| -|`_tcstof_l`|**`_strtof_l`**|**`_strtof_l`**|**`_wcstof_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcstof` | **`strtof`** | **`strtof`** | **`wcstof`** | +| `_tcstof_l` | **`_strtof_l`** | **`_strtof_l`** | **`_wcstof_l`** | The `LC_NUMERIC` category setting of the current locale determines recognition of the radix character in *`strSource`*; for more information, see [`setlocale`, `_wsetlocale`](setlocale-wsetlocale.md). The functions that don't have the `_l` suffix use the current locale; the ones that have the suffix are identical except that they use the locale that's passed in instead. For more information, see [Locale](../locale.md). @@ -83,10 +83,10 @@ The UCRT versions of these functions don't support conversion of Fortran-style ( ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strtof`**, **`_strtof_l`**|C: \ C++: \ or \| -|**`wcstof`**, **`_wcstof_l`**|C: \ or \ C++: \, \ or \| +| Routine | Required header | +|---|---| +| **`strtof`**, **`_strtof_l`** | C: \ C++: \ or \ | +| **`wcstof`**, **`_wcstof_l`** | C: \ or \ C++: \, \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strtoi64-wcstoi64-strtoi64-l-wcstoi64-l.md b/docs/c-runtime-library/reference/strtoi64-wcstoi64-strtoi64-l-wcstoi64-l.md index 6ad6c3a4f33..043f286ffa3 100644 --- a/docs/c-runtime-library/reference/strtoi64-wcstoi64-strtoi64-l-wcstoi64-l.md +++ b/docs/c-runtime-library/reference/strtoi64-wcstoi64-strtoi64-l-wcstoi64-l.md @@ -73,10 +73,10 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcstoi64`**|**`_strtoi64`**|**`_strtoi64`**|**`_wcstoi64`**| -|**`_tcstoi64_l`**|**`_strtoi64_l`**|**`_strtoi64_l`**|**`_wcstoi64_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| ****`_tcstoi64`**** | **`_strtoi64`** | **`_strtoi64`** | **`_wcstoi64`** | +| ****`_tcstoi64_l`**** | **`_strtoi64_l`** | **`_strtoi64_l`** | **`_wcstoi64_l`** | The locale's `LC_NUMERIC` category setting determines recognition of the radix character in *`strSource`*; for more information, see [`setlocale`](setlocale-wsetlocale.md). The functions without the **`_l`** suffix use the current locale; **`_strtoi64_l`** and **`_wcstoi64_l`** are identical to the corresponding function without the **`_l`** suffix except that they use the locale passed in instead. For more information, see [Locale](../locale.md). @@ -91,7 +91,7 @@ A *`whitespace`* may consist of space and tab characters, which are ignored. *`d ## Requirements | Function | Required header | -|--|--| +|---|---| | **`_strtoi64`**, **`_strtoi64_l`** | `` | | **`_wcstoi64`**, **`_wcstoi64_l`** | `` or `` | diff --git a/docs/c-runtime-library/reference/strtoimax-strtoimax-l-wcstoimax-wcstoimax-l.md b/docs/c-runtime-library/reference/strtoimax-strtoimax-l-wcstoimax-wcstoimax-l.md index 1bbddc95349..c6bcf88b3f3 100644 --- a/docs/c-runtime-library/reference/strtoimax-strtoimax-l-wcstoimax-wcstoimax-l.md +++ b/docs/c-runtime-library/reference/strtoimax-strtoimax-l-wcstoimax-wcstoimax-l.md @@ -75,10 +75,10 @@ If *`endptr`* isn't `NULL`, a pointer to the character that stopped the scan is ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcstoimax`|**`strtoimax`**|**`strtoimax`**|**`wcstoimax`**| -|`_tcstoimax_l`|**`strtoimax_l`**|**`_strtoimax_l`**|**`_wcstoimax_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcstoimax` | **`strtoimax`** | **`strtoimax`** | **`wcstoimax`** | +| `_tcstoimax_l` | **`strtoimax_l`** | **`_strtoimax_l`** | **`_wcstoimax_l`** | **`strtoimax`** expects *`strSource`* to point to a string of the following form: @@ -88,9 +88,9 @@ A *`whitespace`* may consist of space and tab characters, which are ignored; *`d ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strtoimax`**, **`_strtoimax_l`**, **`wcstoimax`**, **`_wcstoimax_l`**|\| +| Routine | Required header | +|---|---| +| **`strtoimax`**, **`_strtoimax_l`**, **`wcstoimax`**, **`_wcstoimax_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strtok-s-strtok-s-l-wcstok-s-wcstok-s-l-mbstok-s-mbstok-s-l.md b/docs/c-runtime-library/reference/strtok-s-strtok-s-l-wcstok-s-wcstok-s-l-mbstok-s-mbstok-s-l.md index a6df3544d82..c91f6270d16 100644 --- a/docs/c-runtime-library/reference/strtok-s-strtok-s-l-wcstok-s-wcstok-s-l-mbstok-s-mbstok-s-l.md +++ b/docs/c-runtime-library/reference/strtok-s-strtok-s-l-wcstok-s-wcstok-s-l-mbstok-s-mbstok-s-l.md @@ -80,11 +80,11 @@ Returns a pointer to the next token found in *`str`*. Returns `NULL` when no mor ### Error conditions -|*`str`*|*`delimiters`*|*`context`*|Return value|`errno`| -|----------------|------------------|---------------|------------------|-------------| -|`NULL`|any|pointer to a null pointer|`NULL`|`EINVAL`| -|any|`NULL`|any|`NULL`|`EINVAL`| -|any|any|`NULL`|`NULL`|`EINVAL`| +| *`str`* | *`delimiters`* | *`context`* | Return value | `errno` | +|---|---|---|---|---| +| `NULL` | any | pointer to a null pointer | `NULL` | `EINVAL` | +| any | `NULL` | any | `NULL` | `EINVAL` | +| any | any | `NULL` | `NULL` | `EINVAL` | If *`str`* is `NULL` but *`context`* is a pointer to a valid context pointer, there's no error. @@ -104,23 +104,23 @@ The versions of these functions without the **`_l`** suffix use the current thre 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). -## Requirements +### Generic-text routine mappings -|Routine|Required header| -|-------------|---------------------| -|**`strtok_s`**|``| -|**`_strtok_s_l`**|``| -|**`wcstok_s`**,
**`_wcstok_s_l`**|`` or ``| -|**`_mbstok_s`**,
**`_mbstok_s_l`**|``| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcstok_s` | **`strtok_s`** | **`_mbstok_s`** | **`wcstok_s`** | +| `_tcstok_s_l` | **`_strtok_s_l`** | **`_mbstok_s_l`** | **`_wcstok_s_l`** | -For more compatibility information, see [Compatibility](../compatibility.md). +## Requirements -### Generic-text routine mappings +| Routine | Required header | +|---|---| +| **`strtok_s`** | `` | +| **`_strtok_s_l`** | `` | +| **`wcstok_s`**,
**`_wcstok_s_l`** | `` or `` | +| **`_mbstok_s`**,
**`_mbstok_s_l`** | `` | -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcstok_s`**|**`strtok_s`**|**`_mbstok_s`**|**`wcstok_s`**| -|**`_tcstok_s_l`**|**`_strtok_s_l`**|**`_mbstok_s_l`**|**`_wcstok_s_l`**| +For more compatibility information, see [Compatibility](../compatibility.md). ## Example diff --git a/docs/c-runtime-library/reference/strtok-strtok-l-wcstok-wcstok-l-mbstok-mbstok-l.md b/docs/c-runtime-library/reference/strtok-strtok-l-wcstok-wcstok-l-mbstok-mbstok-l.md index dca8af33dea..196c4a9f20e 100644 --- a/docs/c-runtime-library/reference/strtok-strtok-l-wcstok-wcstok-l-mbstok-mbstok-l.md +++ b/docs/c-runtime-library/reference/strtok-strtok-l-wcstok-wcstok-l-mbstok-mbstok-l.md @@ -94,19 +94,19 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcstok`**|**`strtok`**|**`_mbstok`**|**`wcstok`**| -|**`_tcstok`**|**`_strtok_l`**|**`_mbstok_l`**|**`_wcstok_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcstok` | **`strtok`** | **`_mbstok`** | **`wcstok`** | +| `_tcstok` | **`_strtok_l`** | **`_mbstok_l`** | **`_wcstok_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strtok`**|``| -|**`wcstok`**|`` or ``| -|**`_wcstok_l`**|``| -|**`_mbstok`**, **`_mbstok_l`**|``| +| Routine | Required header | +|---|---| +| **`strtok`** | `` | +| **`wcstok`** | `` or `` | +| **`_wcstok_l`** | `` | +| **`_mbstok`**, **`_mbstok_l`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strtol-wcstol-strtol-l-wcstol-l.md b/docs/c-runtime-library/reference/strtol-wcstol-strtol-l-wcstol-l.md index 99dc25be6df..b9ca5c7be4c 100644 --- a/docs/c-runtime-library/reference/strtol-wcstol-strtol-l-wcstol-l.md +++ b/docs/c-runtime-library/reference/strtol-wcstol-strtol-l-wcstol-l.md @@ -79,19 +79,19 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcstol`**|**`strtol`**|**`strtol`**|**`wcstol`**| -|**`_tcstol_l`**|**`_strtol_l`**|**`_strtol_l`**|**`_wcstol_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcstol` | **`strtol`** | **`strtol`** | **`wcstol`** | +| `_tcstol_l` | **`_strtol_l`** | **`_strtol_l`** | **`_wcstol_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strtol`**|``| -|**`wcstol`**|`` or ``| -|**`_strtol_l`**|``| -|**`_wcstol_l`**|`` or ``| +| Routine | Required header | +|---|---| +| **`strtol`** | `` | +| **`wcstol`** | `` or `` | +| **`_strtol_l`** | `` | +| **`_wcstol_l`** | `` or `` | The **`_strtol_l`** and **`_wcstol_l`** functions are Microsoft-specific, not part of the Standard C library. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strtold-strtold-l-wcstold-wcstold-l.md b/docs/c-runtime-library/reference/strtold-strtold-l-wcstold-wcstold-l.md index 6ee7f1dc11b..98c114f43cf 100644 --- a/docs/c-runtime-library/reference/strtold-strtold-l-wcstold-wcstold-l.md +++ b/docs/c-runtime-library/reference/strtold-strtold-l-wcstold-wcstold-l.md @@ -63,10 +63,10 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcstold`|**`strtold`**|**`strtold`**|**`wcstold`**| -|`_tcstold_l`|**`_strtold_l`**|**`_strtold_l`**|**`_wcstold_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcstold` | **`strtold`** | **`strtold`** | **`wcstold`** | +| `_tcstold_l` | **`_strtold_l`** | **`_strtold_l`** | **`_wcstold_l`** | The `LC_NUMERIC` category setting of the current locale determines the recognition of the radix character in *`strSource`*. For more information, see [`setlocale`, `_wsetlocale`](setlocale-wsetlocale.md). The functions without the `_l` suffix use the current locale; **`_strtold_l`** and **`_wcstold_l`** are identical to **`_strtold`** and **`_wcstold`** except that they instead use the locale that's passed in. For more information, see [Locale](../locale.md). @@ -80,10 +80,10 @@ A *`whitespace`* may consist of space and tab characters, which are ignored; *`s ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strtold`**, **`_strtold_l`**|\| -|**`wcstold`**, **`_wcstold_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`strtold`**, **`_strtold_l`** | \ | +| **`wcstold`**, **`_wcstold_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strtoll-strtoll-l-wcstoll-wcstoll-l.md b/docs/c-runtime-library/reference/strtoll-strtoll-l-wcstoll-wcstoll-l.md index 85f10b79ce3..bb73e555ffa 100644 --- a/docs/c-runtime-library/reference/strtoll-strtoll-l-wcstoll-wcstoll-l.md +++ b/docs/c-runtime-library/reference/strtoll-strtoll-l-wcstoll-wcstoll-l.md @@ -73,10 +73,10 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcstoll`|**`strtoll`**|**`strtoll`**|**`wcstoll`**| -|`_tcstoll_l`|**`_strtoll_l`**|**`_strtoll_l`**|**`_wcstoll_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcstoll` | **`strtoll`** | **`strtoll`** | **`wcstoll`** | +| `_tcstoll_l` | **`_strtoll_l`** | **`_strtoll_l`** | **`_wcstoll_l`** | The locale's `LC_NUMERIC` category setting determines recognition of the radix character in *`strSource`*; for more information, see [`setlocale`, `_wsetlocale`](setlocale-wsetlocale.md). The functions that don't have the `_l` suffix use the current locale; **`_strtoll_l`** and **`_wcstoll_l`** are identical to the corresponding functions that don't have the suffix, except that they instead use the locale that's passed in. For more information, see [Locale](../locale.md). @@ -90,10 +90,10 @@ A *`whitespace`* may consist of space and tab characters, which are ignored; *`d ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strtoll`**, **`_strtoll_l`**|\| -|**`wcstoll`**, **`_wcstoll_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`strtoll`**, **`_strtoll_l`** | \ | +| **`wcstoll`**, **`_wcstoll_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strtoui64-wcstoui64-strtoui64-l-wcstoui64-l.md b/docs/c-runtime-library/reference/strtoui64-wcstoui64-strtoui64-l-wcstoui64-l.md index a46a60da2b2..47067f49f01 100644 --- a/docs/c-runtime-library/reference/strtoui64-wcstoui64-strtoui64-l-wcstoui64-l.md +++ b/docs/c-runtime-library/reference/strtoui64-wcstoui64-strtoui64-l-wcstoui64-l.md @@ -75,10 +75,10 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcstoui64`**|**`_strtoui64`**|**`_strtoui64`**|**`_wcstoui64`**| -|**`_tcstoui64_l`**|**`_strtoui64_l`**|**`_strtoui64_l`**|**`_wcstoui64_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcstoui64` | **`_strtoui64`** | **`_strtoui64`** | **`_wcstoui64`** | +| `_tcstoui64_l` | **`_strtoui64_l`** | **`_strtoui64_l`** | **`_wcstoui64_l`** | The current locale's `LC_NUMERIC` category setting determines recognition of the radix character in *`strSource`*; for more information, see [`setlocale`](setlocale-wsetlocale.md). The functions without the **`_l`** suffix use the current locale; **`_strtoui64_l`** and **`_wcstoui64_l`** are identical to the corresponding functions without the **`_l`** suffix except that they use the locale passed in instead. For more information, see [Locale](../locale.md). diff --git a/docs/c-runtime-library/reference/strtoul-strtoul-l-wcstoul-wcstoul-l.md b/docs/c-runtime-library/reference/strtoul-strtoul-l-wcstoul-wcstoul-l.md index 4a1566aba69..0ec7fe3c9b9 100644 --- a/docs/c-runtime-library/reference/strtoul-strtoul-l-wcstoul-wcstoul-l.md +++ b/docs/c-runtime-library/reference/strtoul-strtoul-l-wcstoul-wcstoul-l.md @@ -74,10 +74,10 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tcstoul`**|**`strtoul`**|**`strtoul`**|**`wcstoul`**| -|**`_tcstoul_l`**|**`strtoul_l`**|**`_strtoul_l`**|**`_wcstoul_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcstoul` | **`strtoul`** | **`strtoul`** | **`wcstoul`** | +| `_tcstoul_l` | **`strtoul_l`** | **`_strtoul_l`** | **`_wcstoul_l`** | **`strtoul`** expects *`strSource`* to point to a string of the following form: @@ -87,12 +87,12 @@ A *`whitespace`* may consist of space and tab characters, which are ignored. *`d ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strtoul`**|``| -|**`wcstoul`**|`` or ``| -|**`_strtoul_l`**|``| -|**`_wcstoul_l`**|`` or ``| +| Routine | Required header | +|---|---| +| **`strtoul`** | `` | +| **`wcstoul`** | `` or `` | +| **`_strtoul_l`** | `` | +| **`_wcstoul_l`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strtoull-strtoull-l-wcstoull-wcstoull-l.md b/docs/c-runtime-library/reference/strtoull-strtoull-l-wcstoull-wcstoull-l.md index 818871e8306..baf6b5e45fa 100644 --- a/docs/c-runtime-library/reference/strtoull-strtoull-l-wcstoull-wcstoull-l.md +++ b/docs/c-runtime-library/reference/strtoull-strtoull-l-wcstoull-wcstoull-l.md @@ -75,10 +75,10 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcstoull`|**`strtoull`**|**`strtoull`**|**`wcstoull`**| -|`_tcstoull_l`|**`strtoull_l`**|**`_strtoull_l`**|**`_wcstoull_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcstoull` | **`strtoull`** | **`strtoull`** | **`wcstoull`** | +| `_tcstoull_l` | **`strtoull_l`** | **`_strtoull_l`** | **`_wcstoull_l`** | **`strtoull`** expects *`strSource`* to point to a string of the following form: @@ -88,12 +88,12 @@ A *`whitespace`* may consist of space and tab characters, which are ignored. *`d ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strtoull`**|\| -|**`wcstoull`**|\ or \| -|**`_strtoull_l`**|\| -|**`_wcstoull_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`strtoull`** | \ | +| **`wcstoull`** | \ or \ | +| **`_strtoull_l`** | \ | +| **`_wcstoull_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strtoumax-strtoumax-l-wcstoumax-wcstoumax-l.md b/docs/c-runtime-library/reference/strtoumax-strtoumax-l-wcstoumax-wcstoumax-l.md index 2ffa20876e4..1375351b560 100644 --- a/docs/c-runtime-library/reference/strtoumax-strtoumax-l-wcstoumax-wcstoumax-l.md +++ b/docs/c-runtime-library/reference/strtoumax-strtoumax-l-wcstoumax-wcstoumax-l.md @@ -73,10 +73,10 @@ The wide-character version of **`strtoumax`** is **`wcstoumax`**; its *`strSourc ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcstoumax`|**`strtoumax`**|**`strtoumax`**|**`wcstoumax`**| -|`_tcstoumax_l`|**`strtoumax_l`**|**`_strtoumax_l`**|**`_wcstoumax_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcstoumax` | **`strtoumax`** | **`strtoumax`** | **`wcstoumax`** | +| `_tcstoumax_l` | **`strtoumax_l`** | **`_strtoumax_l`** | **`_wcstoumax_l`** | **`strtoumax`** expects *`strSource`* to point to a string of the following form: @@ -86,12 +86,12 @@ A *`whitespace`* may consist of space and tab characters, which are ignored. *`d ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strtoumax`**|\| -|**`wcstoumax`**|\ or \| -|**`_strtoumax_l`**|\| -|**`_wcstoumax_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`strtoumax`** | \ | +| **`wcstoumax`** | \ or \ | +| **`_strtoumax_l`** | \ | +| **`_wcstoumax_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strupr-s-strupr-s-l-mbsupr-s-mbsupr-s-l-wcsupr-s-wcsupr-s-l.md b/docs/c-runtime-library/reference/strupr-s-strupr-s-l-mbsupr-s-mbsupr-s-l-wcsupr-s-wcsupr-s-l.md index 6f6147fffd9..13d1aa88ec4 100644 --- a/docs/c-runtime-library/reference/strupr-s-strupr-s-l-mbsupr-s-mbsupr-s-l-wcsupr-s-wcsupr-s-l.md +++ b/docs/c-runtime-library/reference/strupr-s-strupr-s-l-mbsupr-s-mbsupr-s-l-wcsupr-s-wcsupr-s-l.md @@ -97,7 +97,7 @@ These functions validate their parameters. If *`str`* is a `NULL` pointer, the i The **`_strupr_s`** function converts, in place, each lowercase letter in *`str`* to uppercase. **`_wcsupr_s`** is the wide-character version of **`_strupr_s`**. **`_mbsupr_s`** is the multi-byte character version of **`_strupr_s`**. -The conversion is determined by the `LC_CTYPE` category setting of the locale. Other characters are not affected. For more information on `LC_CTYPE`, see [`setlocale`](setlocale-wsetlocale.md). The versions of these functions without the `_l` suffix use the current locale; the visions with the `_l` suffix are identical except that they use the locale passed in instead. For more information, see [Locale](../locale.md). +The conversion is determined by the `LC_CTYPE` category setting of the locale. Other characters aren't affected. For more information on `LC_CTYPE`, see [`setlocale`](setlocale-wsetlocale.md). The versions of these functions without the `_l` suffix use the current locale; the visions with the `_l` suffix are identical except that they use the locale passed in instead. For more information, see [Locale](../locale.md). In C++, using these functions is simplified by template overloads; the overloads can infer buffer length automatically (eliminating the need to specify a size argument) and they can automatically replace older, non-secure functions with their newer, secure counterparts. For more information, see [Secure template overloads](../secure-template-overloads.md). @@ -107,17 +107,17 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsupr_s`|**`_strupr_s`**|**`_mbsupr_s`**|**`_wcsupr_s`**| -|`_tcsupr_s_l`|**`_strupr_s_l`**|**`_mbsupr_s_l`**|**`_wcsupr_s_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsupr_s` | **`_strupr_s`** | **`_mbsupr_s`** | **`_wcsupr_s`** | +| `_tcsupr_s_l` | **`_strupr_s_l`** | **`_mbsupr_s_l`** | **`_wcsupr_s_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strupr_s`**, **`_strupr_s_l`**|\| -|**`_wcsupr_s`**, **`_wcsupr_s_l`**, **`_mbsupr_s`**, **`_mbsupr_s_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`_strupr_s`**, **`_strupr_s_l`** | \ | +| **`_wcsupr_s`**, **`_wcsupr_s_l`**, **`_mbsupr_s`**, **`_mbsupr_s_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strupr-strupr-l-mbsupr-mbsupr-l-wcsupr-l-wcsupr.md b/docs/c-runtime-library/reference/strupr-strupr-l-mbsupr-mbsupr-l-wcsupr-l-wcsupr.md index cf61d033200..19cb0d7082a 100644 --- a/docs/c-runtime-library/reference/strupr-strupr-l-mbsupr-mbsupr-l-wcsupr-l-wcsupr.md +++ b/docs/c-runtime-library/reference/strupr-strupr-l-mbsupr-mbsupr-l-wcsupr-l-wcsupr.md @@ -84,9 +84,9 @@ Returns a pointer to the altered string. Because the modification is done in pla ## Remarks -The **`_strupr`** function converts, in place, each lowercase letter in *`str`* to uppercase. The conversion is determined by the `LC_CTYPE` category setting of the locale. Other characters are not affected. For more information on `LC_CTYPE`, see [`setlocale`](setlocale-wsetlocale.md). The versions of these functions without the `_l` suffix use the current locale; the versions with the `_l` suffix are identical except that they use the locale passed in instead. For more information, see [Locale](../locale.md). +The **`_strupr`** function converts, in place, each lowercase letter in *`str`* to uppercase. The conversion is determined by the `LC_CTYPE` category setting of the locale. Other characters aren't affected. For more information on `LC_CTYPE`, see [`setlocale`](setlocale-wsetlocale.md). The versions of these functions without the `_l` suffix use the current locale; the versions with the `_l` suffix are identical except that they use the locale passed in instead. For more information, see [Locale](../locale.md). -**`_wcsupr`** and **`_mbsupr`** are wide-character and multibyte-character versions of **`_strupr`**. The argument and return value of **`_wcsupr`** are wide-character strings; those of **`_mbsupr`** are multibyte-character strings. These three functions behave identically otherwise. +**`_wcsupr`** and **`_mbsupr`** are wide-character and multibyte-character versions of **`_strupr`**. The argument and return value of **`_wcsupr`** are wide-character strings. The argument and return value of **`_mbsupr`** are multibyte-character strings. These three functions behave identically otherwise. If *`str`* is a null pointer, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md) . If execution is allowed to continue, these functions return the original string and set `errno` to `EINVAL`. @@ -96,18 +96,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsupr`|**`_strupr`**|**`_mbsupr`**|**`_wcsupr`**| -|`_tcsupr_l`|**`_strupr_l`**|**`_mbsupr_l`**|**`_wcsupr_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsupr` | **`_strupr`** | **`_mbsupr`** | **`_wcsupr`** | +| `_tcsupr_l` | **`_strupr_l`** | **`_mbsupr_l`** | **`_wcsupr_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_strupr`**, **`_strupr_l`**|\| -|**`_wcsupr`**, **`_wcsupr_l`**|\ or \| -|**`_mbsupr`**, **`_mbsupr_l`**|\| +| Routine | Required header | +|---|---| +| **`_strupr`**, **`_strupr_l`** | \ | +| **`_wcsupr`**, **`_wcsupr_l`** | \ or \ | +| **`_mbsupr`**, **`_mbsupr_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/strxfrm-wcsxfrm-strxfrm-l-wcsxfrm-l.md b/docs/c-runtime-library/reference/strxfrm-wcsxfrm-strxfrm-l-wcsxfrm-l.md index 55d9f1e018d..f901c61a0fa 100644 --- a/docs/c-runtime-library/reference/strxfrm-wcsxfrm-strxfrm-l-wcsxfrm-l.md +++ b/docs/c-runtime-library/reference/strxfrm-wcsxfrm-strxfrm-l-wcsxfrm-l.md @@ -63,9 +63,9 @@ Returns the length of the transformed string, not counting the terminating null The **`strxfrm`** function transforms the string pointed to by *`strSource`* into a new collated form that is stored in *`strDest`*. No more than *`count`* characters, including the null character, are transformed and placed into the resulting string. The transformation is made using the locale's `LC_COLLATE` category setting. For more information on `LC_COLLATE`, see [`setlocale`](setlocale-wsetlocale.md). **`strxfrm`** uses the current locale for its locale-dependent behavior; **`_strxfrm_l`** is identical except that it uses the locale passed in instead of the current locale. For more information, see [Locale](../locale.md). -After the transformation, a call to `strcmp` with the two transformed strings yields results identical to those of a call to `strcoll` applied to the original two strings. As with `strcoll` and `stricoll`, **`strxfrm`** automatically handles multibyte-character strings as appropriate. +After the transformation, a call to `strcmp` with the two transformed strings yields results identical to the results of a call to `strcoll` applied to the original two strings. As with `strcoll` and `stricoll`, **`strxfrm`** automatically handles multibyte-character strings as appropriate. -**`wcsxfrm`** is a wide-character version of **`strxfrm`**; the string arguments of **`wcsxfrm`** are wide-character pointers. For **`wcsxfrm`**, after the string transformation, a call to `wcscmp` with the two transformed strings yields results identical to those of a call to `wcscoll` applied to the original two strings. **`wcsxfrm`** and **`strxfrm`** behave identically otherwise. **`wcsxfrm`** uses the current locale for its locale-dependent behavior; **`_wcsxfrm_l`** uses the locale passed in instead of the current locale. +**`wcsxfrm`** is a wide-character version of **`strxfrm`**; the string arguments of **`wcsxfrm`** are wide-character pointers. For **`wcsxfrm`**, after the string transformation, a call to `wcscmp` with the two transformed strings yields results identical to the results of a call to `wcscoll` applied to the original two strings. **`wcsxfrm`** and **`strxfrm`** behave identically otherwise. **`wcsxfrm`** uses the current locale for its locale-dependent behavior; **`_wcsxfrm_l`** uses the locale passed in instead of the current locale. These functions validate their parameters. If *`strSource`* is a null pointer, or *`strDest`* is a `NULL` pointer (unless count is zero), or if *`count`* is greater than `INT_MAX`, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md) . If execution is allowed to continue, these functions set `errno` to `EINVAL` and return `INT_MAX`. @@ -73,10 +73,10 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tcsxfrm`|**`strxfrm`**|**`strxfrm`**|**`wcsxfrm`**| -|`_tcsxfrm_l`|**`_strxfrm_l`**|**`_strxfrm_l`**|**`_wcsxfrm_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tcsxfrm` | **`strxfrm`** | **`strxfrm`** | **`wcsxfrm`** | +| `_tcsxfrm_l` | **`_strxfrm_l`** | **`_strxfrm_l`** | **`_wcsxfrm_l`** | In the "C" locale, the order of the characters in the character set (ASCII character set) is the same as the lexicographic order of the characters. However, in other locales, the order of characters in the character set may differ from the lexicographic character order. For example, in certain European locales, the character 'a' (value 0x61) precedes the character '&\#x00E4;' (value 0xE4) in the character set, but the character 'ä' precedes the character 'a' lexicographically. @@ -88,7 +88,7 @@ The value of the following expression is the size of the array needed to hold th `1 + strxfrm( NULL, string, 0 )` -In the "C" locale only, **`strxfrm`** is equivalent to the following: +In the "C" locale only, **`strxfrm`** is equivalent to the following function calls: ```C strncpy( _string1, _string2, _count ); @@ -97,12 +97,12 @@ return( strlen( _string1 ) ); ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`strxfrm`**|\| -|**`wcsxfrm`**|\ or \| -|**`_strxfrm_l`**|\| -|**`_wcsxfrm_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`strxfrm`** | \ | +| **`wcsxfrm`** | \ or \ | +| **`_strxfrm_l`** | \ | +| **`_wcsxfrm_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/swab.md b/docs/c-runtime-library/reference/swab.md index 67cd9177b63..4f2952f6258 100644 --- a/docs/c-runtime-library/reference/swab.md +++ b/docs/c-runtime-library/reference/swab.md @@ -49,9 +49,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_swab`**|C: \ C++: \ or \| +| Routine | Required header | +|---|---| +| **`_swab`** | C: \ C++: \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/system-wsystem.md b/docs/c-runtime-library/reference/system-wsystem.md index af8161f36b7..eaf0ec65aae 100644 --- a/docs/c-runtime-library/reference/system-wsystem.md +++ b/docs/c-runtime-library/reference/system-wsystem.md @@ -42,7 +42,7 @@ If *`command`* is `NULL` and the command interpreter is found, returns a nonzero | `E2BIG` | The argument list (which is system-dependent) is too large. | | `ENOENT` | The command interpreter can't be found. | | `ENOEXEC` | The command-interpreter file can't be executed because the format isn't valid. | -| `ENOMEM` | Not enough memory is available to execute command; or available memory has been corrupted; or a non-valid block exists, which indicates that the process that's making the call wasn't allocated correctly. | +| `ENOMEM` | Not enough memory is available to execute command; or available memory has been corrupted; or a non-valid block exists, which indicates that the calling process has been allocated incorrectly. | For more information about return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -58,16 +58,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_tsystem`**|**`system`**|**`system`**|**`_wsystem`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_tsystem`** | **`system`** | **`system`** | **`_wsystem`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`system`**|`` or ``| -|**`_wsystem`**|`` or `` or ``| +| Routine | Required header | +|---|---| +| **`system`** | `` or `` | +| **`_wsystem`** | `` or `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/tan-tanf-tanl.md b/docs/c-runtime-library/reference/tan-tanf-tanl.md index 89063eabc58..4ca43a7f512 100644 --- a/docs/c-runtime-library/reference/tan-tanf-tanl.md +++ b/docs/c-runtime-library/reference/tan-tanf-tanl.md @@ -37,10 +37,10 @@ Angle in radians. The **`tan`** functions return the tangent 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. -|Input|SEH exception|`Matherr` exception| -|-----------|-------------------|-------------------------| -|`± QNAN`,`IND`|none|`_DOMAIN`| -|`± INF`|`INVALID`|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | `_DOMAIN` | +| ± INF | `INVALID` | `_DOMAIN` | ## Remarks @@ -52,10 +52,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header (C)|Required header (C++)| -|-------------|---------------------|-| -|**`tan`**, **`tanf`**, **`tanl`**|``|`` or ``| -|**`tan()`** macro | `` || +| Routine | Required header (C) | Required header (C++) | +|---|---|---| +| **`tan`**, **`tanf`**, **`tanl`** | `` | `` or `` | +| **`tan`** macro | `` | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/tanh-tanhf-tanhl.md b/docs/c-runtime-library/reference/tanh-tanhf-tanhl.md index b1b597c83c9..45eaa609714 100644 --- a/docs/c-runtime-library/reference/tanh-tanhf-tanhl.md +++ b/docs/c-runtime-library/reference/tanh-tanhf-tanhl.md @@ -36,9 +36,9 @@ Angle in radians. The **`tanh`** functions return the hyperbolic tangent of *`x`*. There's no error return. -|Input|SEH exception|`Matherr` exception| -|-----------|-------------------|-------------------------| -|± `QNAN`,`IND`|none|`_DOMAIN`| +| Input | SEH exception | `_matherr` exception | +|---|---|---| +| ± QNaN, IND | none | `_DOMAIN` | ## Remarks @@ -50,10 +50,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header (C)|Required header (C)| -|-------------|---------------------|-| -|**`tanh`**, **`tanhf`**, **`tanhl`**|``|`` or ``| -|**`tanh()`** macro | `` || +| Routine | Required header (C) | Required header (C) | +|---|---|---| +| **`tanh`**, **`tanhf`**, **`tanhl`** | `` | `` or `` | +| **`tanh`** macro | `` | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/tell-telli64.md b/docs/c-runtime-library/reference/tell-telli64.md index 93d94fd4542..1af54b7d368 100644 --- a/docs/c-runtime-library/reference/tell-telli64.md +++ b/docs/c-runtime-library/reference/tell-telli64.md @@ -46,9 +46,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_tell`**, **`_telli64`**|\| +| Routine | Required header | +|---|---| +| **`_tell`**, **`_telli64`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/tempnam-dbg-wtempnam-dbg.md b/docs/c-runtime-library/reference/tempnam-dbg-wtempnam-dbg.md index bf9f63998e7..e06b583cc8b 100644 --- a/docs/c-runtime-library/reference/tempnam-dbg-wtempnam-dbg.md +++ b/docs/c-runtime-library/reference/tempnam-dbg-wtempnam-dbg.md @@ -36,7 +36,7 @@ wchar_t *_wtempnam_dbg( ### Parameters *`dir`*\ -The path used in the file name if there is no TMP environment variable, or if TMP is not a valid directory. +The path used in the file name if there's no TMP environment variable, or if TMP isn't a valid directory. *`prefix`*\ The string that will be pre-pended to names returned by `_tempnam`. @@ -52,7 +52,7 @@ Line number in source file where allocation operation was requested or `NULL`. ## Return value -Each function returns a pointer to the name generated or `NULL` if there is a failure. Failure can occur if there is an invalid directory name specified in the TMP environment variable and in the *`dir`* parameter. +Each function returns a pointer to the name generated or `NULL` if there's a failure. Failure can occur if there's an invalid directory name specified in the TMP environment variable and in the *`dir`* parameter. > [!NOTE] > `free` (or `free_dbg`) does need to be called for pointers allocated by **`_tempnam_dbg`** and **`_wtempnam_dbg`**. @@ -61,19 +61,19 @@ Each function returns a pointer to the name generated or `NULL` if there is a fa The **`_tempnam_dbg`** and **`_wtempnam_dbg`** functions are identical to `_tempnam` and `_wtempnam` except that, when `_DEBUG` is defined, these functions use the debug version of `malloc` and `_malloc_dbg`, to allocate memory if `NULL` is passed as the first parameter. For more information, see [`_malloc_dbg`](malloc-dbg.md). -You do not need to call these functions explicitly in most cases. Instead, you can define the flag `_CRTDBG_MAP_ALLOC`. When `_CRTDBG_MAP_ALLOC` is defined, calls to `_tempnam` and `_wtempnam` are remapped to **`_tempnam_dbg`** and **`_wtempnam_dbg`**, respectively, with the *`blockType`* set to `_NORMAL_BLOCK`. Thus, you do not need to call these functions explicitly unless you want to mark the heap blocks as `_CLIENT_BLOCK`. For more information, see [Types of blocks on the debug heap](/visualstudio/debugger/crt-debug-heap-details). +You don't need to call these functions explicitly in most cases. Instead, you can define the flag `_CRTDBG_MAP_ALLOC`. When `_CRTDBG_MAP_ALLOC` is defined, calls to `_tempnam` and `_wtempnam` are remapped to **`_tempnam_dbg`** and **`_wtempnam_dbg`**, respectively, with the *`blockType`* set to `_NORMAL_BLOCK`. Thus, you don't need to call these functions explicitly unless you want to mark the heap blocks as `_CLIENT_BLOCK`. For more information, see [Types of blocks on the debug heap](/visualstudio/debugger/crt-debug-heap-details). ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_ttempnam_dbg`|**`_tempnam_dbg`**|**`_tempnam_dbg`**|**`_wtempnam_dbg`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_ttempnam_dbg` | **`_tempnam_dbg`** | **`_tempnam_dbg`** | **`_wtempnam_dbg`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_tempnam_dbg`**, **`_wtempnam_dbg`**|\| +| Routine | Required header | +|---|---| +| **`_tempnam_dbg`**, **`_wtempnam_dbg`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/tempnam-wtempnam-tmpnam-wtmpnam.md b/docs/c-runtime-library/reference/tempnam-wtempnam-tmpnam-wtmpnam.md index cb78fc08623..f7c406980ff 100644 --- a/docs/c-runtime-library/reference/tempnam-wtempnam-tmpnam-wtmpnam.md +++ b/docs/c-runtime-library/reference/tempnam-wtempnam-tmpnam-wtmpnam.md @@ -73,18 +73,18 @@ If `_DEBUG` and `_CRTDBG_MAP_ALLOC` are defined, **`_tempnam`** and **`_wtempnam ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_ttmpnam`|**`tmpnam`**|**`tmpnam`**|**`_wtmpnam`**| -|`_ttempnam`|**`_tempnam`**|**`_tempnam`**|**`_wtempnam`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_ttmpnam` | **`tmpnam`** | **`tmpnam`** | **`_wtmpnam`** | +| `_ttempnam` | **`_tempnam`** | **`_tempnam`** | **`_wtempnam`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_tempnam`**|\| -|**`_wtempnam`**, **`_wtmpnam`**|\ or \| -|**`tmpnam`**|\| +| Routine | Required header | +|---|---| +| **`_tempnam`** | \ | +| **`_wtempnam`**, **`_wtmpnam`** | \ or \ | +| **`tmpnam`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/terminate-crt.md b/docs/c-runtime-library/reference/terminate-crt.md index 40b549f5bd4..e1cadfd2f28 100644 --- a/docs/c-runtime-library/reference/terminate-crt.md +++ b/docs/c-runtime-library/reference/terminate-crt.md @@ -24,7 +24,7 @@ void terminate( void ); The **`terminate`** function is used with C++ exception handling and is called in the following cases: -- A matching catch handler cannot be found for a thrown C++ exception. +- A matching catch handler can't be found for a thrown C++ exception. - An exception is thrown by a destructor function during stack unwind. @@ -36,9 +36,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`terminate`**|\| +| Routine | Required header | +|---|---| +| **`terminate`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/tgamma-tgammaf-tgammal.md b/docs/c-runtime-library/reference/tgamma-tgammaf-tgammal.md index c5770a03061..00b18b0c232 100644 --- a/docs/c-runtime-library/reference/tgamma-tgammaf-tgammal.md +++ b/docs/c-runtime-library/reference/tgamma-tgammaf-tgammal.md @@ -51,17 +51,17 @@ If successful, returns the gamma of *`x`*. A range error may occur if the magnitude of *`x`* is too large or too small for the data type. A domain error or range error may occur if *`x`* <= 0. -|Issue|Return| -|-----------|------------| -|x = ±0|±INFINITY| -|x = negative integer|NaN| -|x = -INFINITY|NaN| -|x = +INFINITY|+INFINITY| -|x = NaN|NaN| -|domain error|NaN| -|pole error|±HUGE_VAL, ±HUGE_VALF, or ±HUGE_VALL| -|overflow range error|±HUGE_VAL, ±HUGE_VALF, or ±HUGE_VALL| -|underflow range error|the correct value, after rounding.| +| Issue | Return | +|---|---| +| *`x`* = ±0 | ±INFINITY | +| *`x`* = negative integer | NaN | +| *`x`* = -INFINITY | NaN | +| *`x`* = +INFINITY | +INFINITY | +| *`x`* = NaN | NaN | +| domain error | NaN | +| pole error | ±`HUGE_VAL`, ±`HUGE_VALF`, or ±`HUGE_VALL` | +| overflow range error | ±`HUGE_VAL`, ±`HUGE_VALF`, or ±`HUGE_VALL` | +| underflow range error | the correct value, after rounding. | Errors are reported as specified in [`_matherr`](matherr.md). @@ -77,10 +77,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`tgamma`**, **`tgammaf`**, **`tgammal`**|\|\| -|**`tgamma`** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`tgamma`**, **`tgammaf`**, **`tgammal`** | \ | \ | +| **`tgamma`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/time-time32-time64.md b/docs/c-runtime-library/reference/time-time32-time64.md index bf1dad18129..2d90eaae992 100644 --- a/docs/c-runtime-library/reference/time-time32-time64.md +++ b/docs/c-runtime-library/reference/time-time32-time64.md @@ -29,19 +29,19 @@ Pointer to the storage location for time. ## Return value -Returns the time as seconds elapsed since midnight, January 1, 1970, or -1 in the case of an error. +Returns the time as seconds elapsed since midnight, January 1, 1970, or -1 if there's an error. ## Remarks -The **`time`** function returns the number of seconds elapsed since midnight (00:00:00), January 1, 1970, Coordinated Universal Time (UTC), according to the system clock. The return value is stored in the location given by *`destTime`*. This parameter may be `NULL`, in which case the return value is not stored. +The **`time`** function returns the number of seconds elapsed since midnight (00:00:00), January 1, 1970, Coordinated Universal Time (UTC), according to the system clock. The return value is stored in the location given by *`destTime`*. This parameter may be `NULL`, in which case the return value isn't stored. -**`time`** is a wrapper for **`_time64`** and **`time_t`** is, by default, equivalent to **`__time64_t`**. If you need to force the compiler to interpret **`time_t`** as the old 32-bit **`time_t`**, you can define `_USE_32BIT_TIME_T`. This is not recommended because your application may fail after January 18, 2038; the use of this macro is not allowed on 64-bit platforms. +**`time`** is a wrapper for **`_time64`** and **`time_t`** is, by default, equivalent to **`__time64_t`**. If you need to force the compiler to interpret **`time_t`** as the old 32-bit **`time_t`**, you can define `_USE_32BIT_TIME_T`. We don't recommend `_USE_32BIT_TIME_T`, because your application may fail after January 18, 2038; the use of this macro isn't allowed on 64-bit platforms. ## Requirements -|Routine|Required C header|Required C++ header| -|-------|------|---------------------| -|**`time`**, **`_time32`**, **`_time64`**|``|`` or ``| +| Routine | Required C header | Required C++ header | +|---|---|---| +| **`time`**, **`_time32`**, **`_time64`** | `` | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/timespec-get-timespec32-get-timespec64-get1.md b/docs/c-runtime-library/reference/timespec-get-timespec32-get-timespec64-get1.md index 23132cba515..8405d05b0b2 100644 --- a/docs/c-runtime-library/reference/timespec-get-timespec32-get-timespec64-get1.md +++ b/docs/c-runtime-library/reference/timespec-get-timespec32-get-timespec64-get1.md @@ -49,7 +49,7 @@ The **`timespec_get`** functions set the current time in the struct pointed to b **Microsoft Specific** -These functions support only `TIME_UTC` as the *`base`* value. This sets the *`time_spec`* value to the number of seconds and nanoseconds since the epoch start, Midnight, January 1, 1970, Coordinated Universal Time (UTC). In a **`struct`** `_timespec32`, `tv_sec` is a `__time32_t` value. In a **`struct`** `_timespec64`, `tv_sec` is a `__time64_t` value. In a **`struct`** `timespec`, `tv_sec` is a `time_t` type, which is 32 bits or 64 bits in length depending on whether the preprocessor macro _USE_32BIT_TIME_T is defined. The **`timespec_get`** function is an inline function that calls **`_timespec32_get`** if _USE_32BIT_TIME_T is defined; otherwise it calls **`_timespec64_get`**. +These functions support only `TIME_UTC` as the *`base`* value. `TIME_UTC` sets the *`time_spec`* value to the number of seconds and nanoseconds since the epoch start, Midnight, January 1, 1970, Coordinated Universal Time (UTC). In a `_timespec32`, `tv_sec` is a `__time32_t` value. In a `_timespec64`, `tv_sec` is a `__time64_t` value. In a `timespec`, `tv_sec` is a `time_t` type, which is 32 bits or 64 bits in length depending on whether the preprocessor macro _USE_32BIT_TIME_T is defined. The **`timespec_get`** function is an inline function that calls **`_timespec32_get`** if `_USE_32BIT_TIME_T` is defined; otherwise it calls **`_timespec64_get`**. **End Microsoft Specific** @@ -57,9 +57,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`timespec_get`**, **`_timespec32_get`**, **`_timespec64_get`**|C: \, C++: \ or \| +| Routine | Required header | +|---|---| +| **`timespec_get`**, **`_timespec32_get`**, **`_timespec64_get`** | C: \, C++: \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/tmpfile-s.md b/docs/c-runtime-library/reference/tmpfile-s.md index 0c282c78bf3..c46b2536d2b 100644 --- a/docs/c-runtime-library/reference/tmpfile-s.md +++ b/docs/c-runtime-library/reference/tmpfile-s.md @@ -12,7 +12,7 @@ ms.assetid: 50879c69-215e-425a-a2a3-8b5467121eae --- # `tmpfile_s` -Creates a temporary file. It is a version of [`tmpfile`](tmpfile.md) with security enhancements as described in [Security features in the CRT](../security-features-in-the-crt.md). +Creates a temporary file. It's a version of [`tmpfile`](tmpfile.md) with security enhancements as described in [Security features in the CRT](../security-features-in-the-crt.md). ## Syntax @@ -33,17 +33,17 @@ Returns 0 if successful, an error code on failure. ### Error conditions -|*`pFilePtr`*|Return value|Contents of *`pFilePtr`*| -|----------------|----------------------|---------------------------------| -|`NULL`|`EINVAL`|not changed| +| *`pFilePtr`* | Return value | Contents of *`pFilePtr`* | +|---|---|---| +| `NULL` | `EINVAL` | not changed | -If the above parameter validation error occurs, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `errno` is set to `EINVAL` and the return value is `EINVAL`. +If the above parameter validation error occurs, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `errno` is set to `EINVAL`, and the return value is `EINVAL`. ## Remarks -The **`tmpfile_s`** function creates a temporary file and puts a pointer to that stream in the *`pFilePtr`* argument. The temporary file is created in the root directory. To create a temporary file in a directory other than the root, use [`tmpnam_s`](tmpnam-s-wtmpnam-s.md) or [`tempnam`](tempnam-wtempnam-tmpnam-wtmpnam.md) in conjunction with [`fopen`](fopen-wfopen.md). +The **`tmpfile_s`** function creates a temporary file and puts a pointer to that stream in the *`pFilePtr`* argument. The temporary file is created in the root directory. To create a temporary file in a directory other than the root, use [`tmpnam_s`](tmpnam-s-wtmpnam-s.md) or [`tempnam`](tempnam-wtempnam-tmpnam-wtmpnam.md) with [`fopen`](fopen-wfopen.md). -If the file cannot be opened, **`tmpfile_s`** writes `NULL` to the *`pFilePtr`* parameter. This temporary file is automatically deleted when the file is closed, when the program terminates normally, or when `_rmtmp` is called, assuming that the current working directory does not change. The temporary file is opened in **w+b** (binary read/write) mode. +If the file can't be opened, **`tmpfile_s`** writes `NULL` to the *`pFilePtr`* parameter. This temporary file is automatically deleted when the file is closed, when the program terminates normally, or when `_rmtmp` is called, assuming that the current working directory doesn't change. The temporary file is opened in **w+b** (binary read/write) mode. Failure can occur if you attempt more than `TMP_MAX_S` (see STDIO.H) calls with **`tmpfile_s`**. @@ -51,9 +51,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`tmpfile_s`**|\| +| Routine | Required header | +|---|---| +| **`tmpfile_s`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/tmpfile.md b/docs/c-runtime-library/reference/tmpfile.md index 346a04da24f..0f1d2eaea0f 100644 --- a/docs/c-runtime-library/reference/tmpfile.md +++ b/docs/c-runtime-library/reference/tmpfile.md @@ -26,17 +26,17 @@ If successful, **`tmpfile`** returns a stream pointer. Otherwise, it returns a ` ## Remarks -The **`tmpfile`** function creates a temporary file and returns a pointer to that stream. The temporary file is created in the root directory. To create a temporary file in a directory other than the root, use [`tmpnam`](tempnam-wtempnam-tmpnam-wtmpnam.md) or [`tempnam`](tempnam-wtempnam-tmpnam-wtmpnam.md) in conjunction with [`fopen`](fopen-wfopen.md). +The **`tmpfile`** function creates a temporary file and returns a pointer to that stream. The temporary file is created in the root directory. To create a temporary file in a directory other than the root, use [`tmpnam`](tempnam-wtempnam-tmpnam-wtmpnam.md) or [`tempnam`](tempnam-wtempnam-tmpnam-wtmpnam.md) with [`fopen`](fopen-wfopen.md). -If the file cannot be opened, **`tmpfile`** returns a `NULL` pointer. This temporary file is automatically deleted when the file is closed, when the program terminates normally, or when `_rmtmp` is called, assuming that the current working directory does not change. The temporary file is opened in **w+b** (binary read/write) mode. +If the file can't be opened, **`tmpfile`** returns a `NULL` pointer. This temporary file is automatically deleted when the file is closed, when the program terminates normally, or when `_rmtmp` is called, assuming that the current working directory doesn't change. The temporary file is opened in **w+b** (binary read/write) mode. Failure can occur if you attempt more than TMP_MAX (see STDIO.H) calls with **`tmpfile`**. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`tmpfile`**|\| +| Routine | Required header | +|---|---| +| **`tmpfile`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/tmpnam-s-wtmpnam-s.md b/docs/c-runtime-library/reference/tmpnam-s-wtmpnam-s.md index 9ff704d40ff..23dcb2ac83f 100644 --- a/docs/c-runtime-library/reference/tmpnam-s-wtmpnam-s.md +++ b/docs/c-runtime-library/reference/tmpnam-s-wtmpnam-s.md @@ -70,16 +70,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_ttmpnam_s`|**`tmpnam_s`**|**`tmpnam_s`**|**`_wtmpnam_s`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_ttmpnam_s` | **`tmpnam_s`** | **`tmpnam_s`** | **`_wtmpnam_s`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`tmpnam_s`**|\| -|**`_wtmpnam_s`**|\ or \| +| Routine | Required header | +|---|---| +| **`tmpnam_s`** | \ | +| **`_wtmpnam_s`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/toascii-toascii.md b/docs/c-runtime-library/reference/toascii-toascii.md index 315dbdac25c..89431498f40 100644 --- a/docs/c-runtime-library/reference/toascii-toascii.md +++ b/docs/c-runtime-library/reference/toascii-toascii.md @@ -30,19 +30,19 @@ Character to convert. ## Return value -**`__toascii`** converts the value of *`c`* to the 7-bit ASCII range and returns the result. There is no return value reserved to indicate an error. +**`__toascii`** converts the value of *`c`* to the 7-bit ASCII range and returns the result. There's no return value reserved to indicate an error. ## Remarks The **`__toascii`** routine converts the given character to an ASCII character by truncating it to the low-order 7 bits. No other transformation is applied. -The **`__toascii`** routine is defined as a macro unless the preprocessor macro `_CTYPE_DISABLE_MACROS` is defined. For backward compatibility, **`toascii`** is defined as a macro only when [`__STDC__`](../../preprocessor/predefined-macros.md) is not defined or is defined as 0; otherwise it is undefined. +The **`__toascii`** routine is defined as a macro unless the preprocessor macro `_CTYPE_DISABLE_MACROS` is defined. For backward compatibility, **`toascii`** is defined as a macro only when [`__STDC__`](../../preprocessor/predefined-macros.md) isn't defined or is defined as 0; otherwise it's undefined. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`toascii`**, **`__toascii`**|C: \

C++: \ or \| +| Routine | Required header | +|---|---| +| **`toascii`**, **`__toascii`** | C: \

C++: \ or \ | The **`toascii`** macro is a POSIX extension, and **`__toascii`** is a Microsoft-specific implementation of the POSIX extension. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/tolower-tolower-towlower-tolower-l-towlower-l.md b/docs/c-runtime-library/reference/tolower-tolower-towlower-tolower-l-towlower-l.md index f744b523666..72e49ad97db 100644 --- a/docs/c-runtime-library/reference/tolower-tolower-towlower-tolower-l-towlower-l.md +++ b/docs/c-runtime-library/reference/tolower-tolower-towlower-tolower-l-towlower-l.md @@ -46,11 +46,11 @@ Locale to use for locale-specific translation. ## Return value -Each of these routines converts a copy of *`c`* to lower case if the conversion is possible, and returns the result. There is no return value reserved to indicate an error. +Each of these routines converts a copy of *`c`* to lower case if the conversion is possible, and returns the result. There's no return value reserved to indicate an error. ## Remarks -Each of these routines converts a given uppercase letter to a lowercase letter if it is possible and relevant. The case conversion of **`towlower`** is locale-specific. Only the characters relevant to the current locale are changed in case. The functions without the `_l` suffix use the currently set locale. The versions of these functions that have the `_l` suffix take the locale as a parameter and use that instead of the currently set locale. For more information, see [Locale](../locale.md). +Each of these routines converts a given uppercase letter to a lowercase letter if it's possible and relevant. The case conversion of **`towlower`** is locale-specific. Only the characters relevant to the current locale are changed in case. The functions without the `_l` suffix use the currently set locale. The versions of these functions that have the `_l` suffix take the locale as a parameter and use that instead of the currently set locale. For more information, see [Locale](../locale.md). In order for **`_tolower`** to give the expected results, [`__isascii`](isascii-isascii-iswascii.md) and [`isupper`](isupper-isupper-l-iswupper-iswupper-l.md) must both return nonzero. @@ -58,21 +58,21 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_totlower`|**`tolower`**|`_mbctolower`|**`towlower`**| -|`_totlower_l`|**`_tolower_l`**|`_mbctolower_l`|**`_towlower_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_totlower` | **`tolower`** | `_mbctolower` | **`towlower`** | +| `_totlower_l` | **`_tolower_l`** | `_mbctolower_l` | **`_towlower_l`** | > [!NOTE] > **`_tolower_l`** and **`_towlower_l`** have no locale dependence and are not meant to be called directly. They are provided for internal use by **`_totlower_l`**. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`tolower`**|\| -|**`_tolower`**|\| -|**`towlower`**|\ or \| +| Routine | Required header | +|---|---| +| **`tolower`** | \ | +| **`_tolower`** | \ | +| **`towlower`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/toupper-toupper-towupper-toupper-l-towupper-l.md b/docs/c-runtime-library/reference/toupper-toupper-towupper-toupper-l-towupper-l.md index 9401654e714..cb6ee9a09fa 100644 --- a/docs/c-runtime-library/reference/toupper-toupper-towupper-toupper-l-towupper-l.md +++ b/docs/c-runtime-library/reference/toupper-toupper-towupper-toupper-l-towupper-l.md @@ -48,9 +48,9 @@ Locale to use. Each of these routines converts a copy of *`c`*, if possible, and returns the result. -If *`c`* is a wide character for which `iswlower` is nonzero and there is a corresponding wide character for which [`iswupper`](isupper-isupper-l-iswupper-iswupper-l.md) is nonzero, **`towupper`** returns the corresponding wide character; otherwise, **`towupper`** returns *`c`* unchanged. +If *`c`* is a wide character for which `iswlower` is nonzero and there's a corresponding wide character for which [`iswupper`](isupper-isupper-l-iswupper-iswupper-l.md) is nonzero, **`towupper`** returns the corresponding wide character; otherwise, **`towupper`** returns *`c`* unchanged. -There is no return value reserved to indicate an error. +There's no return value reserved to indicate an error. In order for **`toupper`** to give the expected results, [`__isascii`](isascii-isascii-iswascii.md) and [`islower`](islower-iswlower-islower-l-iswlower-l.md) must both return nonzero. @@ -64,21 +64,21 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_totupper`|**`toupper`**|**`_mbctoupper`**|**`towupper`**| -|`_totupper_l`|**`_toupper_l`**|**`_mbctoupper_l`**|**`_towupper_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_totupper` | **`toupper`** | **`_mbctoupper`** | **`towupper`** | +| `_totupper_l` | **`_toupper_l`** | **`_mbctoupper_l`** | **`_towupper_l`** | > [!NOTE] > **`_toupper_l`** and **`_towupper_l`** have no locale dependence and are not meant to be called directly. They are provided for internal use by **`_totupper_l`**. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`toupper`**|\| -|**`_toupper`**|\| -|**`towupper`**|\ or \| +| Routine | Required header | +|---|---| +| **`toupper`** | \ | +| **`_toupper`** | \ | +| **`towupper`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/towctrans.md b/docs/c-runtime-library/reference/towctrans.md index 9ab1848012b..1b3094f66cd 100644 --- a/docs/c-runtime-library/reference/towctrans.md +++ b/docs/c-runtime-library/reference/towctrans.md @@ -41,9 +41,9 @@ The value of *`category`* must have been returned by an earlier successful call ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`towctrans`**|\| +| Routine | Required header | +|---|---| +| **`towctrans`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/trunc-truncf-truncl.md b/docs/c-runtime-library/reference/trunc-truncf-truncl.md index 67e2ef66d19..df5fa620e28 100644 --- a/docs/c-runtime-library/reference/trunc-truncf-truncl.md +++ b/docs/c-runtime-library/reference/trunc-truncf-truncl.md @@ -32,15 +32,15 @@ The value to truncate. ## Return value -If successful, returns an integer value of *`x`*, rounded towards zero. +If successful, the functions return an integer value of *`x`*, rounded towards zero. -Otherwise, may return one of the following: +Otherwise, the functions may return one of the following values: -|Issue|Return| -|-----------|------------| -|*`x`* = ±INFINITY|x| -|*`x`* = ±0|x| -|*`x`* = NaN|NaN| +| Issue | Return | +|---|---| +| *`x`* = ±INFINITY | x | +| *`x`* = ±0 | x | +| *`x`* = NaN | NaN | Errors are reported as specified in [`_matherr`](matherr.md). @@ -50,16 +50,16 @@ Because C++ allows overloading, you can call overloads of **`trunc`** that take If you use the \ `trunc()` macro, the type of the argument determines which version of the function is selected. See [Type-generic math](../tgmath.md) for details. -Because the largest floating-point values are exact integers, this function will not overflow on its own. However, you may cause the function to overflow by returning a value into an integer type. +Because the largest floating-point values are exact integers, this function won't overflow on its own. However, you may cause the function to overflow by returning a value into an integer type. You can also round down by implicitly converting from floating-point to integral; however, doing so is limited to the values that can be stored in the target type. ## Requirements -|Function|C header|C++ header| -|--------------|--------------|------------------| -|**`trunc`**, **`truncf`**, **`truncl`**|\|\| -|**`trunc`** macro | \ || +| Function | C header | C++ header | +|---|---|---| +| **`trunc`**, **`truncf`**, **`truncl`** | \ | \ | +| **`trunc`** macro | \ | | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/tzset.md b/docs/c-runtime-library/reference/tzset.md index a4e39ac0cea..09d4516b7b9 100644 --- a/docs/c-runtime-library/reference/tzset.md +++ b/docs/c-runtime-library/reference/tzset.md @@ -47,22 +47,22 @@ The **`_tzset`** function uses the current setting of the environment variable * > [!NOTE] > Take care in computing the sign of the time difference. Because the time difference is the offset from local time to UTC (rather than the reverse), its sign may be the opposite of what you might intuitively expect. For time zones ahead of UTC, the time difference is negative; for those behind UTC, the difference is positive. -For example, to set the **`TZ`** environment variable to correspond to the current time zone in Germany, enter the following on the command line: +For example, to set the **`TZ`** environment variable to correspond to the current time zone in Germany, enter this command on the command line: > **set TZ=GST-1GDT** -This command uses GST to indicate German standard time, assumes that UTC is one hour behind Germany (or in other words, that Germany is one hour ahead of UTC), and assumes that Germany observes daylight-saving time. +This command uses GST to indicate German standard time. It assumes that UTC is one hour behind Germany (or in other words, that Germany is one hour ahead of UTC). And, it assumes that Germany observes daylight-saving time. -If the **`TZ`** value is not set, **`_tzset`** attempts to use the time zone information specified by the operating system. In the Windows operating system, this information is specified in the Date/Time application in Control Panel. If **`_tzset`** cannot obtain this information, it uses PST8PDT by default, which signifies the Pacific Time zone. +If the **`TZ`** value isn't set, **`_tzset`** attempts to use the time zone information specified by the operating system. In the Windows operating system, this information is specified in the Date/Time application in Control Panel. If **`_tzset`** can't obtain this information, it uses PST8PDT by default, which signifies the Pacific Time zone. Based on the **`TZ`** environment variable value, the following values are assigned to the global variables `_daylight`, `_timezone`, and `_tzname` when **`_tzset`** is called: -|Global variable|Description|Default value| -|---------------------|-----------------|-------------------| -|`_daylight`|Nonzero value if a daylight-saving-time zone is specified in **`TZ`** setting; otherwise, 0.|1| -|`_timezone`|Difference in seconds between local time and UTC.|28800 (28800 seconds equals 8 hours)| -|`_tzname[0]`|String value of time-zone name from **`TZ`** environmental variable; empty if **`TZ`** has not been set.|PST| -|`_tzname[1]`|String value of daylight-saving-time zone; empty if daylight-saving-time zone is omitted from **`TZ`** environmental variable.|PDT| +| Global variable | Description | Default value | +|---|---|---| +| `_daylight` | Nonzero value if a daylight-saving-time zone is specified in **`TZ`** setting; otherwise, 0. | 1 | +| `_timezone` | Difference in seconds between local time and UTC. | 28800 (28,800 seconds equals 8 hours) | +| `_tzname[0]` | String value of time-zone name from **`TZ`** environmental variable; empty if **`TZ`** hasn't been set. | PST | +| `_tzname[1]` | String value of daylight-saving-time zone; empty if daylight-saving-time zone is omitted from **`TZ`** environmental variable. | PDT | The default values shown in the preceding table for `_daylight` and the `_tzname` array correspond to "PST8PDT." If the DST zone is omitted from the **`TZ`** environmental variable, the value of `_daylight` is 0 and the [`_ftime`](ftime-ftime32-ftime64.md), [`gmtime`](gmtime-gmtime32-gmtime64.md), and [`localtime`](localtime-localtime32-localtime64.md) functions return 0 for their DST flags. @@ -70,9 +70,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_tzset`**|\| +| Routine | Required header | +|---|---| +| **`_tzset`** | \ | The **`_tzset`** function is Microsoft-specific. For more information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/uncaught-exception.md b/docs/c-runtime-library/reference/uncaught-exception.md index 6ea7ac7bca1..e1d9b093c31 100644 --- a/docs/c-runtime-library/reference/uncaught-exception.md +++ b/docs/c-runtime-library/reference/uncaught-exception.md @@ -12,13 +12,12 @@ ms.assetid: 4d9b75c6-c9c7-4876-b761-ea9ab1925e96 --- # `__uncaught_exception` -Indicates whether one or more exceptions have been thrown, but have not yet been handled by the corresponding **`catch`** block of a [try-catch](../../cpp/try-throw-and-catch-statements-cpp.md) statement. +Indicates whether one or more exceptions have been thrown, but haven't yet been handled by the corresponding **`catch`** block of a [try-catch](../../cpp/try-throw-and-catch-statements-cpp.md) statement. ## Syntax ```cpp -bool __uncaught_exception( - ); +bool __uncaught_exception(); ``` ## Return value @@ -29,9 +28,9 @@ bool __uncaught_exception( ## Requirements -|Routine|Required header| -|-------------|---------------------| -|__uncaught_exception|eh.h| +| Routine | Required header | +|---|---| +| **`__uncaught_exception`** | `` | ## See also diff --git a/docs/c-runtime-library/reference/unexpected-crt.md b/docs/c-runtime-library/reference/unexpected-crt.md index 8e5a8f6b112..e06d13bd513 100644 --- a/docs/c-runtime-library/reference/unexpected-crt.md +++ b/docs/c-runtime-library/reference/unexpected-crt.md @@ -26,9 +26,9 @@ The **`unexpected`** routine isn't used with the current implementation of C++ e ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`unexpected`**|``| +| Routine | Required header | +|---|---| +| **`unexpected`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ungetc-nolock-ungetwc-nolock.md b/docs/c-runtime-library/reference/ungetc-nolock-ungetwc-nolock.md index 1002d96ae55..eb0f36c5976 100644 --- a/docs/c-runtime-library/reference/ungetc-nolock-ungetwc-nolock.md +++ b/docs/c-runtime-library/reference/ungetc-nolock-ungetwc-nolock.md @@ -37,28 +37,28 @@ Pointer to `FILE` structure. ## Return value -If successful, each of these functions returns the character argument *`c`*. If *`c`* cannot be pushed back or if no character has been read, the input stream is unchanged and **`_ungetc_nolock`** returns `EOF`; **`_ungetwc_nolock`** returns `WEOF`. If *`stream`* is `NULL`, `EOF` or `WEOF` is returned and `errno` is set to `EINVAL`. +If successful, each of these functions returns the character argument *`c`*. If *`c`* can't be pushed back or if no character has been read, the input stream is unchanged and **`_ungetc_nolock`** returns `EOF`; **`_ungetwc_nolock`** returns `WEOF`. If *`stream`* is `NULL`, `EOF` or `WEOF` is returned, and `errno` is set to `EINVAL`. For information on these and other error codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). ## Remarks -These functions are non-locking versions of `ungetc` and `ungetwc`. The versions with the `_nolock` suffix are identical except that they are not protected from interference by other threads. They may be faster since they do not incur the overhead of locking out other threads. Use these functions only in thread-safe contexts such as single-threaded applications or where the calling scope already handles thread isolation. +These functions are non-locking versions of `ungetc` and `ungetwc`. The versions with the `_nolock` suffix are identical except that they aren't protected from interference by other threads. They may be faster since they don't incur the overhead of locking out other threads. Use these functions only in thread-safe contexts such as single-threaded applications or where the calling scope already handles thread isolation. 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). ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_ungettc_nolock`|**`_ungetc_nolock`**|**`_ungetc_nolock`**|**`_ungetwc_nolock`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_ungettc_nolock` | **`_ungetc_nolock`** | **`_ungetc_nolock`** | **`_ungetwc_nolock`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ungetc_nolock`**|\| -|**`_ungetwc_nolock`**|\ or \| +| Routine | Required header | +|---|---| +| **`_ungetc_nolock`** | \ | +| **`_ungetwc_nolock`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/ungetc-ungetwc.md b/docs/c-runtime-library/reference/ungetc-ungetwc.md index 7e0ef9728e6..4df279f284e 100644 --- a/docs/c-runtime-library/reference/ungetc-ungetwc.md +++ b/docs/c-runtime-library/reference/ungetc-ungetwc.md @@ -37,7 +37,7 @@ Pointer to `FILE` structure. ## Return value -If successful, each of these functions returns the character argument *`c`*. If *`c`* cannot be pushed back or if no character has been read, the input stream is unchanged and **`ungetc`** returns `EOF`; **`ungetwc`** returns `WEOF`. If *`stream`* is `NULL`, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `EOF` or `WEOF` is returned and `errno` is set to `EINVAL`. +If successful, each of these functions returns the character argument *`c`*. If *`c`* can't be pushed back or if no character has been read, the input stream is unchanged and **`ungetc`** returns `EOF`; **`ungetwc`** returns `WEOF`. If *`stream`* is `NULL`, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `EOF` or `WEOF` is returned, and `errno` is set to `EINVAL`. For information on these and other error codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -47,7 +47,7 @@ The **`ungetc`** function pushes the character *`c`* back onto *`stream`* and cl Characters placed on the stream by **`ungetc`** may be erased if `fflush`, [`fseek`](fseek-fseeki64.md), `fsetpos`, or [`rewind`](rewind.md) is called before the character is read from the stream. The file-position indicator will have the value it had before the characters were pushed back. The external storage corresponding to the stream is unchanged. On a successful **`ungetc`** call against a text stream, the file-position indicator is unspecified until all the pushed-back characters are read or discarded. On each successful **`ungetc`** call against a binary stream, the file-position indicator is decremented; if its value was 0 before a call, the value is undefined after the call. -Results are unpredictable if **`ungetc`** is called twice without a read or file-positioning operation between the two calls. After a call to `fscanf`, a call to **`ungetc`** may fail unless another read operation (such as `getc`) has been performed. This is because `fscanf` itself calls **`ungetc`**. +Results are unpredictable if **`ungetc`** is called twice without a read or file-positioning operation between the two calls. After a call to `fscanf`, a call to **`ungetc`** may fail unless another read operation (such as `getc`) has been performed, because `fscanf` itself calls **`ungetc`**. **`ungetwc`** is a wide-character version of **`ungetc`**. However, on each successful **`ungetwc`** call against a text or binary stream, the value of the file-position indicator is unspecified until all pushed-back characters are read or discarded. @@ -57,18 +57,18 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_ungettc`|**`ungetc`**|**`ungetc`**|**`ungetwc`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_ungettc` | **`ungetc`** | **`ungetc`** | **`ungetwc`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`ungetc`**|\| -|**`ungetwc`**|\ or \| +| Routine | Required header | +|---|---| +| **`ungetc`** | \ | +| **`ungetwc`** | \ or \ | -The console is not supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). +The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). ## Example diff --git a/docs/c-runtime-library/reference/ungetch-ungetwch-ungetch-nolock-ungetwch-nolock.md b/docs/c-runtime-library/reference/ungetch-ungetwch-ungetch-nolock-ungetwch-nolock.md index f2ba106b2b4..73f94bd18ba 100644 --- a/docs/c-runtime-library/reference/ungetch-ungetwch-ungetch-nolock-ungetwch-nolock.md +++ b/docs/c-runtime-library/reference/ungetch-ungetwch-ungetch-nolock-ungetwch-nolock.md @@ -41,29 +41,29 @@ Character to be pushed. ## Return value -Both functions return the character *`c`* if successful. If there is an error, **`_ungetch`** returns a value of `EOF` and **`_ungetwch`** returns `WEOF`. +Both functions return the character *`c`* if successful. If there's an error, **`_ungetch`** returns a value of `EOF` and **`_ungetwch`** returns `WEOF`. ## Remarks -These functions push the character *`c`* back to the console, causing *`c`* to be the next character read by `_getch` or `_getche` (or `_getwch` or `_getwche`). **`_ungetch`** and **`_ungetwch`** fail if they are called more than once before the next read. The *`c`* argument may not be `EOF` (or `WEOF`). +These functions push the character *`c`* back to the console, causing *`c`* to be the next character read by `_getch` or `_getche` (or `_getwch` or `_getwche`). **`_ungetch`** and **`_ungetwch`** fail if they're called more than once before the next read. The *`c`* argument may not be `EOF` (or `WEOF`). -The versions with the `_nolock` suffix are identical except that they are not protected from interference by other threads. They may be faster since they do not incur the overhead of locking out other threads. Use these functions only in thread-safe contexts such as single-threaded applications or where the calling scope already handles thread isolation. +The versions with the `_nolock` suffix are identical except that they aren't protected from interference by other threads. They may be faster since they don't incur the overhead of locking out other threads. Use these functions only in thread-safe contexts such as single-threaded applications or where the calling scope already handles thread isolation. 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). ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_ungettch`|**`_ungetch`**|**`_ungetch`**|**`_ungetwch`**| -|`_ungettch_nolock`|**`_ungetch_nolock`**|**`_ungetch_nolock`**|**`_ungetwch_nolock`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_ungettch` | **`_ungetch`** | **`_ungetch`** | **`_ungetwch`** | +| `_ungettch_nolock` | **`_ungetch_nolock`** | **`_ungetch_nolock`** | **`_ungetwch_nolock`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_ungetch`**, **`_ungetch_nolock`**|\| -|**`_ungetwch`**, **`_ungetwch_nolock`**|\ or \| +| Routine | Required header | +|---|---| +| **`_ungetch`**, **`_ungetch_nolock`** | \ | +| **`_ungetwch`**, **`_ungetwch_nolock`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/unlink-wunlink.md b/docs/c-runtime-library/reference/unlink-wunlink.md index 2c9ae7688db..70627006642 100644 --- a/docs/c-runtime-library/reference/unlink-wunlink.md +++ b/docs/c-runtime-library/reference/unlink-wunlink.md @@ -44,16 +44,16 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tunlink`|**`_unlink`**|**`_unlink`**|**`_wunlink`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tunlink` | **`_unlink`** | **`_unlink`** | **`_wunlink`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_unlink`**|\ and \| -|**`_wunlink`**|\ or \| +| Routine | Required header | +|---|---| +| **`_unlink`** | \ and \ | +| **`_wunlink`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/unlock-file.md b/docs/c-runtime-library/reference/unlock-file.md index 92550accb30..94a6b88234f 100644 --- a/docs/c-runtime-library/reference/unlock-file.md +++ b/docs/c-runtime-library/reference/unlock-file.md @@ -29,15 +29,15 @@ File handle. ## Remarks -The **`_unlock_file`** function unlocks the file specified by *`file`*. Unlocking a file allows access to the file by other processes. This function should not be called unless `_lock_file` was previously called on the *`file`* pointer. Calling **`_unlock_file`** on a file that isn't locked may result in a deadlock. For an example, see [`_lock_file`](lock-file.md). +The **`_unlock_file`** function unlocks the file specified by *`file`*. Unlocking a file allows access to the file by other processes. This function shouldn't be called unless `_lock_file` was previously called on the *`file`* pointer. Calling **`_unlock_file`** on a file that isn't locked may result in a deadlock. For an example, see [`_lock_file`](lock-file.md). 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). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_unlock_file`**|\| +| Routine | Required header | +|---|---| +| **`_unlock_file`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/utime-utime32-utime64-wutime-wutime32-wutime64.md b/docs/c-runtime-library/reference/utime-utime32-utime64-wutime-wutime32-wutime64.md index 77f590c0247..9894acced7a 100644 --- a/docs/c-runtime-library/reference/utime-utime32-utime64-wutime-wutime32-wutime64.md +++ b/docs/c-runtime-library/reference/utime-utime32-utime64-wutime-wutime32-wutime64.md @@ -55,8 +55,8 @@ Pointer to stored time values. Each of these functions returns 0 if the file-modification time was changed. A return value of -1 indicates an error. If an invalid parameter is passed, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions return -1, and `errno` is set to one of the following values: -|errno value|Condition| -|-|-| +| `errno` value | Condition | +|---|---| | `EACCES` | Path specifies directory or read-only file | | `EINVAL` | Invalid *`times`* argument | | `EMFILE` | Too many open files (the file must be opened to change its modification time) | @@ -73,7 +73,7 @@ The **`_utime`** function sets the modification time for the file specified by * The **`_utimbuf`** structure stores file access and modification times used by **`_utime`** to change file-modification dates. The structure has the following fields, which are both of type `time_t`: | Field | Description | -|-------|---| +|---|---| | **`actime`** | Time of file access | | **`modtime`** | Time of file modification | @@ -87,19 +87,19 @@ By default, this function's global state is scoped to the application. To change ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_tutime`|**`_utime`**|**`_utime`**|**`_wutime`**| -|`_tutime32`|**`_utime32`**|**`_utime32`**|**`_wutime32`**| -|`_tutime64`|**`_utime64`**|**`_utime64`**|**`_wutime64`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tutime` | **`_utime`** | **`_utime`** | **`_wutime`** | +| `_tutime32` | **`_utime32`** | **`_utime32`** | **`_wutime32`** | +| `_tutime64` | **`_utime64`** | **`_utime64`** | **`_wutime64`** | ## Requirements -|Routine|Required headers|Optional headers| -|-------------|----------------------|----------------------| -|**`_utime`**, **`_utime32`**, **`_utime64`**|\|\| -|**`_utime64`**|\|\| -|**`_wutime`**|\ or \|\| +| Routine | Required headers | Optional headers | +|---|---|---| +| **`_utime`**, **`_utime32`**, **`_utime64`** | \ | \ | +| **`_utime64`** | \ | \ | +| **`_wutime`** | \ or \ | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/va-arg-va-copy-va-end-va-start.md b/docs/c-runtime-library/reference/va-arg-va-copy-va-end-va-start.md index f8df1c1d1a3..95bc6590d04 100644 --- a/docs/c-runtime-library/reference/va-arg-va-copy-va-end-va-start.md +++ b/docs/c-runtime-library/reference/va-arg-va-copy-va-end-va-start.md @@ -56,7 +56,7 @@ Parameter that precedes the first optional argument. ## Return value -**`va_arg`** returns the current argument. **`va_copy`**, **`va_start`** and **`va_end`** do not return values. +**`va_arg`** returns the current argument. **`va_copy`**, **`va_start`** and **`va_end`** don't return values. ## Remarks @@ -77,7 +77,7 @@ The C standard macros, defined in `STDARG.H`, are used as follows: > [!NOTE] > The macros in VARARGS.H are deprecated and are retained only for backwards compatibility with code that was written before the ANSI C89 standard. In all other cases, use the macros in STDARGS.H. -When they are compiled by using [`/clr` (Common Language Runtime Compilation)](../../build/reference/clr-common-language-runtime-compilation.md), programs that use these macros may generate unexpected results because of differences between native and common language runtime (CLR) type systems. Consider this program: +When they're compiled by using [`/clr` (Common Language Runtime Compilation)](../../build/reference/clr-common-language-runtime-compilation.md), programs that use these macros may generate unexpected results because of differences between native and common language runtime (CLR) type systems. Consider this program: ```C #include diff --git a/docs/c-runtime-library/reference/vcprintf-p-vcprintf-p-l-vcwprintf-p-vcwprintf-p-l.md b/docs/c-runtime-library/reference/vcprintf-p-vcprintf-p-l-vcwprintf-p-vcwprintf-p-l.md index 1c5970d4dbf..9820f20c845 100644 --- a/docs/c-runtime-library/reference/vcprintf-p-vcprintf-p-l-vcwprintf-p-vcwprintf-p-l.md +++ b/docs/c-runtime-library/reference/vcprintf-p-vcprintf-p-l-vcwprintf-p-vcwprintf-p-l.md @@ -54,7 +54,7 @@ For more information, see [Format specification syntax: `printf` and `wprintf` f ## Return value -The number of characters that are written, or a negative value if an output error occurs. If *`format`* is a null pointer, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `errno` is set to `EINVAL` and -1 is returned. +The number of characters that are written, or a negative value if an output error occurs. If *`format`* is a null pointer, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `errno` is set to `EINVAL`, and -1 is returned. ## Remarks @@ -64,7 +64,7 @@ The versions of these functions that have the `_l` suffix are identical except t Each *`argument`* (if any) is converted and is output according to the corresponding format specification in *`format`*. The format specification supports positional parameters so that you can specify the order in which the arguments are used in the format string. For more information, see [printf_p Positional Parameters](../printf-p-positional-parameters.md). -These functions do not translate line-feed characters into carriage return-line feed (CR-LF) combinations when they are output. +These functions don't translate line-feed characters on output into carriage return-line feed (CR-LF) combinations. > [!IMPORTANT] > Ensure that *`format`* is not a user-defined string. For more information, see [Avoiding buffer overruns](/windows/win32/SecBP/avoiding-buffer-overruns). @@ -73,17 +73,17 @@ These functions validate the input pointer and the format string. If *`format`* ### Generic-text routine mappings -|Tchar.h routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_vtcprintf_p`|**`_vcprintf_p`**|**`_vcprintf_p`**|**`_vcwprintf_p`**| -|`_vtcprintf_p_l`|**`_vcprintf_p_l`**|**`_vcprintf_p_l`**|**`_vcwprintf_p_l`**| +| Tchar.h routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vtcprintf_p` | **`_vcprintf_p`** | **`_vcprintf_p`** | **`_vcwprintf_p`** | +| `_vtcprintf_p_l` | **`_vcprintf_p_l`** | **`_vcprintf_p_l`** | **`_vcwprintf_p_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_vcprintf_p`**, **`_vcprintf_p_l`**|\ and \| -|**`_vcwprintf_p`**, **`_vcwprintf_p_l`**|\ and \| +| Routine | Required header | +|---|---| +| **`_vcprintf_p`**, **`_vcprintf_p_l`** | \ and \ | +| **`_vcwprintf_p`**, **`_vcwprintf_p_l`** | \ and \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/vcprintf-s-vcprintf-s-l-vcwprintf-s-vcwprintf-s-l.md b/docs/c-runtime-library/reference/vcprintf-s-vcprintf-s-l-vcwprintf-s-vcwprintf-s-l.md index 4e858702274..4cb308d94f1 100644 --- a/docs/c-runtime-library/reference/vcprintf-s-vcprintf-s-l-vcwprintf-s-vcwprintf-s-l.md +++ b/docs/c-runtime-library/reference/vcprintf-s-vcprintf-s-l-vcwprintf-s-vcwprintf-s-l.md @@ -56,7 +56,7 @@ For more information, see [Format specification syntax: `printf` and `wprintf` f The number of characters written, or a negative value if an output error occurs. -Like the less secure versions of these functions, if *`format`* is a null pointer, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). Additionally, unlike the less secure versions of these functions, if *`format`* does not specify a valid format, an invalid parameter exception is generated. If execution is allowed to continue, these functions return an error code and set `errno` to that error code. The default error code is `EINVAL` if a more specific value does not apply. +Like the less secure versions of these functions, if *`format`* is a null pointer, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). Additionally, unlike the less secure versions of these functions, if *`format`* doesn't specify a valid format, an invalid parameter exception is generated. If execution is allowed to continue, these functions return an error code and set `errno` to that error code. The default error code is `EINVAL` if a more specific value doesn't apply. ## Remarks @@ -69,17 +69,17 @@ The versions of these functions that have the `_l` suffix are identical except t ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vtcprintf_s`|**`_vcprintf_s`**|**`_vcprintf_s`**|**`_vcwprintf_s`**| -|`_vtcprintf_s_l`|**`_vcprintf_s_l`**|**`_vcprintf_s_l`**|**`_vcwprintf_s_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vtcprintf_s` | **`_vcprintf_s`** | **`_vcprintf_s`** | **`_vcwprintf_s`** | +| `_vtcprintf_s_l` | **`_vcprintf_s_l`** | **`_vcprintf_s_l`** | **`_vcwprintf_s_l`** | ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`_vcprintf_s`**, **`_vcprintf_s_l`**|\ and \|\*| -|**`_vcwprintf_s`**, **`_vcwprintf_s_l`**|\ or \, and \|\*| +| Routine | Required header | Optional headers | +|---|---|---| +| **`_vcprintf_s`**, **`_vcprintf_s_l`** | \ and \ | \* | +| **`_vcwprintf_s`**, **`_vcwprintf_s_l`** | \ or \, and \ | \* | \* Required for UNIX V compatibility. diff --git a/docs/c-runtime-library/reference/vcprintf-vcprintf-l-vcwprintf-vcwprintf-l.md b/docs/c-runtime-library/reference/vcprintf-vcprintf-l-vcwprintf-vcwprintf-l.md index 417e8cf72db..7d9c4d1807f 100644 --- a/docs/c-runtime-library/reference/vcprintf-vcprintf-l-vcwprintf-vcwprintf-l.md +++ b/docs/c-runtime-library/reference/vcprintf-vcprintf-l-vcwprintf-vcwprintf-l.md @@ -54,7 +54,7 @@ For more information, see [Format specification syntax](../format-specification- ## Return value -The number of characters written, or a negative value if an output error occurs. If *`format`* is a null pointer, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `errno` is set to `EINVAL` and -1 is returned. +The number of characters written, or a negative value if an output error occurs. If *`format`* is a null pointer, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `errno` is set to `EINVAL`, and -1 is returned. ## Remarks @@ -69,17 +69,17 @@ The versions of these functions with the `_l` suffix are identical except that t ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vtcprintf`|**`_vcprintf`**|**`_vcprintf`**|**`_vcwprintf`**| -|`_vtcprintf_l`|**`_vcprintf_l`**|**`_vcprintf_l`**|**`_vcwprintf_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vtcprintf` | **`_vcprintf`** | **`_vcprintf`** | **`_vcwprintf`** | +| `_vtcprintf_l` | **`_vcprintf_l`** | **`_vcprintf_l`** | **`_vcwprintf_l`** | ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`_vcprintf`**, **`_vcprintf_l`**|\ and \|\*| -|**`_vcwprintf`**, **`_vcwprintf_l`**|\ or \, and \|\*| +| Routine | Required header | Optional headers | +|---|---|---| +| **`_vcprintf`**, **`_vcprintf_l`** | \ and \ | \* | +| **`_vcwprintf`**, **`_vcwprintf_l`** | \ or \, and \ | \* | \* Required for UNIX V compatibility. diff --git a/docs/c-runtime-library/reference/vfprintf-p-vfprintf-p-l-vfwprintf-p-vfwprintf-p-l.md b/docs/c-runtime-library/reference/vfprintf-p-vfprintf-p-l-vfwprintf-p-vfwprintf-p-l.md index 2d44a5aad95..c7236e7ba87 100644 --- a/docs/c-runtime-library/reference/vfprintf-p-vfprintf-p-l-vfwprintf-p-vfwprintf-p-l.md +++ b/docs/c-runtime-library/reference/vfprintf-p-vfprintf-p-l-vfwprintf-p-vfwprintf-p-l.md @@ -76,17 +76,17 @@ If either *`stream`* or *`format`* is a null pointer, or if the format string co ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vftprintf_p`|**`_vfprintf_p`**|**`_vfprintf_p`**|**`_vfwprintf_p`**| -|`_vftprintf_p_l`|**`_vfprintf_p_l`**|**`_vfprintf_p_l`**|**`_vfwprintf_p_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vftprintf_p` | **`_vfprintf_p`** | **`_vfprintf_p`** | **`_vfwprintf_p`** | +| `_vftprintf_p_l` | **`_vfprintf_p_l`** | **`_vfprintf_p_l`** | **`_vfwprintf_p_l`** | ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`_vfprintf_p`**, **`_vfprintf_p_l`**|\ and \|\*| -|**`_vfwprintf_p`**, **`_vfwprintf_p_l`**|\ or \, and \|\*| +| Routine | Required header | Optional headers | +|---|---|---| +| **`_vfprintf_p`**, **`_vfprintf_p_l`** | \ and \ | \* | +| **`_vfwprintf_p`**, **`_vfwprintf_p_l`** | \ or \, and \ | \* | \* Required for UNIX V compatibility. diff --git a/docs/c-runtime-library/reference/vfprintf-s-vfprintf-s-l-vfwprintf-s-vfwprintf-s-l.md b/docs/c-runtime-library/reference/vfprintf-s-vfprintf-s-l-vfwprintf-s-vfwprintf-s-l.md index 26536bc3697..02016e49212 100644 --- a/docs/c-runtime-library/reference/vfprintf-s-vfprintf-s-l-vfwprintf-s-vfwprintf-s-l.md +++ b/docs/c-runtime-library/reference/vfprintf-s-vfprintf-s-l-vfwprintf-s-vfwprintf-s-l.md @@ -11,7 +11,7 @@ helpviewer_keywords: ["vfprintf_s_l function", "vfwprintf_s_l function", "vfwpri --- # `vfprintf_s`, `_vfprintf_s_l`, `vfwprintf_s`, `_vfwprintf_s_l` -Write formatted output using a pointer to a list of arguments. These are versions of [`vfprintf`, `_vfprintf_l`, `vfwprintf`, `_vfwprintf_l`](vfprintf-vfprintf-l-vfwprintf-vfwprintf-l.md) with security enhancements as described in [Security features in the CRT](../security-features-in-the-crt.md). +Write formatted output using a pointer to a list of arguments. These functions are versions of [`vfprintf`, `_vfprintf_l`, `vfwprintf`, `_vfwprintf_l`](vfprintf-vfprintf-l-vfwprintf-vfwprintf-l.md) with security enhancements as described in [Security features in the CRT](../security-features-in-the-crt.md). ## Syntax @@ -78,17 +78,17 @@ The versions of these functions with the `_l` suffix are identical except that t ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vftprintf_s`|**`vfprintf_s`**|**`vfprintf_s`**|**`vfwprintf_s`**| -|`_vftprintf_s_l`|**`_vfprintf_s_l`**|**`_vfprintf_s_l`**|**`_vfwprintf_s_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vftprintf_s` | **`vfprintf_s`** | **`vfprintf_s`** | **`vfwprintf_s`** | +| `_vftprintf_s_l` | **`_vfprintf_s_l`** | **`_vfprintf_s_l`** | **`_vfwprintf_s_l`** | ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`vfprintf_s`**, **`_vfprintf_s_l`**|\ and \|\*| -|**`vfwprintf_s`**, **`_vfwprintf_s_l`**|\ or \, and \|\*| +| Routine | Required header | Optional headers | +|---|---|---| +| **`vfprintf_s`**, **`_vfprintf_s_l`** | \ and \ | \* | +| **`vfwprintf_s`**, **`_vfwprintf_s_l`** | \ or \, and \ | \* | \* Required for UNIX V compatibility. diff --git a/docs/c-runtime-library/reference/vfprintf-vfprintf-l-vfwprintf-vfwprintf-l.md b/docs/c-runtime-library/reference/vfprintf-vfprintf-l-vfwprintf-vfwprintf-l.md index a600b41703a..74b46fb1241 100644 --- a/docs/c-runtime-library/reference/vfprintf-vfprintf-l-vfwprintf-vfwprintf-l.md +++ b/docs/c-runtime-library/reference/vfprintf-vfprintf-l-vfwprintf-vfwprintf-l.md @@ -76,17 +76,17 @@ The versions of these functions with the `_l` suffix are identical except that t ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vftprintf`|**`vfprintf`**|**`vfprintf`**|**`vfwprintf`**| -|`_vftprintf_l`|**`_vfprintf_l`**|**`_vfprintf_l`**|**`_vfwprintf_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vftprintf` | **`vfprintf`** | **`vfprintf`** | **`vfwprintf`** | +| `_vftprintf_l` | **`_vfprintf_l`** | **`_vfprintf_l`** | **`_vfwprintf_l`** | ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`vfprintf`**, **`_vfprintf_l`**|\ and \|\*| -|**`vfwprintf`**, **`_vfwprintf_l`**|\ or \, and \|\*| +| Routine | Required header | Optional headers | +|---|---|---| +| **`vfprintf`**, **`_vfprintf_l`** | \ and \ | \* | +| **`vfwprintf`**, **`_vfwprintf_l`** | \ or \, and \ | \* | \* Required for UNIX V compatibility. diff --git a/docs/c-runtime-library/reference/vfscanf-s-vfwscanf-s.md b/docs/c-runtime-library/reference/vfscanf-s-vfwscanf-s.md index 4f5ec4ae6b5..86e6bca7b32 100644 --- a/docs/c-runtime-library/reference/vfscanf-s-vfwscanf-s.md +++ b/docs/c-runtime-library/reference/vfscanf-s-vfwscanf-s.md @@ -41,7 +41,7 @@ Variable argument list. ## Return value -Each of these functions returns the number of fields that are successfully converted and assigned; the return value does not include fields that were read but not assigned. A return value of 0 indicates that no fields were assigned. If an error occurs, or if the end of the file stream is reached before the first conversion, the return value is `EOF` for **`vfscanf_s`** and **`vfwscanf_s`**. +Each of these functions returns the number of fields that are successfully converted and assigned. The return value doesn't include fields that were read but not assigned. A return value of 0 indicates that no fields were assigned. If an error occurs, or if the end of the file stream is reached before the first conversion, the return value is `EOF` for **`vfscanf_s`** and **`vfwscanf_s`**. These functions validate their parameters. If *`stream`* is an invalid file pointer, or *`format`* is a null pointer, these functions invoke the invalid parameter handler, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions return `EOF` and set `errno` to `EINVAL`. @@ -49,23 +49,23 @@ These functions validate their parameters. If *`stream`* is an invalid file poin The **`vfscanf_s`** function reads data from the current position of *`stream`* into the locations that are given by the *`arglist`* argument list (if any). Each argument in the list must be a pointer to a variable of a type that corresponds to a type specifier in *`format`*. *`format`* controls the interpretation of the input fields and has the same form and function as the *`format`* argument for `scanf_s`; see [Format specification fields: `scanf` and `wscanf` functions](../format-specification-fields-scanf-and-wscanf-functions.md) for a description of *`format`*. **`vfwscanf_s`** is a wide-character version of **`vfscanf_s`**; the format argument to **`vfwscanf_s`** is a wide-character string. These functions behave identically if the stream is opened in ANSI mode. **`vfscanf_s`** doesn't currently support input from a UNICODE stream. -The main difference between the more secure functions (that have the **`_s`** suffix) and the other versions is that the more secure functions require the size in characters of each **c**, **C**, **s**, **S**, and **[** type field to be passed as an argument immediately following the variable. For more information, see [`scanf_s`, `_scanf_s_l`, `wscanf_s`, `_wscanf_s_l`](scanf-s-scanf-s-l-wscanf-s-wscanf-s-l.md) and [scanf Width Specification](../scanf-width-specification.md). +The main difference between the more secure functions (that have the **`_s`** suffix) and the other versions is that the more secure functions require the size in characters of each **`c`**, **`C`**, **`s`**, **`S`**, and **`[`** type field to be passed as an argument immediately following the variable. For more information, see [`scanf_s`, `_scanf_s_l`, `wscanf_s`, `_wscanf_s_l`](scanf-s-scanf-s-l-wscanf-s-wscanf-s-l.md) and [`scanf` width specification](../scanf-width-specification.md). > [!NOTE] > The size parameter is of type **`unsigned`**, not `size_t`. ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vftscanf_s`|**`vfscanf_s`**|**`vfscanf_s`**|**`vfwscanf_s`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vftscanf_s` | **`vfscanf_s`** | **`vfscanf_s`** | **`vfwscanf_s`** | ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`vfscanf_s`**|\| -|**`vfwscanf_s`**|\ or \| +| Function | Required header | +|---|---| +| **`vfscanf_s`** | \ | +| **`vfwscanf_s`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/vfscanf-vfwscanf.md b/docs/c-runtime-library/reference/vfscanf-vfwscanf.md index 959b9b93f1e..00213ccfeec 100644 --- a/docs/c-runtime-library/reference/vfscanf-vfwscanf.md +++ b/docs/c-runtime-library/reference/vfscanf-vfwscanf.md @@ -41,7 +41,7 @@ Variable argument list. ## Return value -Each of these functions returns the number of fields that are successfully converted and assigned; the return value does not include fields that are read but not assigned. A return value of 0 indicates that no fields were assigned. If an error occurs, or if the end of the file stream is reached before the first conversion, the return value is `EOF` for **`vfscanf`** and **`vfwscanf`**. +Each of these functions returns the number of fields that are successfully converted and assigned. The return value doesn't include fields that are read but not assigned. A return value of 0 indicates that no fields were assigned. If an error occurs, or if the end of the file stream is reached before the first conversion, the return value is `EOF` for **`vfscanf`** and **`vfwscanf`**. These functions validate their parameters. If *`stream`* or *`format`* is a null pointer, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions return `EOF` and set `errno` to `EINVAL`. @@ -53,18 +53,18 @@ The **`vfscanf`** function reads data from the current position of *`stream`* in ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vftscanf`|**`vfscanf`**|**`vfscanf`**|**`vfwscanf`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vftscanf` | **`vfscanf`** | **`vfscanf`** | **`vfwscanf`** | For more information, see [Format specification fields: `scanf` and `wscanf` functions](../format-specification-fields-scanf-and-wscanf-functions.md). ## Requirements -|Function|Required header| -|--------------|---------------------| -|**`vfscanf`**|\| -|**`vfwscanf`**|\ or \| +| Function | Required header | +|---|---| +| **`vfscanf`** | \ | +| **`vfwscanf`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/vprintf-p-vprintf-p-l-vwprintf-p-vwprintf-p-l.md b/docs/c-runtime-library/reference/vprintf-p-vprintf-p-l-vwprintf-p-vwprintf-p-l.md index ebacf778e06..10c9938909f 100644 --- a/docs/c-runtime-library/reference/vprintf-p-vprintf-p-l-vwprintf-p-vwprintf-p-l.md +++ b/docs/c-runtime-library/reference/vprintf-p-vprintf-p-l-vwprintf-p-vwprintf-p-l.md @@ -69,21 +69,21 @@ If *`format`* is a null pointer, or if the format string contains invalid format ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vtprintf_p`|**`_vprintf_p`**|**`_vprintf_p`**|**`_vwprintf_p`**| -|`_vtprintf_p_l`|**`_vprintf_p_l`**|**`_vprintf_p_l`**|**`_vwprintf_p_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vtprintf_p` | **`_vprintf_p`** | **`_vprintf_p`** | **`_vwprintf_p`** | +| `_vtprintf_p_l` | **`_vprintf_p_l`** | **`_vprintf_p_l`** | **`_vwprintf_p_l`** | ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`_vprintf_p`**, **`_vprintf_p_l`**|\ and \|\*| -|**`_vwprintf_p`**, **`_vwprintf_p_l`**|\ or \, and \|\*| +| Routine | Required header | Optional headers | +|---|---|---| +| **`_vprintf_p`**, **`_vprintf_p_l`** | \ and \ | \* | +| **`_vwprintf_p`**, **`_vwprintf_p_l`** | \ or \, and \ | \* | \* Required for UNIX V compatibility. -The console is not supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). +The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). ## See also diff --git a/docs/c-runtime-library/reference/vprintf-s-vprintf-s-l-vwprintf-s-vwprintf-s-l.md b/docs/c-runtime-library/reference/vprintf-s-vprintf-s-l-vwprintf-s-vwprintf-s-l.md index bd5750f6eab..8d0723df48b 100644 --- a/docs/c-runtime-library/reference/vprintf-s-vprintf-s-l-vwprintf-s-vwprintf-s-l.md +++ b/docs/c-runtime-library/reference/vprintf-s-vprintf-s-l-vwprintf-s-vwprintf-s-l.md @@ -71,21 +71,21 @@ The versions of these functions with the `_l` suffix are identical except that t ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vtprintf_s`|**`vprintf_s`**|**`vprintf_s`**|**`vwprintf_s`**| -|`_vtprintf_s_l`|**`_vprintf_s_l`**|**`_vprintf_s_l`**|**`_vwprintf_s_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vtprintf_s` | **`vprintf_s`** | **`vprintf_s`** | **`vwprintf_s`** | +| `_vtprintf_s_l` | **`_vprintf_s_l`** | **`_vprintf_s_l`** | **`_vwprintf_s_l`** | ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`vprintf_s`**, **`_vprintf_s_l`**|\ and \|\*| -|**`vwprintf_s`**, **`_vwprintf_s_l`**|\ or \, and \|\*| +| Routine | Required header | Optional headers | +|---|---|---| +| **`vprintf_s`**, **`_vprintf_s_l`** | \ and \ | \* | +| **`vwprintf_s`**, **`_vwprintf_s_l`** | \ or \, and \ | \* | \* Required for UNIX V compatibility. -The console is not supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). +The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). ## See also diff --git a/docs/c-runtime-library/reference/vprintf-vprintf-l-vwprintf-vwprintf-l.md b/docs/c-runtime-library/reference/vprintf-vprintf-l-vwprintf-vwprintf-l.md index 951169dda08..06c7ce852b2 100644 --- a/docs/c-runtime-library/reference/vprintf-vprintf-l-vwprintf-vwprintf-l.md +++ b/docs/c-runtime-library/reference/vprintf-vprintf-l-vwprintf-vwprintf-l.md @@ -69,21 +69,21 @@ The versions of these functions with the `_l` suffix are identical except that t ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vtprintf`|**`vprintf`**|**`vprintf`**|**`vwprintf`**| -|`_vtprintf_l`|**`_vprintf_l`**|**`_vprintf_l`**|**`_vwprintf_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vtprintf` | **`vprintf`** | **`vprintf`** | **`vwprintf`** | +| `_vtprintf_l` | **`_vprintf_l`** | **`_vprintf_l`** | **`_vwprintf_l`** | ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`vprintf`**, **`_vprintf_l`**|\ and \|\*| -|**`vwprintf`**, **`_vwprintf_l`**|\ or \, and \|\*| +| Routine | Required header | Optional headers | +|---|---|---| +| **`vprintf`**, **`_vprintf_l`** | \ and \ | \* | +| **`vwprintf`**, **`_vwprintf_l`** | \ or \, and \ | \* | \* Required for UNIX V compatibility. -The console is not supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). +The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). ## See also diff --git a/docs/c-runtime-library/reference/vscanf-s-vwscanf-s.md b/docs/c-runtime-library/reference/vscanf-s-vwscanf-s.md index 5b66cf70091..ab7868f6b88 100644 --- a/docs/c-runtime-library/reference/vscanf-s-vwscanf-s.md +++ b/docs/c-runtime-library/reference/vscanf-s-vwscanf-s.md @@ -36,7 +36,7 @@ Variable argument list. ## Return value -Returns the number of fields successfully converted and assigned; the return value does not include fields that were read but not assigned. A return value of 0 indicates that no fields were assigned. The return value is `EOF` for an error, or if the end-of-file character or the end-of-string character is encountered in the first attempt to read a character. If *`format`* is a `NULL` pointer, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, **`vscanf_s`** and **`vwscanf_s`** return `EOF` and set `errno` to `EINVAL`. +Returns the number of fields successfully converted and assigned; the return value doesn't include fields that were read but not assigned. A return value of 0 indicates that no fields were assigned. The return value is `EOF` for an error, or if the end-of-file character or the end-of-string character is encountered in the first attempt to read a character. If *`format`* is a `NULL` pointer, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, **`vscanf_s`** and **`vwscanf_s`** return `EOF` and set `errno` to `EINVAL`. For information about these and other error codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -46,9 +46,9 @@ The **`vscanf_s`** function reads data from the standard input stream `stdin` an **`vwscanf_s`** is a wide-character version of **`vscanf_s`**; the *`format`* argument to **`vwscanf_s`** is a wide-character string. **`vwscanf_s`** and **`vscanf_s`** behave identically if the stream is opened in ANSI mode. **`vscanf_s`** doesn't support input from a UNICODE stream. -Unlike `vscanf` and `vwscanf`, **`vscanf_s`** and **`vwscanf_s`** require the buffer size to be specified for all input parameters of type **c**, **C**, **s**, **S**, or string control sets that are enclosed in **[]**. The buffer size in characters is passed as an additional parameter immediately following the pointer to the buffer or variable. The buffer size in characters for a **`wchar_t`** string is not the same as the size in bytes. +Unlike `vscanf` and `vwscanf`, **`vscanf_s`** and **`vwscanf_s`** require the buffer size to be specified for all input parameters of type **c**, **C**, **s**, **S**, or string control sets that are enclosed in **[]**. The buffer size in characters is passed as another parameter immediately following the pointer to the buffer or variable. The buffer size in characters for a **`wchar_t`** string isn't the same as the size in bytes. -The buffer size includes the terminating null. You can use a width-specification field to ensure that the token that's read in will fit into the buffer. If no width specification field is used, and the token read in is too big to fit in the buffer, nothing is written to that buffer. +The buffer size includes the terminating null. You can use a width-specification field to ensure that the token that's read in will fit into the buffer. If no width specification field is used, and the token read in is too large to fit in the buffer, nothing is written to that buffer. > [!NOTE] > The *`size`* parameter is of type **`unsigned`**, not `size_t`. @@ -57,20 +57,20 @@ For more information, see [scanf Width Specification](../scanf-width-specificati ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vtscanf_s`|**`vscanf_s`**|**`vscanf_s`**|**`vwscanf_s`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vtscanf_s` | **`vscanf_s`** | **`vscanf_s`** | **`vwscanf_s`** | For more information, see [Format specification fields: `scanf` and `wscanf` functions](../format-specification-fields-scanf-and-wscanf-functions.md). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`vscanf_s`**|\| -|**`wscanf_s`**|\ or \| +| Routine | Required header | +|---|---| +| **`vscanf_s`** | \ | +| **`wscanf_s`** | \ or \ | -The console is not supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). +The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). ## Example diff --git a/docs/c-runtime-library/reference/vscanf-vwscanf.md b/docs/c-runtime-library/reference/vscanf-vwscanf.md index b078291bb51..08abfd22f68 100644 --- a/docs/c-runtime-library/reference/vscanf-vwscanf.md +++ b/docs/c-runtime-library/reference/vscanf-vwscanf.md @@ -11,7 +11,7 @@ ms.assetid: d1df595b-11bc-4682-9441-a92616301e3b --- # `vscanf`, `vwscanf` -Reads formatted data from the standard input stream. More secure versions of these function are available; see [`vscanf_s`, `vwscanf_s`](vscanf-s-vwscanf-s.md). +Reads formatted data from the standard input stream. More secure versions of these functions are available; see [`vscanf_s`, `vwscanf_s`](vscanf-s-vwscanf-s.md). ## Syntax @@ -36,7 +36,7 @@ Variable argument list. ## Return value -Returns the number of fields that are successfully converted and assigned; the return value does not include fields that were read but not assigned. A return value of 0 indicates that no fields were assigned. +Returns the number of fields that are successfully converted and assigned; the return value doesn't include fields that were read but not assigned. A return value of 0 indicates that no fields were assigned. If *`format`* is a `NULL` pointer, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions return `EOF` and set `errno` to `EINVAL`. @@ -53,20 +53,20 @@ The **`vscanf`** function reads data from the standard input stream `stdin` and ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vtscanf`|**`vscanf`**|**`vscanf`**|**`vwscanf`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vtscanf` | **`vscanf`** | **`vscanf`** | **`vwscanf`** | For more information, see [Format specification fields: `scanf` and `wscanf` functions](../format-specification-fields-scanf-and-wscanf-functions.md). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`vscanf`**|\| -|**`vwscanf`**|\ or \| +| Routine | Required header | +|---|---| +| **`vscanf`** | \ | +| **`vwscanf`** | \ or \ | -The console is not supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). +The console isn't supported in Universal Windows Platform (UWP) apps. The standard stream handles that are associated with the console, `stdin`, `stdout`, and `stderr`, must be redirected before C run-time functions can use them in UWP apps. For more compatibility information, see [Compatibility](../compatibility.md). ## Example diff --git a/docs/c-runtime-library/reference/vscprintf-p-vscprintf-p-l-vscwprintf-p-vscwprintf-p-l.md b/docs/c-runtime-library/reference/vscprintf-p-vscprintf-p-l-vscwprintf-p-vscwprintf-p-l.md index c5b419013c1..ea69b12acc8 100644 --- a/docs/c-runtime-library/reference/vscprintf-p-vscprintf-p-l-vscwprintf-p-vscwprintf-p-l.md +++ b/docs/c-runtime-library/reference/vscprintf-p-vscprintf-p-l-vscwprintf-p-vscwprintf-p-l.md @@ -51,7 +51,7 @@ For more information, see [Format specification syntax](../format-specification- ## Return value -**`_vscprintf_p`** returns the number of characters that would be generated if the string pointed to by the list of arguments was printed or sent to a file or buffer using the specified formatting codes. The value returned does not include the terminating null character. **`_vscwprintf_p`** performs the same function for wide characters. +**`_vscprintf_p`** returns the number of characters that would be generated if the string pointed to by the list of arguments was printed or sent to a file or buffer using the specified formatting codes. The value returned doesn't include the terminating null character. **`_vscwprintf_p`** performs the same function for wide characters. ## Remarks @@ -67,17 +67,17 @@ If *`format`* is a null pointer, the invalid parameter handler is invoked, as de ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_vsctprintf_p`**|**`_vscprintf_p`**|**`_vscprintf_p`**|**`_vscwprintf_p`**| -|**`_vsctprintf_p_l`**|**`_vscprintf_p_l`**|**`_vscprintf_p_l`**|**`_vscwprintf_p_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| **`_vsctprintf_p`** | **`_vscprintf_p`** | **`_vscprintf_p`** | **`_vscwprintf_p`** | +| **`_vsctprintf_p_l`** | **`_vscprintf_p_l`** | **`_vscprintf_p_l`** | **`_vscwprintf_p_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_vscprintf_p`**, **`_vscprintf_p_l`**|``| -|**`_vscwprintf_p`**, **`_vscwprintf_p_l`**|`` or ``| +| Routine | Required header | +|---|---| +| **`_vscprintf_p`**, **`_vscprintf_p_l`** | `` | +| **`_vscwprintf_p`**, **`_vscwprintf_p_l`** | `` or `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/vscprintf-vscprintf-l-vscwprintf-vscwprintf-l.md b/docs/c-runtime-library/reference/vscprintf-vscprintf-l-vscwprintf-vscwprintf-l.md index c5490a3ca6b..e02f6cdb18d 100644 --- a/docs/c-runtime-library/reference/vscprintf-vscprintf-l-vscwprintf-vscwprintf-l.md +++ b/docs/c-runtime-library/reference/vscprintf-vscprintf-l-vscwprintf-vscwprintf-l.md @@ -51,7 +51,7 @@ For more information, see [Format specification syntax](../format-specification- ## Return value -**`_vscprintf`** returns the number of characters that would be generated if the string pointed to by the list of arguments was printed or sent to a file or buffer using the specified formatting codes. The value returned does not include the terminating null character. **`_vscwprintf`** performs the same function for wide characters. +**`_vscprintf`** returns the number of characters that would be generated if the string pointed to by the list of arguments was printed or sent to a file or buffer using the specified formatting codes. The value returned doesn't include the terminating null character. **`_vscwprintf`** performs the same function for wide characters. 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. @@ -68,17 +68,17 @@ Each *`argument`* (if any) is converted according to the corresponding format sp ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vsctprintf`|**`_vscprintf`**|**`_vscprintf`**|**`_vscwprintf`**| -|`_vsctprintf_l`|**`_vscprintf_l`**|**`_vscprintf_l`**|**`_vscwprintf_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vsctprintf` | **`_vscprintf`** | **`_vscprintf`** | **`_vscwprintf`** | +| `_vsctprintf_l` | **`_vscprintf_l`** | **`_vscprintf_l`** | **`_vscwprintf_l`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_vscprintf`**, **`_vscprintf_l`**|\| -|**`_vscwprintf`**, **`_vscwprintf_l`**|\ or \| +| Routine | Required header | +|---|---| +| **`_vscprintf`**, **`_vscprintf_l`** | \ | +| **`_vscwprintf`**, **`_vscwprintf_l`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/vsnprintf-s-vsnprintf-s-vsnprintf-s-l-vsnwprintf-s-vsnwprintf-s-l.md b/docs/c-runtime-library/reference/vsnprintf-s-vsnprintf-s-vsnprintf-s-l-vsnwprintf-s-vsnwprintf-s-l.md index 9ce0d50c34a..653f4225c7e 100644 --- a/docs/c-runtime-library/reference/vsnprintf-s-vsnprintf-s-vsnprintf-s-l-vsnwprintf-s-vsnwprintf-s-l.md +++ b/docs/c-runtime-library/reference/vsnprintf-s-vsnprintf-s-vsnprintf-s-l-vsnwprintf-s-vsnwprintf-s-l.md @@ -11,7 +11,7 @@ helpviewer_keywords: ["vsnwprintf_s function", "_vsntprintf_s function", "_vsntp --- # `vsnprintf_s`, `_vsnprintf_s`, `_vsnprintf_s_l`, `_vsnwprintf_s`, `_vsnwprintf_s_l` -Write formatted output using a pointer to a list of arguments. These are versions of [`vsnprintf`, `_vsnprintf`, `_vsnprintf_l`, `_vsnwprintf`, `_vsnwprintf_l`](vsnprintf-vsnprintf-vsnprintf-l-vsnwprintf-vsnwprintf-l.md) with security enhancements as described in [Security features in the CRT](../security-features-in-the-crt.md). +Write formatted output using a pointer to a list of arguments. These functions are versions of [`vsnprintf`, `_vsnprintf`, `_vsnprintf_l`, `_vsnwprintf`, `_vsnwprintf_l`](vsnprintf-vsnprintf-vsnprintf-l-vsnwprintf-vsnwprintf-l.md) with security enhancements as described in [Security features in the CRT](../security-features-in-the-crt.md). ## Syntax @@ -109,12 +109,12 @@ For more information, see [Format specifications](../format-specification-syntax ### Error conditions -|`Condition`|Return|`errno`| -|-----------------|------------|-------------| -|*`buffer`* is `NULL`|-1|`EINVAL`| -|*`format`* is `NULL`|-1|`EINVAL`| -|*`count`* <= 0|-1|`EINVAL`| -|*`sizeOfBuffer`* too small (and *`count`* != `_TRUNCATE`)|-1 (and *`buffer`* set to an empty string)|`ERANGE`| +| Condition | Return value | `errno` | +|---|---|---| +| *`buffer`* is `NULL` | -1 | `EINVAL` | +| *`format`* is `NULL` | -1 | `EINVAL` | +| *`count`* <= 0 | -1 | `EINVAL` | +| *`sizeOfBuffer`* too small (and *`count`* != `_TRUNCATE`) | -1 (and *`buffer`* set to an empty string) | `ERANGE` | ## Remarks @@ -140,18 +140,18 @@ In C++, using these functions is simplified by template overloads; the overloads ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_vsntprintf_s`**|**`_vsnprintf_s`**|**`_vsnprintf_s`**|**`_vsnwprintf_s`**| -|**`_vsntprintf_s_l`**|**`_vsnprintf_s_l`**|**`_vsnprintf_s_l`**|**`_vsnwprintf_s_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vsntprintf_s` | **`_vsnprintf_s`** | **`_vsnprintf_s`** | **`_vsnwprintf_s`** | +| `_vsntprintf_s_l` | **`_vsnprintf_s_l`** | **`_vsnprintf_s_l`** | **`_vsnwprintf_s_l`** | ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`vsnprintf_s`**|`` and ``|``*| -|**`_vsnprintf_s`**, **`_vsnprintf_s_l`**|`` and ``|``*| -|**`_vsnwprintf_s`**, **`_vsnwprintf_s_l`**|`` or ``, and ``|``*| +| Routine | Required header | Optional headers | +|---|---|---| +| **`vsnprintf_s`** | `` and `` | ``* | +| **`_vsnprintf_s`**, **`_vsnprintf_s_l`** | `` and `` | ``* | +| **`_vsnwprintf_s`**, **`_vsnwprintf_s_l`** | `` or ``, and `` | ``* | \* Required for UNIX V compatibility. diff --git a/docs/c-runtime-library/reference/vsnprintf-vsnprintf-vsnprintf-l-vsnwprintf-vsnwprintf-l.md b/docs/c-runtime-library/reference/vsnprintf-vsnprintf-vsnprintf-l-vsnwprintf-vsnwprintf-l.md index f3153f762c5..b0fc829b068 100644 --- a/docs/c-runtime-library/reference/vsnprintf-vsnprintf-vsnprintf-l-vsnwprintf-vsnwprintf-l.md +++ b/docs/c-runtime-library/reference/vsnprintf-vsnprintf-vsnprintf-l-vsnwprintf-vsnwprintf-l.md @@ -114,13 +114,13 @@ Both **`_vsnprintf`** and **`_vsnwprintf`** functions return the number of chara The value returned by all these functions doesn't include the terminating null, whether one is written or not. -- If *`count`* is zero and *`buffer`* is `NULL`, the value returned is the number of characters the functions would write. The value does not take into account a terminating `NULL`. You can use this result to allocate sufficient buffer space for the string and its terminating null, and then call the function again to fill the buffer. +- If *`count`* is zero and *`buffer`* is `NULL`, the value returned is the number of characters the functions would write. The value doesn't take into account a terminating `NULL`. You can use this result to allocate sufficient buffer space for the string and a terminating null, and then call the function again to fill the buffer. - If *`count`* is zero but *`buffer`* isn't `NULL`, nothing is written and the function returns `-1`. - If *`format`* is `NULL`, or if *`buffer`* is `NULL` and *`count`* isn't equal to zero, these functions invoke the invalid parameter handler, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions return -1 and set `errno` to `EINVAL`. ## Remarks -Each of these functions takes a pointer to an argument list, then formats the data, and writes up to *`count`* characters to the memory pointed to by *`buffer`*. The **`vsnprintf`** function always writes a null terminator, even if it truncates the output. When using **`_vsnprintf`** and **`_vsnwprintf`**, the buffer will be null-terminated only if there's room at the end (that is, if the number of characters to write is less than *`count`*). +Each of these functions takes a pointer to an argument list, then formats the data, and writes up to *`count`* characters to the memory pointed to by *`buffer`*. The **`vsnprintf`** function always writes a null terminator, even if it truncates the output. When you use **`_vsnprintf`** and **`_vsnwprintf`**, the buffer is null-terminated only if there's room at the end (that is, if the number of characters to write is less than *`count`*). > [!IMPORTANT] > To prevent certain kinds of security risks, ensure that *`format`* isn't a user-defined string. For more information, see [Avoiding buffer overruns](/windows/win32/SecBP/avoiding-buffer-overruns). @@ -139,17 +139,17 @@ In C++, these functions have template overloads that invoke the newer, secure co ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` & `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_vsntprintf`**|**`_vsnprintf`**|**`_vsnprintf`**|**`_vsnwprintf`**| -|**`_vsntprintf_l`**|**`_vsnprintf_l`**|**`_vsnprintf_l`**|**`_vsnwprintf_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vsntprintf` | **`_vsnprintf`** | **`_vsnprintf`** | **`_vsnwprintf`** | +| `_vsntprintf_l` | **`_vsnprintf_l`** | **`_vsnprintf_l`** | **`_vsnwprintf_l`** | ## Requirements -|Routine|Required header (C)|Required header (C++)| -|-------------|---------------------------|-------------------------------| -|**`vsnprintf`**, **`_vsnprintf`**, **`_vsnprintf_l`**|``|`` or ``| -|**`_vsnwprintf`**, **`_vsnwprintf_l`**|`` or ``|``, ``, ``, or ``| +| Routine | Required header (C) | Required header (C++) | +|---|---|---| +| **`vsnprintf`**, **`_vsnprintf`**, **`_vsnprintf_l`** | `` | `` or `` | +| **`_vsnwprintf`**, **`_vsnwprintf_l`** | `` or `` | ``, ``, ``, or `` | The **`_vsnprintf`**, **`_vsnprintf_l`**, **`_vsnwprintf`** and **`_vsnwprintf_l`** functions are Microsoft-specific. For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/vsprintf-p-vsprintf-p-l-vswprintf-p-vswprintf-p-l.md b/docs/c-runtime-library/reference/vsprintf-p-vsprintf-p-l-vswprintf-p-vswprintf-p-l.md index a6ef2ca254e..7f67d33cd26 100644 --- a/docs/c-runtime-library/reference/vsprintf-p-vsprintf-p-l-vswprintf-p-vswprintf-p-l.md +++ b/docs/c-runtime-library/reference/vsprintf-p-vsprintf-p-l-vswprintf-p-vswprintf-p-l.md @@ -83,17 +83,17 @@ If the *`buffer`* or *`format`* parameters are `NULL` pointers, if count is zero ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vstprintf_p`|**`_vsprintf_p`**|**`_vsprintf_p`**|**`_vswprintf_p`**| -|`_vstprintf_p_l`|**`_vsprintf_p_l`**|**`_vsprintf_p_l`**|**`_vswprintf_p_l`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vstprintf_p` | **`_vsprintf_p`** | **`_vsprintf_p`** | **`_vswprintf_p`** | +| `_vstprintf_p_l` | **`_vsprintf_p_l`** | **`_vsprintf_p_l`** | **`_vswprintf_p_l`** | ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`_vsprintf_p`**, **`_vsprintf_p_l`**|\ and \|\*| -|**`_vswprintf_p`**, **`_vswprintf_p_l`**|\ or \, and \|\*| +| Routine | Required header | Optional headers | +|---|---|---| +| **`_vsprintf_p`**, **`_vsprintf_p_l`** | \ and \ | \* | +| **`_vswprintf_p`**, **`_vswprintf_p_l`** | \ or \, and \ | \* | \* Required for UNIX V compatibility. diff --git a/docs/c-runtime-library/reference/vsprintf-s-vsprintf-s-l-vswprintf-s-vswprintf-s-l.md b/docs/c-runtime-library/reference/vsprintf-s-vsprintf-s-l-vswprintf-s-vswprintf-s-l.md index 5ff26788872..645a187387b 100644 --- a/docs/c-runtime-library/reference/vsprintf-s-vsprintf-s-l-vswprintf-s-vswprintf-s-l.md +++ b/docs/c-runtime-library/reference/vsprintf-s-vsprintf-s-l-vswprintf-s-vswprintf-s-l.md @@ -96,17 +96,17 @@ In C++, using these functions is simplified by template overloads. The overloads ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_vstprintf_s`**|**`vsprintf_s`**|**`vsprintf_s`**|**`vswprintf_s`**| -|**`_vstprintf_s_l`**|**`_vsprintf_s_l`**|**`_vsprintf_s_l`**|**`_vswprintf_s_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vstprintf_s` | **`vsprintf_s`** | **`vsprintf_s`** | **`vswprintf_s`** | +| `_vstprintf_s_l` | **`_vsprintf_s_l`** | **`_vsprintf_s_l`** | **`_vswprintf_s_l`** | ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`vsprintf_s`**, **`_vsprintf_s_l`**|`` and ``|`*`| -|**`vswprintf_s`**, **`_vswprintf_s_l`**|`` or ``, and ``|`*`| +| Routine | Required header | Optional headers | +|---|---|---| +| **`vsprintf_s`**, **`_vsprintf_s_l`** | `` and `` | `*` | +| **`vswprintf_s`**, **`_vswprintf_s_l`** | `` or ``, and `` | `*` | \* Required for UNIX V compatibility. diff --git a/docs/c-runtime-library/reference/vsprintf-vsprintf-l-vswprintf-vswprintf-l-vswprintf-l.md b/docs/c-runtime-library/reference/vsprintf-vsprintf-l-vswprintf-vswprintf-l-vswprintf-l.md index fd1f05555f4..acaff8c14f0 100644 --- a/docs/c-runtime-library/reference/vsprintf-vsprintf-l-vswprintf-vswprintf-l-vswprintf-l.md +++ b/docs/c-runtime-library/reference/vsprintf-vsprintf-l-vswprintf-vswprintf-l-vswprintf-l.md @@ -113,17 +113,17 @@ In C++, these functions have template overloads that invoke the newer, secure co ### Generic-text routine mappings -|`TCHAR.H` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|**`_vstprintf`**|**`vsprintf`**|**`vsprintf`**|**`vswprintf`**| -|**`_vstprintf_l`**|**`_vsprintf_l`**|**`_vsprintf_l`**|**`_vswprintf_l`**| +| `TCHAR.H` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vstprintf` | **`vsprintf`** | **`vsprintf`** | **`vswprintf`** | +| `_vstprintf_l` | **`_vsprintf_l`** | **`_vsprintf_l`** | **`_vswprintf_l`** | ## Requirements -|Routine|Required header|Optional headers| -|-------------|---------------------|----------------------| -|**`vsprintf`**, **`_vsprintf_l`**|`` and ``|``*| -|**`vswprintf`**, **`_vswprintf_l`**|`` or ``, and ``|``*| +| Routine | Required header | Optional headers | +|---|---|---| +| **`vsprintf`**, **`_vsprintf_l`** | `` and `` | ``* | +| **`vswprintf`**, **`_vswprintf_l`** | `` or ``, and `` | ``* | \* Required for UNIX V compatibility. diff --git a/docs/c-runtime-library/reference/vsscanf-s-vswscanf-s.md b/docs/c-runtime-library/reference/vsscanf-s-vswscanf-s.md index 16950d9ea5d..e95d0c4dedd 100644 --- a/docs/c-runtime-library/reference/vsscanf-s-vswscanf-s.md +++ b/docs/c-runtime-library/reference/vsscanf-s-vswscanf-s.md @@ -41,7 +41,7 @@ Variable argument list. ## Return value -Each of these functions returns the number of fields that are successfully converted and assigned; the return value does not include fields that were read but not assigned. A return value of 0 indicates that no fields were assigned. The return value is `EOF` for an error or if the end of the string is reached before the first conversion. +Each of these functions returns the number of fields that are successfully converted and assigned. The return value doesn't include fields that were read but not assigned. A return value of 0 indicates that no fields were assigned. The return value is `EOF` for an error or if the end of the string is reached before the first conversion. If *`buffer`* or *`format`* is a `NULL` pointer, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions return -1 and set `errno` to `EINVAL`. @@ -49,9 +49,9 @@ For information about these and other error codes, see [`errno`, `_doserrno`, `_ ## Remarks -The **`vsscanf_s`** function reads data from *`buffer`* into the locations that are given by each argument in the *`arglist`* argument list. The arguments in the argument list specify pointers to variables that have a type that corresponds to a type specifier in *`format`*. Unlike the less secure version **`vsscanf`**, a buffer size parameter is required when you use the type field characters **c**, **C**, **s**, **S**, or string-control sets that are enclosed in **[]**. The buffer size in characters must be supplied as an additional parameter immediately after each buffer parameter that requires it. +The **`vsscanf_s`** function reads data from *`buffer`* into the locations that are given by each argument in the *`arglist`* argument list. The arguments in the argument list specify pointers to variables that have a type that corresponds to a type specifier in *`format`*. Unlike the less secure version **`vsscanf`**, a buffer size parameter is required when you use the type field characters **c**, **C**, **s**, **S**, or string-control sets that are enclosed in **[]**. The buffer size in characters must be supplied as another parameter immediately after each buffer parameter that requires it. -The buffer size includes the terminating null. A width specification field may be used to ensure that the token that's read in will fit into the buffer. If no width specification field is used, and the token read in is too big to fit in the buffer, nothing is written to that buffer. +The buffer size includes the terminating null. A width specification field may be used to ensure that the token that's read in will fit into the buffer. If no width specification field is used, and the token read in is too large to fit in the buffer, nothing is written to that buffer. For more information, see [`scanf_s`, `_scanf_s_l`, `wscanf_s`, `_wscanf_s_l`](scanf-s-scanf-s-l-wscanf-s-wscanf-s-l.md) and [scanf Type Field Characters](../scanf-type-field-characters.md). @@ -60,20 +60,20 @@ For more information, see [`scanf_s`, `_scanf_s_l`, `wscanf_s`, `_wscanf_s_l`](s The *`format`* argument controls the interpretation of the input fields and has the same form and function as the *`format`* argument for the `scanf_s` function. If copying occurs between strings that overlap, the behavior is undefined. -**`vswscanf_s`** is a wide-character version of **`vsscanf_s`**; the arguments to **`vswscanf_s`** are wide-character strings. **`vsscanf_s`** does not handle multibyte hexadecimal characters. **`vswscanf_s`** does not handle Unicode full-width hexadecimal or "compatibility zone" characters. Otherwise, **`vswscanf_s`** and **`vsscanf_s`** behave identically. +**`vswscanf_s`** is a wide-character version of **`vsscanf_s`**; the arguments to **`vswscanf_s`** are wide-character strings. **`vsscanf_s`** doesn't handle multibyte hexadecimal characters. **`vswscanf_s`** doesn't handle Unicode full-width hexadecimal or "compatibility zone" characters. Otherwise, **`vswscanf_s`** and **`vsscanf_s`** behave identically. ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vstscanf_s`|**`vsscanf_s`**|**`vsscanf_s`**|**`vswscanf_s`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vstscanf_s` | **`vsscanf_s`** | **`vsscanf_s`** | **`vswscanf_s`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`vsscanf_s`**|\| -|**`vswscanf_s`**|\ or \| +| Routine | Required header | +|---|---| +| **`vsscanf_s`** | \ | +| **`vswscanf_s`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/vsscanf-vswscanf.md b/docs/c-runtime-library/reference/vsscanf-vswscanf.md index 1cac9697952..16192602594 100644 --- a/docs/c-runtime-library/reference/vsscanf-vswscanf.md +++ b/docs/c-runtime-library/reference/vsscanf-vswscanf.md @@ -42,7 +42,7 @@ Variable argument list. ## Return value -Each of these functions returns the number of fields that are successfully converted and assigned; the return value does not include fields that were read but not assigned. A return value of 0 indicates that no fields were assigned. The return value is `EOF` for an error or if the end of the string is reached before the first conversion. +Each of these functions returns the number of fields that are successfully converted and assigned. The return value doesn't include fields that were read but not assigned. A return value of 0 indicates that no fields were assigned. The return value is `EOF` for an error or if the end of the string is reached before the first conversion. If *`buffer`* or *`format`* is a `NULL` pointer, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, these functions return -1 and set `errno` to `EINVAL`. @@ -55,20 +55,20 @@ The **`vsscanf`** function reads data from *`buffer`* into the locations that ar > [!IMPORTANT] > When you use **`vsscanf`** to read a string, always specify a width for the **%s** format (for example, **"%32s"** instead of **"%s"**); otherwise, incorrectly formatted input can cause a buffer overrun. -**`vswscanf`** is a wide-character version of **`vsscanf`**; the arguments to **`vswscanf`** are wide-character strings. **`vsscanf`** does not handle multibyte hexadecimal characters. **`vswscanf`** does not handle Unicode full-width hexadecimal or "compatibility zone" characters. Otherwise, **`vswscanf`** and **`vsscanf`** behave identically. +**`vswscanf`** is a wide-character version of **`vsscanf`**; the arguments to **`vswscanf`** are wide-character strings. **`vsscanf`** doesn't handle multibyte hexadecimal characters. **`vswscanf`** doesn't handle Unicode full-width hexadecimal or "compatibility zone" characters. Otherwise, **`vswscanf`** and **`vsscanf`** behave identically. ### Generic-text routine mappings -|TCHAR.H routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|------------------------------------|--------------------|-----------------------| -|`_vstscanf`|**`vsscanf`**|**`vsscanf`**|**`vswscanf`**| +| TCHAR.H routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_vstscanf` | **`vsscanf`** | **`vsscanf`** | **`vswscanf`** | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`vsscanf`**|\| -|**`vswscanf`**|\ or \| +| Routine | Required header | +|---|---| +| **`vsscanf`** | \ | +| **`vswscanf`** | \ or \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/wcrtomb-s.md b/docs/c-runtime-library/reference/wcrtomb-s.md index 0fe5ae3e385..af72c964330 100644 --- a/docs/c-runtime-library/reference/wcrtomb-s.md +++ b/docs/c-runtime-library/reference/wcrtomb-s.md @@ -58,7 +58,7 @@ Returns zero or an `errno` value if an error occurs. The **`wcrtomb_s`** function converts a wide character, beginning in the specified conversion state contained in *`mbstate`*, from the value contained in *`wchar`*, into the address represented by *`mbchar`*. The *`pReturnValue`* value will be the number of bytes converted, but no more than `MB_CUR_MAX` bytes, or an -1 if an error occurred. -If *`mbstate`* is null, the internal `mbstate_t` conversion state is used. If the character contained in *`wchar`* does not have a corresponding multibyte character, the value of *`pReturnValue`* will be -1 and the function will return the `errno` value of `EILSEQ`. +If *`mbstate`* is null, the internal `mbstate_t` conversion state is used. If the character contained in *`wchar`* doesn't have a corresponding multibyte character, the value of *`pReturnValue`* is -1, and the function returns the `errno` value of `EILSEQ`. The **`wcrtomb_s`** function differs from [`wctomb_s`, `_wctomb_s_l`](wctomb-s-wctomb-s-l.md) by its restartability. The conversion state is stored in *`mbstate`* for subsequent calls to the same or other restartable functions. Results are undefined when mixing the use of restartable and nonrestartable functions. For example, an application would use `wcsrlen` rather than `wcslen`, if a subsequent call to `wcsrtombs_s` were used instead of `wcstombs_s`. @@ -116,9 +116,9 @@ The corresponding wide character "Q" was converted to a the "Q" multibyte charac ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`wcrtomb_s`**|\| +| Routine | Required header | +|---|---| +| **`wcrtomb_s`** | \ | ## See also diff --git a/docs/c-runtime-library/reference/wcrtomb.md b/docs/c-runtime-library/reference/wcrtomb.md index 76951ea2d85..0c0656d4ad0 100644 --- a/docs/c-runtime-library/reference/wcrtomb.md +++ b/docs/c-runtime-library/reference/wcrtomb.md @@ -49,7 +49,7 @@ Returns the number of bytes required to represent the converted multibyte charac The **`wcrtomb`** function converts a wide character, beginning in the specified conversion state contained in *`mbstate`*, from the value contained in *`wchar`*, into the address represented by *`mbchar`*. The return value is the number of bytes required to represent the corresponding multibyte character, but it will not return more than `MB_CUR_MAX` bytes. -If *`mbstate`* is null, the internal `mbstate_t` object containing the conversion state of *`mbchar`* is used. If the character sequence *`wchar`* does not have a corresponding multibyte character representation, a -1 is returned and the `errno` is set to `EILSEQ`. +If *`mbstate`* is null, the internal `mbstate_t` object containing the conversion state of *`mbchar`* is used. If the character sequence *`wchar`* doesn't have a corresponding multibyte character representation, a -1 is returned, and the `errno` is set to `EILSEQ`. The **`wcrtomb`** function differs from [`wctomb`, `_wctomb_l`](wctomb-wctomb-l.md) by its restartability. The conversion state is stored in *`mbstate`* for subsequent calls to the same or other restartable functions. Results are undefined when mixing the use of restartable and nonrestartable functions. For example, an application would use `wcsrlen` rather than `wcsnlen`, if a subsequent call to `wcsrtombs` were used instead of `wcstombs`. @@ -106,9 +106,9 @@ The corresponding wide character "Q" was converted to the "Q" multibyte characte ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`wcrtomb`**|\| +| Routine | Required header | +|---|---| +| **`wcrtomb`** | \ | ## See also diff --git a/docs/c-runtime-library/reference/wcsrtombs-s.md b/docs/c-runtime-library/reference/wcsrtombs-s.md index 0b132a6f0cf..1ffcf1ef475 100644 --- a/docs/c-runtime-library/reference/wcsrtombs-s.md +++ b/docs/c-runtime-library/reference/wcsrtombs-s.md @@ -59,11 +59,11 @@ A pointer to an `mbstate_t` conversion state object. Zero if successful, an error code on failure. -|Error condition|Return value and `errno`| -|---------------------|------------------------------| -|*`mbstr`* is `NULL` and *`sizeInBytes`* > 0|`EINVAL`| -|*`wcstr`* is `NULL`|`EINVAL`| -|The destination buffer is too small to contain the converted string (unless *`count`* is `_TRUNCATE`; see Remarks below)|`ERANGE`| +| Error condition | Return value and `errno` | +|---|---| +| *`mbstr`* is `NULL` and *`sizeInBytes`* > 0 | `EINVAL` | +| *`wcstr`* is `NULL` | `EINVAL` | +| The destination buffer is too small to contain the converted string (unless *`count`* is `_TRUNCATE`; see Remarks below) | `ERANGE` | If any of these conditions occurs, the invalid parameter exception is invoked as described in [Parameter validation](../parameter-validation.md) . If execution is allowed to continue, the function returns an error code and sets `errno` as indicated in the table. @@ -73,17 +73,17 @@ The **`wcsrtombs_s`** function converts a string of wide characters pointed to b - A null wide character is encountered -- A wide character that cannot be converted is encountered +- A wide character that can't be converted is encountered - The number of bytes stored in the *`mbstr`* buffer equals *`count`*. -The destination string is always null-terminated (even in the case of an error). +The destination string is always null-terminated (even if there's an error). If *`count`* is the special value [`_TRUNCATE`](../truncate.md), then **`wcsrtombs_s`** converts as much of the string as will fit into the destination buffer, while still leaving room for a null terminator. -If **`wcsrtombs_s`** successfully converts the source string, it puts the size in bytes of the converted string, including the null terminator, into `*pReturnValue` (provided *`pReturnValue`* is not `NULL`). This occurs even if the *`mbstr`* argument is `NULL` and provides a way to determine the required buffer size. Note that if *`mbstr`* is `NULL`, *`count`* is ignored. +If **`wcsrtombs_s`** successfully converts the source string, it puts the size in bytes of the converted string, including the null terminator, into `*pReturnValue` (provided *`pReturnValue`* isn't `NULL`). The size is calculated even if the *`mbstr`* argument is `NULL`; it provides a way to determine the required buffer size. If *`mbstr`* is `NULL`, *`count`* is ignored. -If **`wcsrtombs_s`** encounters a wide character it cannot convert to a multibyte character, it puts -1 in *\*`pReturnValue`*, sets the destination buffer to an empty string, sets `errno` to `EILSEQ`, and returns `EILSEQ`. +If **`wcsrtombs_s`** encounters a wide character it can't convert to a multibyte character, it puts -1 in *\*`pReturnValue`*, sets the destination buffer to an empty string, sets `errno` to `EILSEQ`, and returns `EILSEQ`. If the sequences pointed to by *`wcstr`* and *`mbstr`* overlap, the behavior of **`wcsrtombs_s`** is undefined. **`wcsrtombs_s`** is affected by the LC_TYPE category of the current locale. @@ -149,9 +149,9 @@ The string was successfully converted. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`wcsrtombs_s`**|\| +| Routine | Required header | +|---|---| +| **`wcsrtombs_s`** | \ | ## See also diff --git a/docs/c-runtime-library/reference/wcsrtombs.md b/docs/c-runtime-library/reference/wcsrtombs.md index 197d41e7894..4bf33838617 100644 --- a/docs/c-runtime-library/reference/wcsrtombs.md +++ b/docs/c-runtime-library/reference/wcsrtombs.md @@ -41,7 +41,7 @@ The resulting converted multibyte character string's address location. Indirectly points to the location of the wide character string to be converted. *`count`*\ -The number of character to be converted. +The number of characters to be converted. *`mbstate`*\ A pointer to an `mbstate_t` conversion state object. @@ -58,7 +58,7 @@ Thus, the multibyte character string at *`mbstr`* is null-terminated only if **` The **`wcsrtombs`** function differs from [`wcstombs`, `_wcstombs_l`](wcstombs-wcstombs-l.md) by its restartability. The conversion state is stored in *`mbstate`* for subsequent calls to the same or other restartable functions. Results are undefined when mixing the use of restartable and nonrestartable functions. For example, an application would use `wcsrlen` rather than `wcsnlen`, if a subsequent call to **`wcsrtombs`** were used instead of `wcstombs`. -If the *`mbstr`* argument is `NULL`, **`wcsrtombs`** returns the required size in bytes of the destination string. If *`mbstate`* is null, the internal `mbstate_t` conversion state is used. If the character sequence *`wchar`* does not have a corresponding multibyte character representation, a -1 is returned and the `errno` is set to `EILSEQ`. +If the *`mbstr`* argument is `NULL`, **`wcsrtombs`** returns the required size in bytes of the destination string. If *`mbstate`* is null, the internal `mbstate_t` conversion state is used. If the character sequence *`wchar`* doesn't have a corresponding multibyte character representation, a -1 is returned, and the `errno` is set to `EILSEQ`. In C++, this function has a template overload that invokes the newer, secure counterpart of this function. For more information, see [Secure template overloads](../secure-template-overloads.md). @@ -66,7 +66,7 @@ By default, this function's global state is scoped to the application. To change ## Exceptions -The **`wcsrtombs`** function is multithread safe as long as no function in the current thread calls `setlocale` while this function is executing and the *`mbstate`* is not null. +The **`wcsrtombs`** function is multithread safe as long as no function in the current thread calls `setlocale` while this function is executing and the *`mbstate`* isn't null. ## Example @@ -116,9 +116,9 @@ The string was successfuly converted. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`wcsrtombs`**|\| +| Routine | Required header | +|---|---| +| **`wcsrtombs`** | \ | ## See also diff --git a/docs/c-runtime-library/reference/wcstombs-s-wcstombs-s-l.md b/docs/c-runtime-library/reference/wcstombs-s-wcstombs-s-l.md index 7b2a72914ac..13d83cf2947 100644 --- a/docs/c-runtime-library/reference/wcstombs-s-wcstombs-s-l.md +++ b/docs/c-runtime-library/reference/wcstombs-s-wcstombs-s-l.md @@ -75,11 +75,11 @@ The locale to use. Zero if successful, an error code on failure. -|Error condition|Return value and `errno`| -|---------------------|------------------------------| -|*`mbstr`* is `NULL` and *`sizeInBytes`* > 0|`EINVAL`| -|*`wcstr`* is `NULL`|`EINVAL`| -|The destination buffer is too small to contain the converted string (unless *`count`* is `_TRUNCATE`; see Remarks below)|`ERANGE`| +| Error condition | Return value and `errno` | +|---|---| +| *`mbstr`* is `NULL` and *`sizeInBytes`* > 0 | `EINVAL` | +| *`wcstr`* is `NULL` | `EINVAL` | +| The destination buffer is too small to contain the converted string (unless *`count`* is `_TRUNCATE`; see Remarks below) | `ERANGE` | If any of these conditions occurs, the invalid parameter exception is invoked as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, the function returns an error code and sets `errno` as indicated in the table. @@ -89,17 +89,17 @@ The **`wcstombs_s`** function converts a string of wide characters pointed to by - A null wide character is encountered -- A wide character that cannot be converted is encountered +- A wide character that can't be converted is encountered - The number of bytes stored in the *`mbstr`* buffer equals *`count`*. -The destination string is always null-terminated (even in the case of an error). +The destination string is always null-terminated (even if there's an error). If *`count`* is the special value [`_TRUNCATE`](../truncate.md), then **`wcstombs_s`** converts as much of the string as will fit into the destination buffer, while still leaving room for a null terminator. If the string is truncated, the return value is `STRUNCATE`, and the conversion is considered successful. -If **`wcstombs_s`** successfully converts the source string, it puts the size in bytes of the converted string, including the null terminator, into *`*pReturnValue`* (provided *`pReturnValue`* is not `NULL`). This occurs even if the *`mbstr`* argument is `NULL` and provides a way to determine the required buffer size. Note that if *`mbstr`* is `NULL`, *`count`* is ignored. +If **`wcstombs_s`** successfully converts the source string, it puts the size in bytes of the converted string, including the null terminator, into *`*pReturnValue`* (provided *`pReturnValue`* isn't `NULL`). The size is calculated even if the *`mbstr`* argument is `NULL`; it provides a way to determine the required buffer size. If *`mbstr`* is `NULL`, *`count`* is ignored. -If **`wcstombs_s`** encounters a wide character it cannot convert to a multibyte character, it puts 0 in *`*ReturnValue`*, sets the destination buffer to an empty string, sets `errno` to `EILSEQ`, and returns `EILSEQ`. +If **`wcstombs_s`** encounters a wide character it can't convert to a multibyte character, it puts 0 in *`*ReturnValue`*, sets the destination buffer to an empty string, sets `errno` to `EILSEQ`, and returns `EILSEQ`. If the sequences pointed to by *`wcstr`* and *`mbstr`* overlap, the behavior of **`wcstombs_s`** is undefined. @@ -114,9 +114,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`wcstombs_s`**|``| +| Routine | Required header | +|---|---| +| **`wcstombs_s`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/wcstombs-wcstombs-l.md b/docs/c-runtime-library/reference/wcstombs-wcstombs-l.md index 71bcbe0a454..e21c2a1b67a 100644 --- a/docs/c-runtime-library/reference/wcstombs-wcstombs-l.md +++ b/docs/c-runtime-library/reference/wcstombs-wcstombs-l.md @@ -62,7 +62,7 @@ If **`wcstombs`** successfully converts the multibyte string, it returns the num ## Remarks -The **`wcstombs`** function converts the wide-character string pointed to by *`wcstr`* to the corresponding multibyte characters and stores the results in the *`mbstr`* array. The *`count`* parameter indicates the maximum number of bytes that can be stored in the multibyte output string (that is, the size of *`mbstr`*). In general, it isn't known how many bytes will be required when converting a wide-character string. Some wide characters will require only one byte in the output string; others require two. If there are two bytes in the multibyte output string for every wide character in the input string (including the wide character `NULL`), the result is guaranteed to fit. +The **`wcstombs`** function converts the wide-character string pointed to by *`wcstr`* to the corresponding multibyte characters and stores the results in the *`mbstr`* array. The *`count`* parameter indicates the maximum number of bytes that can be stored in the multibyte output string (that is, the size of *`mbstr`*). In general, it isn't known how many bytes will be required when converting a wide-character string. Some wide characters will require only a single byte in the output string; others require 2 bytes. If there are 2 bytes in the multibyte output string for every wide character in the input string (including the wide character `NULL`), the result is guaranteed to fit. If **`wcstombs`** encounters the wide-character `NULL` character (L'\0') either before or when *`count`* occurs, it converts it to an 8-bit 0 and stops. Thus, the multibyte character string at *`mbstr`* is null-terminated only if **`wcstombs`** encounters a wide-character `NULL` character during conversion. If the sequences pointed to by *`wcstr`* and *`mbstr`* overlap, the behavior of **`wcstombs`** is undefined. @@ -78,10 +78,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`wcstombs`**|``| -|**`_wcstombs_l`**|``| +| Routine | Required header | +|---|---| +| **`wcstombs`** | `` | +| **`_wcstombs_l`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/wctob.md b/docs/c-runtime-library/reference/wctob.md index 66391ed7503..948c3d9cb51 100644 --- a/docs/c-runtime-library/reference/wctob.md +++ b/docs/c-runtime-library/reference/wctob.md @@ -41,9 +41,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`wctob`**|\| +| Routine | Required header | +|---|---| +| **`wctob`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/wctomb-s-wctomb-s-l.md b/docs/c-runtime-library/reference/wctomb-s-wctomb-s-l.md index 3e496a21dbd..1d399a11863 100644 --- a/docs/c-runtime-library/reference/wctomb-s-wctomb-s-l.md +++ b/docs/c-runtime-library/reference/wctomb-s-wctomb-s-l.md @@ -55,11 +55,11 @@ Zero if successful, an error code on failure. Error Conditions -|*`mbchar`*|*`sizeInBytes`*|Return value|*`pRetValue`*| -|--------------|-------------------|------------------|-----------------| -|`NULL`|>0|`EINVAL`|not modified| -|any|>`INT_MAX`|`EINVAL`|not modified| -|any|too small|`EINVAL`|not modified| +| *`mbchar`* | *`sizeInBytes`* | Return value | *`pRetValue`* | +|---|---|---|---| +| `NULL` | >0 | `EINVAL` | not modified | +| any | >`INT_MAX` | `EINVAL` | not modified | +| any | too small | `EINVAL` | not modified | If any of the above error conditions occurs, the invalid parameter handler is invoked, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, `wctomb` returns `EINVAL` and sets `errno` to `EINVAL`. @@ -75,10 +75,10 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`wctomb_s`**|\| -|**`_wctomb_s_l`**|\| +| Routine | Required header | +|---|---| +| **`wctomb_s`** | \ | +| **`_wctomb_s_l`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/wctomb-wctomb-l.md b/docs/c-runtime-library/reference/wctomb-wctomb-l.md index ef6db6ae121..63b6c365301 100644 --- a/docs/c-runtime-library/reference/wctomb-wctomb-l.md +++ b/docs/c-runtime-library/reference/wctomb-wctomb-l.md @@ -50,9 +50,9 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`wctomb`**|\| +| Routine | Required header | +|---|---| +| **`wctomb`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/wctrans.md b/docs/c-runtime-library/reference/wctrans.md index 25ac0a3ea1c..d48a6e8f046 100644 --- a/docs/c-runtime-library/reference/wctrans.md +++ b/docs/c-runtime-library/reference/wctrans.md @@ -29,24 +29,24 @@ A string that specifies one of the valid transformations. ## Return value -If the `LC_CTYPE` category of the current locale does not define a mapping whose name matches the property string *`property`*, the function returns zero. Otherwise, it returns a nonzero value suitable for use as the second argument to a subsequent call to [`towctrans`](towctrans.md). +If the `LC_CTYPE` category of the current locale doesn't define a mapping whose name matches the property string *`property`*, the function returns zero. Otherwise, it returns a nonzero value suitable for use as the second argument to a subsequent call to [`towctrans`](towctrans.md). ## Remarks This function determines a mapping from one set of character codes to another. -The following pairs of calls have the same behavior in all locales, but it is possible to define additional mappings even in the "C" locale: +The following pairs of calls have the same behavior in all locales, but it's possible to define more mappings even in the "C" locale: -|Function|Same As| -|--------------|-------------| -|tolower(c)|towctrans(c, wctrans("towlower"))| -|towupper(c)|towctrans(c, wctrans("toupper"))| +| Function | Same As | +|---|---| +| `tolower(c)` | `towctrans(c, wctrans("towlower"))` | +| `towupper(c)` | `towctrans(c, wctrans("toupper"))` | ## Requirements -|Routine|Required Header| -|-------------|---------------------| -|**`wctrans`**|\| +| Routine | Required Header | +|---|---| +| **`wctrans`** | \ | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/wctype.md b/docs/c-runtime-library/reference/wctype.md index 83694b26ebb..220f93f1698 100644 --- a/docs/c-runtime-library/reference/wctype.md +++ b/docs/c-runtime-library/reference/wctype.md @@ -32,27 +32,27 @@ If the `LC_CTYPE` category of the current locale doesn't define a classification ## Remarks -The function determines a classification rule for wide-character codes. The following pairs of calls have the same behavior in all locales (but an implementation can define additional classification rules even in the "C" locale): - -|Function|Same as| -|--------------|-------------| -|`iswalnum(c)`|`iswctype(c, wctype( "alnum" ))`| -|`iswalpha(c)`|`iswctype(c, wctype( "alpha" ))`| -|`iswcntrl(c)`|`iswctype(c, wctype( "cntrl" ))`| -|`iswdigit(c)`|`iswctype(c, wctype( "digit" ))`| -|`iswgraph(c)`|`iswctype(c, wctype( "graph" ))`| -|`iswlower(c)`|`iswctype(c, wctype( "lower" ))`| -|`iswprint(c)`|`iswctype(c, wctype( "print" ))`| -|`iswpunct(c)`|`iswctype(c, wctype( "punct" ))`| -|`iswspace(c)`|`iswctype(c, wctype( "space" ))`| -|`iswupper(c)`|`iswctype(c, wctype( "upper" ))`| -|`iswxdigit(c)`|`iswctype(c, wctype( "xdigit" ))`| +The function determines a classification rule for wide-character codes. The following pairs of calls have the same behavior in all locales (but an implementation can define more classification rules even in the "C" locale): + +| Function | Same as | +|---|---| +| `iswalnum(c)` | `iswctype(c, wctype( "alnum" ))` | +| `iswalpha(c)` | `iswctype(c, wctype( "alpha" ))` | +| `iswcntrl(c)` | `iswctype(c, wctype( "cntrl" ))` | +| `iswdigit(c)` | `iswctype(c, wctype( "digit" ))` | +| `iswgraph(c)` | `iswctype(c, wctype( "graph" ))` | +| `iswlower(c)` | `iswctype(c, wctype( "lower" ))` | +| `iswprint(c)` | `iswctype(c, wctype( "print" ))` | +| `iswpunct(c)` | `iswctype(c, wctype( "punct" ))` | +| `iswspace(c)` | `iswctype(c, wctype( "space" ))` | +| `iswupper(c)` | `iswctype(c, wctype( "upper" ))` | +| `iswxdigit(c)` | `iswctype(c, wctype( "xdigit" ))` | ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`wctype`|``| +| Routine | Required header | +|---|---| +| **`wctype`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/write.md b/docs/c-runtime-library/reference/write.md index b6b9209f050..90903b70179 100644 --- a/docs/c-runtime-library/reference/write.md +++ b/docs/c-runtime-library/reference/write.md @@ -36,7 +36,7 @@ Number of bytes. ## Return value -If successful, **`_write`** returns the number of bytes written. If the actual space remaining on the disk is less than the size of the buffer the function is trying to write to the disk, **`_write`** fails and doesn't flush any of the buffer's contents to the disk. A return value of -1 indicates an error. If invalid parameters are passed, this function invokes the invalid parameter handler, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, the function returns -1 and `errno` is set to one of three values: `EBADF`, which means the file descriptor is invalid or the file isn't opened for writing; `ENOSPC`, which means there isn't enough space left on the device for the operation; or `EINVAL`, which means that *`buffer`* was a null pointer or that an odd *`count`* of bytes was passed to be written to a file in Unicode mode. +If successful, **`_write`** returns the number of bytes written. If the actual space remaining on the disk is less than the size of the buffer the function is trying to write to the disk, **`_write`** fails and doesn't flush any of the buffer's contents to the disk. A return value of -1 indicates an error. If invalid parameters are passed, this function invokes the invalid parameter handler, as described in [Parameter validation](../parameter-validation.md). If execution is allowed to continue, the function returns -1 and `errno` is set to one of three values: `EBADF`, which means the file descriptor is invalid or the file isn't opened for writing; `ENOSPC`, which means there isn't enough space left on the device for the operation; or `EINVAL`, which means that *`buffer`* was a null pointer, or that an odd *`count`* of bytes was passed in Unicode mode. For more information about these and other return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../errno-doserrno-sys-errlist-and-sys-nerr.md). @@ -48,15 +48,15 @@ When the file is opened in Unicode translation mode—for example, if *`fd`* is The **`_write`** function writes *`count`* bytes from *`buffer`* into the file associated with *`fd`*. The write operation begins at the current position of the file pointer (if any) associated with the given file. If the file is open for appending, the operation begins at the current end of the file. After the write operation, the file pointer is increased by the number of bytes written. -When writing to files opened in text mode, **`_write`** treats a CTRL+Z character as the logical end of file. When writing to a device, **`_write`** treats a CTRL+Z character in the buffer as an output terminator. +When it writes to files opened in text mode, **`_write`** treats a CTRL+Z character as the logical end of file. When it writes to a device, **`_write`** treats a CTRL+Z character in the buffer as an output terminator. 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). ## Requirements -|Routine|Required header| -|-------------|---------------------| -|**`_write`**|``| +| Routine | Required header | +|---|---| +| **`_write`** | `` | For more compatibility information, see [Compatibility](../compatibility.md). diff --git a/docs/c-runtime-library/reference/xor-eq.md b/docs/c-runtime-library/reference/xor-eq.md index 7c9ed72d1df..5c8ee160377 100644 --- a/docs/c-runtime-library/reference/xor-eq.md +++ b/docs/c-runtime-library/reference/xor-eq.md @@ -11,18 +11,17 @@ ms.assetid: eca4b6b4-b77a-4d44-a09a-5a7e69fdb56c --- # `xor_eq` -An alternative to the ^= operator. +An alternative to the **`^=`** operator. ## Syntax ```C - #define xor_eq ^= ``` ## Remarks -The macro yields the operator ^=. +The macro yields the operator **`^=`**. ## Example diff --git a/docs/c-runtime-library/reference/xor.md b/docs/c-runtime-library/reference/xor.md index 3a71c3041c4..44770cb21eb 100644 --- a/docs/c-runtime-library/reference/xor.md +++ b/docs/c-runtime-library/reference/xor.md @@ -11,18 +11,17 @@ ms.assetid: 0fe9554b-d87b-4487-92ed-366c6dc21df2 --- # `xor` -An alternative to the ^ operator. +An alternative to the **`^`** operator. ## Syntax ```C - #define xor ^ ``` ## Remarks -The macro yields the operator ^. +The macro yields the operator **`^`**. ## Example diff --git a/docs/c-runtime-library/required-and-optional-header-files.md b/docs/c-runtime-library/required-and-optional-header-files.md index 4aabfc96a6d..679afb54500 100644 --- a/docs/c-runtime-library/required-and-optional-header-files.md +++ b/docs/c-runtime-library/required-and-optional-header-files.md @@ -11,11 +11,11 @@ ms.assetid: f64d0bf5-e2c3-4b42-97d0-443b3d901d9f The description of each run-time routine includes a list of the required and optional include, or header (.H), files for that routine. Required header files need to be included to obtain the function declaration for the routine or a definition used by another routine called internally. Optional header files are often included to take advantage of predefined constants, type definitions, or inline macros. The following table lists some examples of optional header file contents: -|Definition|Example| -|----------------|-------------| -|Macro definition|If a library routine is implemented as a macro, the macro definition may be in a header file other than the header file for the original routine. For instance, the `_toupper` macro is defined in the header file CTYPE.H, while the function `toupper` is declared in STDLIB.H.| -|Predefined Constant|Many library routines refer to constants that are defined in header files. For instance, the `_open` routine uses constants such as `_O_CREAT`, which is defined in the header file FCNTL.H.| -|Type definition|Some library routines return a structure or take a structure as an argument. For example, stream input/output routines use a structure of type `FILE`, which is defined in STDIO.H.| +| Definition | Example | +|---|---| +| Macro definition | If a library routine is implemented as a macro, the macro definition may be in a header file other than the header file for the original routine. For instance, the `_toupper` macro is defined in the header file CTYPE.H, while the function `toupper` is declared in STDLIB.H. | +| Predefined Constant | Many library routines refer to constants that are defined in header files. For instance, the `_open` routine uses constants such as `_O_CREAT`, which is defined in the header file FCNTL.H. | +| Type definition | Some library routines return a structure or take a structure as an argument. For example, stream input/output routines use a structure of type `FILE`, which is defined in STDIO.H. | The run-time library header files provide function declarations in the ANSI/ISO C standard recommended style. The compiler performs type checking on any routine reference that occurs after its associated function declaration. Function declarations are especially important for routines that return a value of some type other than **`int`**, which is the default. Routines that don't specify their appropriate return value in their declaration will be considered by the compiler to return an **`int`**, which can cause unexpected results. For more information, see [Type checking](./type-checking-crt.md). diff --git a/docs/c-runtime-library/robustness.md b/docs/c-runtime-library/robustness.md index e2c2a9f1d7b..0ea11d6d2f0 100644 --- a/docs/c-runtime-library/robustness.md +++ b/docs/c-runtime-library/robustness.md @@ -11,12 +11,12 @@ Use the following C run-time library functions to improve the robustness of your ## Run-time robustness functions -|Function|Use| -|--------------|---------| -|[`_set_new_handler`](./reference/set-new-handler.md)|Transfers control to your error-handling mechanism if the **`new`** operator fails to allocate memory.| -|[`_set_se_translator`](./reference/set-se-translator.md)|Handles Win32 exceptions (C structured exceptions) as C++ typed exceptions.| -|[`set_terminate`](./reference/set-terminate-crt.md)|Installs your own termination function to be called by [`terminate`](./reference/terminate-crt.md).| -|[`set_unexpected`](./reference/set-unexpected-crt.md)|Installs your own termination function to be called by [`unexpected`](./reference/unexpected-crt.md).| +| Function | Use | +|---|---| +| [`_set_new_handler`](./reference/set-new-handler.md) | Transfers control to your error-handling mechanism if the **`new`** operator fails to allocate memory. | +| [`_set_se_translator`](./reference/set-se-translator.md) | Handles Win32 exceptions (C structured exceptions) as C++ typed exceptions. | +| [`set_terminate`](./reference/set-terminate-crt.md) | Installs your own termination function to be called by [`terminate`](./reference/terminate-crt.md). | +| [`set_unexpected`](./reference/set-unexpected-crt.md) | Installs your own termination function to be called by [`unexpected`](./reference/unexpected-crt.md). | ## See also diff --git a/docs/c-runtime-library/routine-mappings.md b/docs/c-runtime-library/routine-mappings.md index 8578e846eac..64d52861ae6 100644 --- a/docs/c-runtime-library/routine-mappings.md +++ b/docs/c-runtime-library/routine-mappings.md @@ -15,242 +15,242 @@ For related information, see [Generic-text mappings in tchar.h](../text/generic- ### Generic-text routine mappings -|Generic-text routine name|SBCS (`_UNICODE` & `MBCS` not defined)|`_MBCS` defined|`_UNICODE` defined| -|--------------------------------|-------------------------------------------|--------------------|-----------------------| -|`_cgetts`|`_cgets`|`_cgets`|`_cgetws`| -|`_cgetts_s`|`_cgets_s`|`_cgets_s`|`_cgetws_s`| -|`_cputts`|`_cputs`|`_cputs`|`_cputws`| -|`_fgettc`|`fgetc`|`fgetc`|`fgetwc`| -|`_fgettchar`|`_fgetchar`|`_fgetchar`|`_fgetwchar`| -|`_fgetts`|`fgets`|`fgets`|`fgetws`| -|`_fputtc`|`fputc`|`fputc`|`fputwc`| -|`_fputtchar`|`_fputchar`|`_fputchar`|`_fputwchar`| -|`_fputts`|`fputs`|`fputs`|`fputws`| -|`_ftprintf`|`fprintf`|`fprintf`|`fwprintf`| -|`_ftprintf_s`|`fprintf_s`|`fprintf_s`|`fwprintf_s`| -|`_ftscanf`|`fscanf`|`fscanf`|`fwscanf`| -|`_ftscanf_s`|`fscanf_s`|`fscanf_s`|`fwscanf_s`| -|`_gettc`|`getc`|`getc`|`getwc`| -|`_gettch`|`_getch`|`_getch`|`_getwch`| -|`_gettchar`|`getchar`|`getchar`|`getwchar`| -|`_gettche`|`_getche`|`_getche`|`_getwche`| -|`_getts`|`gets`|`gets`|`getws`| -|`_getts_s`|`gets_s`|`gets_s`|`getws_s`| -|`_istalnum`|`isalnum`|`_ismbcalnum`|`iswalnum`| -|`_istalpha`|`isalpha`|`_ismbcalpha`|`iswalpha`| -|`_istascii`|`isascii`|`isascii`|`iswascii`| -|`_istcntrl`|`iscntrl`|`iscntrl`|`iswcntrl`| -|`_istdigit`|`isdigit`|`_ismbcdigit`|`iswdigit`| -|`_istgraph`|`isgraph`|`_ismbcgraph`|`iswgraph`| -|`_istlead`|Always returns false|`_ismbblead`|Always returns false| -|`_istleadbyte`|Always returns false|`isleadbyte`|Always returns false| -|`_istlegal`|Always returns true|`_ismbclegal`|Always returns true| -|`_istlower`|`islower`|`_ismbclower`|`iswlower`| -|`_istprint`|`isprint`|`_ismbcprint`|`iswprint`| -|`_istpunct`|`ispunct`|`_ismbcpunct`|`iswpunct`| -|`_istspace`|`isspace`|`_ismbcspace`|`iswspace`| -|`_istupper`|`isupper`|`_ismbcupper`|`iswupper`| -|`_istxdigit`|`isxdigit`|`isxdigit`|`iswxdigit`| -|`_itot`|`_itoa`|`_itoa`|`_itow`| -|`_itot_s`|`_itoa_s`|`_itoa_s`|`_itow_s`| -|`_ltot`|`_ltoa`|`_ltoa`|`_ltow`| -|`_ltot_s`|`_ltoa_s`|`_ltoa_s`|`_ltow_s`| -|`_puttc`|`putc`|`putc`|`putwc`| -|`_puttch`|`_putch`|`_putch`|`_putwch`| -|`_puttchar`|`putchar`|`putchar`|`putwchar`| -|`_putts`|`puts`|`puts`|`_putws`| -|`_sctprintf`|`_scprintf`|`_scprintf`|`_scwprintf`| -|`_sntprintf`|`_snprintf`|`_snprintf`|`_snwprintf`| -|`_sntprintf_s`|`_snprintf_s`|`_snprintf_s`|`_snwprintf_s`| -|`_sntscanf`|`_snscanf`|`_snscanf`|`_snwscanf`| -|`_sntscanf_s`|`_snscanf_s`|`_snscanf_s`|`_snwscanf_s`| -|`_stprintf`|`sprintf`|`sprintf`|`swprintf`| -|`_stprintf_s`|`sprintf_s`|`sprintf_s`|`swprintf_s`| -|`_stscanf`|`sscanf`|`sscanf`|`swscanf`| -|`_stscanf_s`|`sscanf_s`|`sscanf_s`|`swscanf_s`| -|`_taccess`|`_access`|`_access`|`_waccess`| -|`_taccess_s`|`_access_s`|`_access_s`|`_waccess_s`| -|`_tasctime`|`asctime`|`asctime`|`_wasctime`| -|`_tasctime_s`|`asctime_s`|`asctime_s`|`_wasctime_s`| -|`_tccmp`|Maps to macro or inline function|`_mbsncmp`|Maps to macro or inline function| -|`_tccpy`|Maps to macro or inline function|`_mbccpy`|Maps to macro or inline function| -|`_tccpy_s`|`strcpy_s`|`_mbccpy_s`|`wcscpy_s`| -|`_tchdir`|`_chdir`|`_chdir`|`_wchdir`| -|`_tclen`|Maps to macro or inline function|`_mbclen`|Maps to macro or inline function| -|`_tchmod`|`_chmod`|`_chmod`|`_wchmod`| -|`_tcprintf`|`_cprintf`|`_cprintf`|`_cwprintf`| -|`_tcprintf_s`|`_cprintf_s`|`_cprintf_s`|`_cwprintf_s`| -|`_tcreat`|`_creat`|`_creat`|`_wcreat`| -|`_tcscanf`|`_cscanf`|`_cscanf`|`_cwscanf`| -|`_tcscanf_s`|`_cscanf_s`|`_cscanf_s`|`_cwscanf_s`| -|`_tcscat`|`strcat`|`_mbscat`|`wcscat`| -|`_tcscat_s`|`strcat_s`|`_mbscat_s`|`wcscat_s`| -|`_tcschr`|`strchr`|`_mbschr`|`wcschr`| -|`_tcsclen`|`strlen`|`_mbslen`|`wcslen`| -|`_tcsclen_s`|`strlen_s`|`_mbslen_s`|`wcslen_s`| -|`_tcscmp`|`strcmp`|`_mbscmp`|`wcscmp`| -|`_tcscoll`|`strcoll`|`_mbscoll`|`wcscoll`| -|`_tcscpy`|`strcpy`|`_mbscpy`|`wcscpy`| -|`_tcscpy_s`|`strcpy_s`|`_mbscpy_s`|`wcscpy_s`| -|`_tcscspn`|`strcspn`|`_mbscspn`|`wcscspn`| -|`_tcsdec`|`_strdec`|`_mbsdec`|`_wcsdec`| -|`_tcsdup`|`_strdup`|`_mbsdup`|`_wcsdup`| -|`_tcserror`|`strerror`|`strerror`|`_wcserror`| -|`_tcserror_s`|`strerror_s`|`strerror_s`|`_wcserror_s`| -|`_tcsftime`|`strftime`|`strftime`|`wcsftime`| -|`_tcsicmp`|`_stricmp`|`_mbsicmp`|`_wcsicmp`| -|`_tcsicoll`|`_stricoll`|`_mbsicoll`|`_wcsicoll`| -|`_tcsinc`|`_strinc`|`_mbsinc`|`_wcsinc`| -|`_tcslen`|`strlen`|`strlen`|`wcslen`| -|`_tcslwr`|`_strlwr`|`_mbslwr`|`_wcslwr`| -|`_tcslwr_s`|`_strlwr_s`|`_mbslwr_s`|`_wcslwr_s`| -|`_tcsnbcnt`|`_strncnt`|`_mbsnbcnt`|`_wcsncnt`| -|`_tcsncat`|`strncat`|`_mbsnbcat`|`wcsncat`| -|`_tcsncat_s`|`strncat_s`|`_mbsnbcat_s`|`wcsncat_s`| -|`_tcsnccat`|`strncat`|`_mbsncat`|`wcsncat`| -|`_tcsnccmp`|`strncmp`|`_mbsncmp`|`wcsncmp`| -|`_tcsnccmp_s`|`strncmp_s`|`_mbsncmp_s`|`wcsncmp_s`| -|`_tcsnccoll`|`_strncoll`|`_mbsncoll`|`_wcsncoll`| -|`_tcsncmp`|`strncmp`|`_mbsnbcmp`|`wcsncmp`| -|`_tcsnccnt`|`_strncnt`|`_mbsnccnt`|`_wcsncnt`| -|`_tcsnccpy`|`strncpy`|`_mbsncpy`|`wcsncpy`| -|`_tcsnccpy_s`|`strncpy_s`|`_mbsncpy_s`|`wcsncpy_s`| -|`_tcsncicmp`|`_strnicmp`|`_mbsnicmp`|`_wcsnicmp`| -|`_tcsncicoll`|`_strnicoll`|`_mbsnicoll`|`_wcsnicoll`| -|`_tcsncpy`|`strncpy`|`_mbsnbcpy`|`wcsncpy`| -|`_tcsncpy_s`|`strncpy_s`|`_mbsnbcpy_s`|`wcsncpy_s`| -|`_tcsncset`|`_strnset`|`_mbsnset`|`_wcsnset`| -|`_tcsnextc`|`_strnextc`|`_mbsnextc`|`_wcsnextc`| -|`_tcsnicmp`|`_strnicmp`|`_mbsnbicmp`|`_wcsnicmp`| -|`_tcsnicoll`|`_strnicoll`|`_mbsnbicoll`|`_wcsnicoll`| -|`_tcsninc`|`_strninc`|`_mbsninc`|`_wcsninc`| -|`_tcsnccnt`|`_strncnt`|`_mbsnccnt`|`_wcsncnt`| -|`_tcsnset`|`_strnset`|`_mbsnbset`|`_wcsnset`| -|`_tcspbrk`|`strpbrk`|`_mbspbrk`|`wcspbrk`| -|`_tcsspnp`|`_strspnp`|`_mbsspnp`|`_wcsspnp`| -|`_tcsrchr`|`strrchr`|`_mbsrchr`|`wcsrchr`| -|`_tcsrev`|`_strrev`|`_mbsrev`|`_wcsrev`| -|`_tcsset`|`_strset`|`_mbsset`|`_wcsset`| -|`_tcsspn`|`strspn`|`_mbsspn`|`wcsspn`| -|`_tcsstr`|`strstr`|`_mbsstr`|`wcsstr`| -|`_tcstod`|`strtod`|`strtod`|`wcstod`| -|`_tcstoi64`|`_strtoi64`|`_strtoi64`|`_wcstoi64`| -|`_tcstok`|`strtok`|`_mbstok`|`wcstok`| -|`_tcstok_s`|`strtok_s`|`_mbstok_s`|`wcstok_s`| -|`_tcstol`|`strtol`|`strtol`|`wcstol`| -|`_tcstoui64`|`_strtoui64`|`_strtoui64`|`_wcstoui64`| -|`_tcstoul`|`strtoul`|`strtoul`|`wcstoul`| -|`_tcsupr`|`_strupr`|`_mbsupr`|`_wcsupr`| -|`_tcsupr_s`|`_strupr_s`|`_mbsupr_s`|`_wcsupr_s`| -|`_tcsxfrm`|`strxfrm`|`strxfrm`|`wcsxfrm`| -|`_tctime`|`ctime`|`ctime`|`_wctime`| -|`_tctime_s`|`ctime_s`|`ctime_s`|`_wctime_s`| -|`_tctime32`|`_ctime32`|`_ctime32`|`_wctime32`| -|`_tctime32_s`|`_ctime32_s`|`_ctime32_s`|`_wctime32_s`| -|`_tctime64`|`_ctime64`|`_ctime64`|`_wctime64`| -|`_tctime64_s`|`_ctime64_s`|`_ctime64_s`|`_wctime64_s`| -|`_texecl`|`_execl`|`_execl`|`_wexecl`| -|`_texecle`|`_execle`|`_execle`|`_wexecle`| -|`_texeclp`|`_execlp`|`_execlp`|`_wexeclp`| -|`_texeclpe`|`_execlpe`|`_execlpe`|`_wexeclpe`| -|`_texecv`|`_execv`|`_execv`|`_wexecv`| -|`_texecve`|`_execve`|`_execve`|`_wexecve`| -|`_texecvp`|`_execvp`|`_execvp`|`_wexecvp`| -|`_texecvpe`|`_execvpe`|`_execvpe`|`_wexecvpe`| -|`_tfdopen`|`_fdopen`|`_fdopen`|`_wfdopen`| -|`_tfindfirst`|`_findfirst`|`_findfirst`|`_wfindfirst`| -|`_tfindnext`|`_findnext`|`_findnext`|`_wfindnext`| -|`_tfindnext32`|`_findnext32`|`_findnext32`|`_wfindnext32`| -|`_tfindnext64`|`_findnext64`|`_findnext64`|`_wfindnext64`| -|`_tfindnexti64`|`_findnexti64`|`_findnexti64`|`_wfindnexti64`| -|`_tfindnexti6432`|`_findnexti6432`|`_findnexti6432`|`_wfindnexti6432`| -|`_tfindnext32i64`|`_findnext32i64`|`_findnext32i64`|`_wfindnext32i64`| -|`_tfopen`|`fopen`|`fopen`|`_wfopen`| -|`_tfopen_s`|`fopen_s`|`fopen_s`|`_wfopen_s`| -|`_tfreopen`|`freopen`|`freopen`|`_wfreopen`| -|`_tfreopen_s`|`freopen_s`|`freopen_s`|`_wfreopen_s`| -|`_tfsopen`|`_fsopen`|`_fsopen`|`_wfsopen`| -|`_tfullpath`|`_fullpath`|`_fullpath`|`_wfullpath`| -|`_tgetcwd`|`_getcwd`|`_getcwd`|`_wgetcwd`| -|`_tgetdcwd`|`_getdcwd`|`_getdcwd`|`_wgetdcwd`| -|`_tgetenv`|`getenv`|`getenv`|`_wgetenv`| -|`_tgetenv_s`|`getenv_s`|`getenv_s`|`_wgetenv_s`| -|`_tmain`|`main`|`main`|`wmain`| -|`_tmakepath`|`_makepath`|`_makepath`|`_wmakepath`| -|`_tmakepath_s`|`_makepath_s`|`_makepath_s`|`_wmakepath_s`| -|`_tmkdir`|`_mkdir`|`_mkdir`|`_wmkdir`| -|`_tmktemp`|`_mktemp`|`_mktemp`|`_wmktemp`| -|`_tmktemp_s`|`_mktemp_s`|`_mktemp_s`|`_wmktemp_s`| -|`_topen`|`_open`|`_open`|`_wopen`| -|`_topen_s`|`_open_s`|`_open_s`|`_wopen_s`| -|`_totlower`|`tolower`|`_mbctolower`|`towlower`| -|`_totupper`|`toupper`|`_mbctoupper`|`towupper`| -|`_tperror`|`perror`|`perror`|`_wperror`| -|`_tpopen`|`_popen`|`_popen`|`_wpopen`| -|`_tprintf`|`printf`|`printf`|`wprintf`| -|`_tprintf_s`|`printf_s`|`printf_s`|`wprintf_s`| -|`_tputenv`|`_putenv`|`_putenv`|`_wputenv`| -|`_tputenv_s`|`_putenv_s`|`_putenv_s`|`_wputenv_s`| -|`_tremove`|`remove`|`remove`|`_wremove`| -|`_trename`|`rename`|`rename`|`_wrename`| -|`_trmdir`|`_rmdir`|`_rmdir`|`_wrmdir`| -|`_tsearchenv`|`_searchenv`|`_searchenv`|`_wsearchenv`| -|`_tsearchenv_s`|`_searchenv_s`|`_searchenv_s`|`_wsearchenv_s`| -|`_tscanf`|`scanf`|`scanf`|`wscanf`| -|`_tscanf_s`|`scanf_s`|`scanf_s`|`wscanf_s`| -|`_tsetlocale`|`setlocale`|`setlocale`|`_wsetlocale`| -|`_tsopen`|`_sopen`|`_sopen`|`_wsopen`| -|`_tsopen_s`|`_sopen_s`|`_sopen_s`|`_wsopen_s`| -|`_tspawnl`|`_spawnl`|`_spawnl`|`_wspawnl`| -|`_tspawnle`|`_spawnle`|`_spawnle`|`_wspawnle`| -|`_tspawnlp`|`_spawnlp`|`_spawnlp`|`_wspawnlp`| -|`_tspawnlpe`|`_spawnlpe`|`_spawnlpe`|`_wspawnlpe`| -|`_tspawnv`|`_spawnv`|`_spawnv`|`_wspawnv`| -|`_tspawnve`|`_spawnve`|`_spawnve`|`_wspawnve`| -|`_tspawnvp`|`_spawnvp`|`_spawnvp`|`_wspawnvp`| -|`_tspawnvpe`|`_spawnvpe`|`_spawnvpe`|`_wspawnvpe`| -|`_tsplitpath`|`_splitpath`|`_splitpath`|`_wsplitpath`| -|`_tstat`|`_stat`|`_stat`|`_wstat`| -|`_tstat32`|`_stat32`|`_stat32`|`_wstat32`| -|`_tstati32`|`_stati32`|`_stati32`|`_wstati32`| -|`_tstat64`|`_stat64`|`_stat64`|`_wstat64`| -|`_tstati64`|`_stati64`|`_stati64`|`_wstati64`| -|`_tstof`|`atof`|`atof`|`_wtof`| -|`_tstoi`|`atoi`|`atoi`|`_wtoi`| -|`_tstoi64`|`_atoi64`|`_atoi64`|`_wtoi64`| -|`_tstol`|`atol`|`atol`|`_wtol`| -|`_tstrdate`|`_strdate`|`_strdate`|`_wstrdate`| -|`_tstrdate_s`|`_strdate_s`|`_strdate_s`|`_wstrdate_s`| -|`_tstrtime`|`_strtime`|`_strtime`|`_wstrtime`| -|`_tstrtime_s`|`_strtime_s`|`_strtime_s`|`_wstrtime_s`| -|`_tsystem`|`system`|`system`|`_wsystem`| -|`_ttempnam`|`_tempnam`|`_tempnam`|`_wtempnam`| -|`_ttmpnam`|`tmpnam`|`tmpnam`|`_wtmpnam`| -|`_ttmpnam_s`|`tmpnam_s`|`tmpnam_s`|`_wtmpnam_s`| -|`_ttoi`|`atoi`|`atoi`|`_wtoi`| -|`_ttoi64`|`_atoi64`|`_atoi64`|`_wtoi64`| -|`_ttol`|`atol`|`atol`|`_wtol`| -|`_tunlink`|`_unlink`|`_unlink`|`_wunlink`| -|`_tutime`|`_utime`|`_utime`|`_wutime`| -|`_tutime32`|`_utime32`|`_utime32`|`_wutime32`| -|`_tutime64`|`_utime64`|`_utime64`|`_wutime64`| -|`_tWinMain`|`WinMain`|`WinMain`|`wWinMain`| -|`_ui64tot`|`_ui64toa`|`_ui64toa`|`_ui64tow`| -|`_ui64tot_s`|`_ui64toa_s`|`_ui64toa_s`|`_ui64tow_s`| -|`_ultot`|`_ultoa`|`_ultoa`|`_ultow`| -|`_ultot_s`|`_ultoa_s`|`_ultoa_s`|`_ultow_s`| -|`_ungettc`|`ungetc`|`ungetc`|`ungetwc`| -|`_ungettch`|`_ungetch`|`_ungetch`|`_ungetwch`| -|`_vftprintf`|`vfprintf`|`vfprintf`|`vfwprintf`| -|`_vftprintf_s`|`vfprintf_s`|`vfprintf_s`|`vfwprintf_S`| -|`_vsctprintf`|`_vscprintf`|`_vscprintf`|`_vscwprintf`| -|`_vsctprintf_s`|`_vscprintf_s`|`_vscprintf_s`|`_vscwprintf_S`| -|`_vsntprintf`|`_vsnprintf`|`_vsnprintf`|`_vsnwprintf`| -|`_vsntprintf_s`|`_vsnprintf_s`|`_vsnprintf_s`|`_vsnwprintf_s`| -|`_vstprintf`|`vsprintf`|`vsprintf`|`vswprintf`| -|`_vstprintf_s`|`vsprintf_s`|`vsprintf_s`|`vswprintf_s`| -|`_vtprintf`|`vprintf`|`vprintf`|`vwprintf`| -|`_vtprintf_s`|`vprintf_s`|`vprintf_s`|`vwprintf_s`| +| Generic-text routine name | `SBCS` (`_UNICODE` and `MBCS` not defined) | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_cgetts` | `_cgets` | `_cgets` | `_cgetws` | +| `_cgetts_s` | `_cgets_s` | `_cgets_s` | `_cgetws_s` | +| `_cputts` | `_cputs` | `_cputs` | `_cputws` | +| `_fgettc` | `fgetc` | `fgetc` | `fgetwc` | +| `_fgettchar` | `_fgetchar` | `_fgetchar` | `_fgetwchar` | +| `_fgetts` | `fgets` | `fgets` | `fgetws` | +| `_fputtc` | `fputc` | `fputc` | `fputwc` | +| `_fputtchar` | `_fputchar` | `_fputchar` | `_fputwchar` | +| `_fputts` | `fputs` | `fputs` | `fputws` | +| `_ftprintf` | `fprintf` | `fprintf` | `fwprintf` | +| `_ftprintf_s` | `fprintf_s` | `fprintf_s` | `fwprintf_s` | +| `_ftscanf` | `fscanf` | `fscanf` | `fwscanf` | +| `_ftscanf_s` | `fscanf_s` | `fscanf_s` | `fwscanf_s` | +| `_gettc` | `getc` | `getc` | `getwc` | +| `_gettch` | `_getch` | `_getch` | `_getwch` | +| `_gettchar` | `getchar` | `getchar` | `getwchar` | +| `_gettche` | `_getche` | `_getche` | `_getwche` | +| `_getts` | `gets` | `gets` | `getws` | +| `_getts_s` | `gets_s` | `gets_s` | `getws_s` | +| `_istalnum` | `isalnum` | `_ismbcalnum` | `iswalnum` | +| `_istalpha` | `isalpha` | `_ismbcalpha` | `iswalpha` | +| `_istascii` | `isascii` | `isascii` | `iswascii` | +| `_istcntrl` | `iscntrl` | `iscntrl` | `iswcntrl` | +| `_istdigit` | `isdigit` | `_ismbcdigit` | `iswdigit` | +| `_istgraph` | `isgraph` | `_ismbcgraph` | `iswgraph` | +| `_istlead` | Always returns false | `_ismbblead` | Always returns false | +| `_istleadbyte` | Always returns false | `isleadbyte` | Always returns false | +| `_istlegal` | Always returns true | `_ismbclegal` | Always returns true | +| `_istlower` | `islower` | `_ismbclower` | `iswlower` | +| `_istprint` | `isprint` | `_ismbcprint` | `iswprint` | +| `_istpunct` | `ispunct` | `_ismbcpunct` | `iswpunct` | +| `_istspace` | `isspace` | `_ismbcspace` | `iswspace` | +| `_istupper` | `isupper` | `_ismbcupper` | `iswupper` | +| `_istxdigit` | `isxdigit` | `isxdigit` | `iswxdigit` | +| `_itot` | `_itoa` | `_itoa` | `_itow` | +| `_itot_s` | `_itoa_s` | `_itoa_s` | `_itow_s` | +| `_ltot` | `_ltoa` | `_ltoa` | `_ltow` | +| `_ltot_s` | `_ltoa_s` | `_ltoa_s` | `_ltow_s` | +| `_puttc` | `putc` | `putc` | `putwc` | +| `_puttch` | `_putch` | `_putch` | `_putwch` | +| `_puttchar` | `putchar` | `putchar` | `putwchar` | +| `_putts` | `puts` | `puts` | `_putws` | +| `_sctprintf` | `_scprintf` | `_scprintf` | `_scwprintf` | +| `_sntprintf` | `_snprintf` | `_snprintf` | `_snwprintf` | +| `_sntprintf_s` | `_snprintf_s` | `_snprintf_s` | `_snwprintf_s` | +| `_sntscanf` | `_snscanf` | `_snscanf` | `_snwscanf` | +| `_sntscanf_s` | `_snscanf_s` | `_snscanf_s` | `_snwscanf_s` | +| `_stprintf` | `sprintf` | `sprintf` | `swprintf` | +| `_stprintf_s` | `sprintf_s` | `sprintf_s` | `swprintf_s` | +| `_stscanf` | `sscanf` | `sscanf` | `swscanf` | +| `_stscanf_s` | `sscanf_s` | `sscanf_s` | `swscanf_s` | +| `_taccess` | `_access` | `_access` | `_waccess` | +| `_taccess_s` | `_access_s` | `_access_s` | `_waccess_s` | +| `_tasctime` | `asctime` | `asctime` | `_wasctime` | +| `_tasctime_s` | `asctime_s` | `asctime_s` | `_wasctime_s` | +| `_tccmp` | Maps to macro or inline function | `_mbsncmp` | Maps to macro or inline function | +| `_tccpy` | Maps to macro or inline function | `_mbccpy` | Maps to macro or inline function | +| `_tccpy_s` | `strcpy_s` | `_mbccpy_s` | `wcscpy_s` | +| `_tchdir` | `_chdir` | `_chdir` | `_wchdir` | +| `_tclen` | Maps to macro or inline function | `_mbclen` | Maps to macro or inline function | +| `_tchmod` | `_chmod` | `_chmod` | `_wchmod` | +| `_tcprintf` | `_cprintf` | `_cprintf` | `_cwprintf` | +| `_tcprintf_s` | `_cprintf_s` | `_cprintf_s` | `_cwprintf_s` | +| `_tcreat` | `_creat` | `_creat` | `_wcreat` | +| `_tcscanf` | `_cscanf` | `_cscanf` | `_cwscanf` | +| `_tcscanf_s` | `_cscanf_s` | `_cscanf_s` | `_cwscanf_s` | +| `_tcscat` | `strcat` | `_mbscat` | `wcscat` | +| `_tcscat_s` | `strcat_s` | `_mbscat_s` | `wcscat_s` | +| `_tcschr` | `strchr` | `_mbschr` | `wcschr` | +| `_tcsclen` | `strlen` | `_mbslen` | `wcslen` | +| `_tcsclen_s` | `strlen_s` | `_mbslen_s` | `wcslen_s` | +| `_tcscmp` | `strcmp` | `_mbscmp` | `wcscmp` | +| `_tcscoll` | `strcoll` | `_mbscoll` | `wcscoll` | +| `_tcscpy` | `strcpy` | `_mbscpy` | `wcscpy` | +| `_tcscpy_s` | `strcpy_s` | `_mbscpy_s` | `wcscpy_s` | +| `_tcscspn` | `strcspn` | `_mbscspn` | `wcscspn` | +| `_tcsdec` | `_strdec` | `_mbsdec` | `_wcsdec` | +| `_tcsdup` | `_strdup` | `_mbsdup` | `_wcsdup` | +| `_tcserror` | `strerror` | `strerror` | `_wcserror` | +| `_tcserror_s` | `strerror_s` | `strerror_s` | `_wcserror_s` | +| `_tcsftime` | `strftime` | `strftime` | `wcsftime` | +| `_tcsicmp` | `_stricmp` | `_mbsicmp` | `_wcsicmp` | +| `_tcsicoll` | `_stricoll` | `_mbsicoll` | `_wcsicoll` | +| `_tcsinc` | `_strinc` | `_mbsinc` | `_wcsinc` | +| `_tcslen` | `strlen` | `strlen` | `wcslen` | +| `_tcslwr` | `_strlwr` | `_mbslwr` | `_wcslwr` | +| `_tcslwr_s` | `_strlwr_s` | `_mbslwr_s` | `_wcslwr_s` | +| `_tcsnbcnt` | `_strncnt` | `_mbsnbcnt` | `_wcsncnt` | +| `_tcsncat` | `strncat` | `_mbsnbcat` | `wcsncat` | +| `_tcsncat_s` | `strncat_s` | `_mbsnbcat_s` | `wcsncat_s` | +| `_tcsnccat` | `strncat` | `_mbsncat` | `wcsncat` | +| `_tcsnccmp` | `strncmp` | `_mbsncmp` | `wcsncmp` | +| `_tcsnccmp_s` | `strncmp_s` | `_mbsncmp_s` | `wcsncmp_s` | +| `_tcsnccoll` | `_strncoll` | `_mbsncoll` | `_wcsncoll` | +| `_tcsncmp` | `strncmp` | `_mbsnbcmp` | `wcsncmp` | +| `_tcsnccnt` | `_strncnt` | `_mbsnccnt` | `_wcsncnt` | +| `_tcsnccpy` | `strncpy` | `_mbsncpy` | `wcsncpy` | +| `_tcsnccpy_s` | `strncpy_s` | `_mbsncpy_s` | `wcsncpy_s` | +| `_tcsncicmp` | `_strnicmp` | `_mbsnicmp` | `_wcsnicmp` | +| `_tcsncicoll` | `_strnicoll` | `_mbsnicoll` | `_wcsnicoll` | +| `_tcsncpy` | `strncpy` | `_mbsnbcpy` | `wcsncpy` | +| `_tcsncpy_s` | `strncpy_s` | `_mbsnbcpy_s` | `wcsncpy_s` | +| `_tcsncset` | `_strnset` | `_mbsnset` | `_wcsnset` | +| `_tcsnextc` | `_strnextc` | `_mbsnextc` | `_wcsnextc` | +| `_tcsnicmp` | `_strnicmp` | `_mbsnbicmp` | `_wcsnicmp` | +| `_tcsnicoll` | `_strnicoll` | `_mbsnbicoll` | `_wcsnicoll` | +| `_tcsninc` | `_strninc` | `_mbsninc` | `_wcsninc` | +| `_tcsnccnt` | `_strncnt` | `_mbsnccnt` | `_wcsncnt` | +| `_tcsnset` | `_strnset` | `_mbsnbset` | `_wcsnset` | +| `_tcspbrk` | `strpbrk` | `_mbspbrk` | `wcspbrk` | +| `_tcsspnp` | `_strspnp` | `_mbsspnp` | `_wcsspnp` | +| `_tcsrchr` | `strrchr` | `_mbsrchr` | `wcsrchr` | +| `_tcsrev` | `_strrev` | `_mbsrev` | `_wcsrev` | +| `_tcsset` | `_strset` | `_mbsset` | `_wcsset` | +| `_tcsspn` | `strspn` | `_mbsspn` | `wcsspn` | +| `_tcsstr` | `strstr` | `_mbsstr` | `wcsstr` | +| `_tcstod` | `strtod` | `strtod` | `wcstod` | +| `_tcstoi64` | `_strtoi64` | `_strtoi64` | `_wcstoi64` | +| `_tcstok` | `strtok` | `_mbstok` | `wcstok` | +| `_tcstok_s` | `strtok_s` | `_mbstok_s` | `wcstok_s` | +| `_tcstol` | `strtol` | `strtol` | `wcstol` | +| `_tcstoui64` | `_strtoui64` | `_strtoui64` | `_wcstoui64` | +| `_tcstoul` | `strtoul` | `strtoul` | `wcstoul` | +| `_tcsupr` | `_strupr` | `_mbsupr` | `_wcsupr` | +| `_tcsupr_s` | `_strupr_s` | `_mbsupr_s` | `_wcsupr_s` | +| `_tcsxfrm` | `strxfrm` | `strxfrm` | `wcsxfrm` | +| `_tctime` | `ctime` | `ctime` | `_wctime` | +| `_tctime_s` | `ctime_s` | `ctime_s` | `_wctime_s` | +| `_tctime32` | `_ctime32` | `_ctime32` | `_wctime32` | +| `_tctime32_s` | `_ctime32_s` | `_ctime32_s` | `_wctime32_s` | +| `_tctime64` | `_ctime64` | `_ctime64` | `_wctime64` | +| `_tctime64_s` | `_ctime64_s` | `_ctime64_s` | `_wctime64_s` | +| `_texecl` | `_execl` | `_execl` | `_wexecl` | +| `_texecle` | `_execle` | `_execle` | `_wexecle` | +| `_texeclp` | `_execlp` | `_execlp` | `_wexeclp` | +| `_texeclpe` | `_execlpe` | `_execlpe` | `_wexeclpe` | +| `_texecv` | `_execv` | `_execv` | `_wexecv` | +| `_texecve` | `_execve` | `_execve` | `_wexecve` | +| `_texecvp` | `_execvp` | `_execvp` | `_wexecvp` | +| `_texecvpe` | `_execvpe` | `_execvpe` | `_wexecvpe` | +| `_tfdopen` | `_fdopen` | `_fdopen` | `_wfdopen` | +| `_tfindfirst` | `_findfirst` | `_findfirst` | `_wfindfirst` | +| `_tfindnext` | `_findnext` | `_findnext` | `_wfindnext` | +| `_tfindnext32` | `_findnext32` | `_findnext32` | `_wfindnext32` | +| `_tfindnext64` | `_findnext64` | `_findnext64` | `_wfindnext64` | +| `_tfindnexti64` | `_findnexti64` | `_findnexti64` | `_wfindnexti64` | +| `_tfindnexti6432` | `_findnexti6432` | `_findnexti6432` | `_wfindnexti6432` | +| `_tfindnext32i64` | `_findnext32i64` | `_findnext32i64` | `_wfindnext32i64` | +| `_tfopen` | `fopen` | `fopen` | `_wfopen` | +| `_tfopen_s` | `fopen_s` | `fopen_s` | `_wfopen_s` | +| `_tfreopen` | `freopen` | `freopen` | `_wfreopen` | +| `_tfreopen_s` | `freopen_s` | `freopen_s` | `_wfreopen_s` | +| `_tfsopen` | `_fsopen` | `_fsopen` | `_wfsopen` | +| `_tfullpath` | `_fullpath` | `_fullpath` | `_wfullpath` | +| `_tgetcwd` | `_getcwd` | `_getcwd` | `_wgetcwd` | +| `_tgetdcwd` | `_getdcwd` | `_getdcwd` | `_wgetdcwd` | +| `_tgetenv` | `getenv` | `getenv` | `_wgetenv` | +| `_tgetenv_s` | `getenv_s` | `getenv_s` | `_wgetenv_s` | +| `_tmain` | `main` | `main` | `wmain` | +| `_tmakepath` | `_makepath` | `_makepath` | `_wmakepath` | +| `_tmakepath_s` | `_makepath_s` | `_makepath_s` | `_wmakepath_s` | +| `_tmkdir` | `_mkdir` | `_mkdir` | `_wmkdir` | +| `_tmktemp` | `_mktemp` | `_mktemp` | `_wmktemp` | +| `_tmktemp_s` | `_mktemp_s` | `_mktemp_s` | `_wmktemp_s` | +| `_topen` | `_open` | `_open` | `_wopen` | +| `_topen_s` | `_open_s` | `_open_s` | `_wopen_s` | +| `_totlower` | `tolower` | `_mbctolower` | `towlower` | +| `_totupper` | `toupper` | `_mbctoupper` | `towupper` | +| `_tperror` | `perror` | `perror` | `_wperror` | +| `_tpopen` | `_popen` | `_popen` | `_wpopen` | +| `_tprintf` | `printf` | `printf` | `wprintf` | +| `_tprintf_s` | `printf_s` | `printf_s` | `wprintf_s` | +| `_tputenv` | `_putenv` | `_putenv` | `_wputenv` | +| `_tputenv_s` | `_putenv_s` | `_putenv_s` | `_wputenv_s` | +| `_tremove` | `remove` | `remove` | `_wremove` | +| `_trename` | `rename` | `rename` | `_wrename` | +| `_trmdir` | `_rmdir` | `_rmdir` | `_wrmdir` | +| `_tsearchenv` | `_searchenv` | `_searchenv` | `_wsearchenv` | +| `_tsearchenv_s` | `_searchenv_s` | `_searchenv_s` | `_wsearchenv_s` | +| `_tscanf` | `scanf` | `scanf` | `wscanf` | +| `_tscanf_s` | `scanf_s` | `scanf_s` | `wscanf_s` | +| `_tsetlocale` | `setlocale` | `setlocale` | `_wsetlocale` | +| `_tsopen` | `_sopen` | `_sopen` | `_wsopen` | +| `_tsopen_s` | `_sopen_s` | `_sopen_s` | `_wsopen_s` | +| `_tspawnl` | `_spawnl` | `_spawnl` | `_wspawnl` | +| `_tspawnle` | `_spawnle` | `_spawnle` | `_wspawnle` | +| `_tspawnlp` | `_spawnlp` | `_spawnlp` | `_wspawnlp` | +| `_tspawnlpe` | `_spawnlpe` | `_spawnlpe` | `_wspawnlpe` | +| `_tspawnv` | `_spawnv` | `_spawnv` | `_wspawnv` | +| `_tspawnve` | `_spawnve` | `_spawnve` | `_wspawnve` | +| `_tspawnvp` | `_spawnvp` | `_spawnvp` | `_wspawnvp` | +| `_tspawnvpe` | `_spawnvpe` | `_spawnvpe` | `_wspawnvpe` | +| `_tsplitpath` | `_splitpath` | `_splitpath` | `_wsplitpath` | +| `_tstat` | `_stat` | `_stat` | `_wstat` | +| `_tstat32` | `_stat32` | `_stat32` | `_wstat32` | +| `_tstati32` | `_stati32` | `_stati32` | `_wstati32` | +| `_tstat64` | `_stat64` | `_stat64` | `_wstat64` | +| `_tstati64` | `_stati64` | `_stati64` | `_wstati64` | +| `_tstof` | `atof` | `atof` | `_wtof` | +| `_tstoi` | `atoi` | `atoi` | `_wtoi` | +| `_tstoi64` | `_atoi64` | `_atoi64` | `_wtoi64` | +| `_tstol` | `atol` | `atol` | `_wtol` | +| `_tstrdate` | `_strdate` | `_strdate` | `_wstrdate` | +| `_tstrdate_s` | `_strdate_s` | `_strdate_s` | `_wstrdate_s` | +| `_tstrtime` | `_strtime` | `_strtime` | `_wstrtime` | +| `_tstrtime_s` | `_strtime_s` | `_strtime_s` | `_wstrtime_s` | +| `_tsystem` | `system` | `system` | `_wsystem` | +| `_ttempnam` | `_tempnam` | `_tempnam` | `_wtempnam` | +| `_ttmpnam` | `tmpnam` | `tmpnam` | `_wtmpnam` | +| `_ttmpnam_s` | `tmpnam_s` | `tmpnam_s` | `_wtmpnam_s` | +| `_ttoi` | `atoi` | `atoi` | `_wtoi` | +| `_ttoi64` | `_atoi64` | `_atoi64` | `_wtoi64` | +| `_ttol` | `atol` | `atol` | `_wtol` | +| `_tunlink` | `_unlink` | `_unlink` | `_wunlink` | +| `_tutime` | `_utime` | `_utime` | `_wutime` | +| `_tutime32` | `_utime32` | `_utime32` | `_wutime32` | +| `_tutime64` | `_utime64` | `_utime64` | `_wutime64` | +| `_tWinMain` | `WinMain` | `WinMain` | `wWinMain` | +| `_ui64tot` | `_ui64toa` | `_ui64toa` | `_ui64tow` | +| `_ui64tot_s` | `_ui64toa_s` | `_ui64toa_s` | `_ui64tow_s` | +| `_ultot` | `_ultoa` | `_ultoa` | `_ultow` | +| `_ultot_s` | `_ultoa_s` | `_ultoa_s` | `_ultow_s` | +| `_ungettc` | `ungetc` | `ungetc` | `ungetwc` | +| `_ungettch` | `_ungetch` | `_ungetch` | `_ungetwch` | +| `_vftprintf` | `vfprintf` | `vfprintf` | `vfwprintf` | +| `_vftprintf_s` | `vfprintf_s` | `vfprintf_s` | `vfwprintf_S` | +| `_vsctprintf` | `_vscprintf` | `_vscprintf` | `_vscwprintf` | +| `_vsctprintf_s` | `_vscprintf_s` | `_vscprintf_s` | `_vscwprintf_S` | +| `_vsntprintf` | `_vsnprintf` | `_vsnprintf` | `_vsnwprintf` | +| `_vsntprintf_s` | `_vsnprintf_s` | `_vsnprintf_s` | `_vsnwprintf_s` | +| `_vstprintf` | `vsprintf` | `vsprintf` | `vswprintf` | +| `_vstprintf_s` | `vsprintf_s` | `vsprintf_s` | `vswprintf_s` | +| `_vtprintf` | `vprintf` | `vprintf` | `vwprintf` | +| `_vtprintf_s` | `vprintf_s` | `vprintf_s` | `vwprintf_s` | ## See also diff --git a/docs/c-runtime-library/rtdynamiccast.md b/docs/c-runtime-library/rtdynamiccast.md index 52789cabef4..5ce4a7e3214 100644 --- a/docs/c-runtime-library/rtdynamiccast.md +++ b/docs/c-runtime-library/rtdynamiccast.md @@ -57,6 +57,6 @@ Converts `inptr` to an object of type `TargetType`. The type of `inptr` must be ## Requirements -|Routine|Required header| -|-------------|---------------------| -|__RTDynamicCast|rtti.h| +| Routine | Required header | +|---|---| +| **`__RTDynamicCast`** | `` | diff --git a/docs/c-runtime-library/run-time-error-checking.md b/docs/c-runtime-library/run-time-error-checking.md index 4cbb2c4063e..29ce32a4e13 100644 --- a/docs/c-runtime-library/run-time-error-checking.md +++ b/docs/c-runtime-library/run-time-error-checking.md @@ -12,12 +12,12 @@ Use the following functions to customize the way your program does runtime error ## Runtime error checking functions -|Function|Use| -|--------------|---------| -|[`_RTC_GetErrDesc`](./reference/rtc-geterrdesc.md)|Returns a brief description of a runtime error check type.| -|[`_RTC_NumErrors`](./reference/rtc-numerrors.md)|Returns the total number of errors that can be detected by runtime error checks.| -|[`_RTC_SetErrorFunc`](./reference/rtc-seterrorfunc.md)|Designates a function as the handler for reporting runtime error checks.| -|[`_RTC_SetErrorType`](./reference/rtc-seterrortype.md)|Associates an error that is detected by runtime error checks with a type.| +| Function | Use | +|---|---| +| [`_RTC_GetErrDesc`](./reference/rtc-geterrdesc.md) | Returns a brief description of a runtime error check type. | +| [`_RTC_NumErrors`](./reference/rtc-numerrors.md) | Returns the total number of errors that can be detected by runtime error checks. | +| [`_RTC_SetErrorFunc`](./reference/rtc-seterrorfunc.md) | Designates a function as the handler for reporting runtime error checks. | +| [`_RTC_SetErrorType`](./reference/rtc-seterrortype.md) | Associates an error that is detected by runtime error checks with a type. | ## See also diff --git a/docs/c-runtime-library/scanf-type-field-characters.md b/docs/c-runtime-library/scanf-type-field-characters.md index 7e3799e42f8..f8fbb3cff25 100644 --- a/docs/c-runtime-library/scanf-type-field-characters.md +++ b/docs/c-runtime-library/scanf-type-field-characters.md @@ -12,25 +12,25 @@ The `type` character is the only required format field; it appears after any opt ### `type` Characters for `scanf` functions -|Character|Type of input expected|Type of argument|Size argument in secure version?| -|---------------|----------------------------|----------------------|--------------------------------------| -|`c`|Character. When used with `scanf` functions, specifies single-byte character; when used with `wscanf` functions, specifies wide character. White-space characters that are ordinarily skipped are read when `c` is specified. Unlike with other type fields, the field width specifier indicates the exact number of characters, not the maximum. To read next non-white-space single-byte character, use `%1s`; to read next non-white-space wide character, use `%1ws`.|Pointer to **`char`** when used with `scanf` functions, pointer to **`wchar_t`** when used with `wscanf` functions.|Required. Size doesn't include space for a null terminator.| -|`C`|Opposite size character. When used with `scanf` functions, specifies wide character; when used with `wscanf` functions, specifies single-byte character. White-space characters that are ordinarily skipped are read when `C` is specified. Unlike with other type fields, the field width specifier indicates the exact number of characters, not the maximum. To read next non-white-space single-byte character, use `%1s`; to read next non-white-space wide character, use `%1ws`.|Pointer to **`wchar_t`** when used with `scanf` functions, pointer to **`char`** when used with `wscanf` functions.|Required. Size argument doesn't include space for a null terminator.| -|`d`|Decimal integer.|Pointer to **`int`**.|No.| -|`i`|An integer. Hexadecimal if the input string begins with "0x" or "0X", octal if the string begins with "0", otherwise decimal.|Pointer to **`int`**.|No.| -|`o`|Octal integer.|Pointer to **`int`**.|No.| -|`p`|A pointer address in hexadecimal digits. The maximum number of digits read depends on the size of a pointer (32 bits or 64 bits), which depends on the machine architecture. "0x" or "0X" are accepted as prefixes.|Pointer to **`void*`**.|No.| -|`u`|Unsigned decimal integer.|Pointer to **`unsigned int`**.|No.| -|`x`|Hexadecimal integer.|Pointer to **`int`**.|No.| -|`e`, `E`, `f`, `F`, `g`, `G`|Floating-point value consisting of optional sign (+ or -), series of one or more decimal digits containing decimal point, and optional exponent ("e" or "E") followed by an optionally signed integer value.|Pointer to **`float`**.|No.| -|`a`, `A`|Floating-point value consisting of a series of one or more hexadecimal digits containing an optional decimal point, and an exponent ("p" or "P") followed by a decimal value.|Pointer to **`float`**.|No.| -|`n`|No input read from stream or buffer.|Pointer to **`int`**, into which is stored number of characters successfully read from stream or buffer up to that point in current call to `scanf` functions or `wscanf` functions.|No.| -|`s`|String, up to first white-space character (space, tab or newline). To read strings not delimited by space characters, use set of square brackets (`[ ]`), as discussed in [`scanf` Width Specification](./scanf-width-specification.md).|When used with `scanf` functions, signifies single-byte character array; when used with `wscanf` functions, signifies wide-character array. In either case, character array must be large enough for input field plus terminating null character, which is automatically appended.|Required. Size includes space for a null terminator.| -|`S`|Opposite-size character string, up to first white-space character (space, tab or newline). To read strings not delimited by space characters, use set of square brackets (`[ ]`), as discussed in [`scanf` Width Specification](./scanf-width-specification.md).|When used with `scanf` functions, signifies wide-character array; when used with `wscanf` functions, signifies single-byte-character array. In either case, character array must be large enough for input field plus terminating null character, which is automatically appended.|Required. Size includes space for a null terminator.| +| Character | Type of input expected | Type of argument | Size argument in secure version? | +|---|---|---|---| +| `c` | Character. When used with `scanf` functions, specifies single-byte character; when used with `wscanf` functions, specifies wide character. White-space characters that are ordinarily skipped are read when `c` is specified. Unlike with other type fields, the field width specifier indicates the exact number of characters, not the maximum. To read next non-white-space single-byte character, use `%1s`; to read next non-white-space wide character, use `%1ws`. | Pointer to **`char`** when used with `scanf` functions, pointer to **`wchar_t`** when used with `wscanf` functions. | Required. Size doesn't include space for a null terminator. | +| `C` | Opposite size character. When used with `scanf` functions, specifies wide character; when used with `wscanf` functions, specifies single-byte character. White-space characters that are ordinarily skipped are read when `C` is specified. Unlike with other type fields, the field width specifier indicates the exact number of characters, not the maximum. To read next non-white-space single-byte character, use `%1s`; to read next non-white-space wide character, use `%1ws`. | Pointer to **`wchar_t`** when used with `scanf` functions, pointer to **`char`** when used with `wscanf` functions. | Required. Size argument doesn't include space for a null terminator. | +| `d` | Decimal integer. | Pointer to **`int`**. | No. | +| `i` | An integer. Hexadecimal if the input string begins with "0x" or "0X", octal if the string begins with "0", otherwise decimal. | Pointer to **`int`**. | No. | +| `o` | Octal integer. | Pointer to **`int`**. | No. | +| `p` | A pointer address in hexadecimal digits. The maximum number of digits read depends on the size of a pointer (32 bits or 64 bits), which depends on the machine architecture. "0x" or "0X" are accepted as prefixes. | Pointer to **`void*`**. | No. | +| `u` | Unsigned decimal integer. | Pointer to **`unsigned int`**. | No. | +| `x` | Hexadecimal integer. | Pointer to **`int`**. | No. | +| `e`, `E`, `f`, `F`, `g`, `G` | Floating-point value consisting of optional sign (+ or -), series of one or more decimal digits containing decimal point, and optional exponent ("e" or "E") followed by an optionally signed integer value. | Pointer to **`float`**. | No. | +| `a`, `A` | Floating-point value consisting of a series of one or more hexadecimal digits containing an optional decimal point, and an exponent ("p" or "P") followed by a decimal value. | Pointer to **`float`**. | No. | +| `n` | No input read from stream or buffer. | Pointer to **`int`**, into which is stored number of characters successfully read from stream or buffer up to that point in current call to `scanf` functions or `wscanf` functions. | No. | +| `s` | String, up to first white-space character (space, tab or newline). To read strings not delimited by space characters, use set of square brackets (`[ ]`), as discussed in [`scanf` Width Specification](./scanf-width-specification.md). | When used with `scanf` functions, signifies single-byte character array; when used with `wscanf` functions, signifies wide-character array. In either case, character array must be large enough for input field plus terminating null character, which is automatically appended. | Required. Size includes space for a null terminator. | +| `S` | Opposite-size character string, up to first white-space character (space, tab or newline). To read strings not delimited by space characters, use set of square brackets (`[ ]`), as discussed in [`scanf` Width Specification](./scanf-width-specification.md). | When used with `scanf` functions, signifies wide-character array; when used with `wscanf` functions, signifies single-byte-character array. In either case, character array must be large enough for input field plus terminating null character, which is automatically appended. | Required. Size includes space for a null terminator. | The size arguments, if necessary, should be passed in the parameter list immediately following the argument they apply to. For example, the following code: -``` +```C char string1[11], string2[9]; scanf_s("%10s %8s", string1, 11, string2, 9); ``` @@ -39,12 +39,12 @@ reads a string with a maximum length of 10 into `string1`, and a string with a m The format string can handle single-byte or wide character input regardless of whether the single-byte character or wide-character version of the function is used. Thus, to read single-byte or wide characters with `scanf` functions and `wscanf` functions, use format specifiers as follows. -|To read character as|Use this function|With these format specifiers| -|--------------------------|-----------------------|----------------------------------| -|single byte|`scanf` functions|`c`, `hc`, or `hC`| -|single byte|`wscanf` functions|`C`, `hc`, or `hC`| -|wide|`wscanf` functions|`c`, `lc`, or `lC`| -|wide|`scanf` functions|`C`, `lc`, or `lC`| +| To read character as | Use this function | With these format specifiers | +|---|---|---| +| single byte | `scanf` functions | `c`, `hc`, or `hC` | +| single byte | `wscanf` functions | `C`, `hc`, or `hC` | +| wide | `wscanf` functions | `c`, `lc`, or `lC` | +| wide | `scanf` functions | `C`, `lc`, or `lC` | To scan strings with `scanf` functions, and `wscanf` functions, use the above table with format type-specifiers `s` and `S` instead of `c` and `C`. diff --git a/docs/c-runtime-library/scanf-width-specification.md b/docs/c-runtime-library/scanf-width-specification.md index ee9f45dccb0..10def004d79 100644 --- a/docs/c-runtime-library/scanf-width-specification.md +++ b/docs/c-runtime-library/scanf-width-specification.md @@ -33,26 +33,26 @@ The optional prefixes **`h`**, **`hh`**, **`l`**, **`ll`**, **`I64`**, and **`L` ### Size prefixes for `scanf` and `wscanf` format-type specifiers -|To specify|Use prefix|With type specifier| -|----------------|----------------|-------------------------| -|**`double`**|**`l`**|**`e`**, **`E`**, **`f`**, **`g`**, or **`G`**| -|**`long double`** (same as **`double`**)|**`L`**|**`e`**, **`E`**, **`f`**, **`g`**, or **`G`**| -|**`long int`**|**`l`**|**`d`**, **`i`**, **`o`**, **`x`**, or **`X`**| -|**`long unsigned int`**|**`l`**|**`u`**| -|**`long long`**|**`ll`**|**`d`**, **`i`**, **`o`**, **`x`**, or **`X`**| -|**`short int`**|**`h`**|**`d`**, **`i`**, **`o`**, **`x`**, or **`X`**| -|**`short unsigned int`**|**`h`**|**`u`**| -|**`char`**|**`hh`**|**`d`**, **`i`**, **`o`**, **`x`**, or **`X`**| -|**`unsigned char`**|**`hh`**|**`u`**| -|**`int64`**|**`I64`**|**`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`**| -|Single-byte character with `scanf`|**`h`**|**`c`** or **`C`**| -|Single-byte character with `wscanf`|**`h`**|**`c`** or **`C`**| -|Wide character with `scanf`|**`l`**|**`c`** or **`C`**| -|Wide character with `wscanf`|**`l`**|**`c`**, or **`C`**| -|Single-byte character string with `scanf`|**`h`**|**`s`** or **`S`**| -|Single-byte character string with `wscanf`|**`h`**|**`s`** or **`S`**| -|Wide character string with `scanf`|**`l`**|**`s`** or **`S`**| -|Wide character string with `wscanf`|**`l`**|**`s`** or **`S`**| +| To specify | Use prefix | With type specifier | +|---|---|---| +| **`double`** | **`l`** | **`e`**, **`E`**, **`f`**, **`g`**, or **`G`** | +| **`long double`** (same as **`double`**) | **`L`** | **`e`**, **`E`**, **`f`**, **`g`**, or **`G`** | +| **`long int`** | **`l`** | **`d`**, **`i`**, **`o`**, **`x`**, or **`X`** | +| **`long unsigned int`** | **`l`** | **`u`** | +| **`long long`** | **`ll`** | **`d`**, **`i`**, **`o`**, **`x`**, or **`X`** | +| **`short int`** | **`h`** | **`d`**, **`i`**, **`o`**, **`x`**, or **`X`** | +| **`short unsigned int`** | **`h`** | **`u`** | +| **`char`** | **`hh`** | **`d`**, **`i`**, **`o`**, **`x`**, or **`X`** | +| **`unsigned char`** | **`hh`** | **`u`** | +| **`int64`** | **`I64`** | **`d`**, **`i`**, **`o`**, **`u`**, **`x`**, or **`X`** | +| Single-byte character with `scanf` | **`h`** | **`c`** or **`C`** | +| Single-byte character with `wscanf` | **`h`** | **`c`** or **`C`** | +| Wide character with `scanf` | **`l`** | **`c`** or **`C`** | +| Wide character with `wscanf` | **`l`** | **`c`**, or **`C`** | +| Single-byte character string with `scanf` | **`h`** | **`s`** or **`S`** | +| Single-byte character string with `wscanf` | **`h`** | **`s`** or **`S`** | +| Wide character string with `scanf` | **`l`** | **`s`** or **`S`** | +| Wide character string with `wscanf` | **`l`** | **`s`** or **`S`** | The following examples use **`h`** and **`l`** with `scanf_s` functions and `wscanf_s` functions: diff --git a/docs/c-runtime-library/searching-and-sorting.md b/docs/c-runtime-library/searching-and-sorting.md index 405d72ec8ce..706301f3b0a 100644 --- a/docs/c-runtime-library/searching-and-sorting.md +++ b/docs/c-runtime-library/searching-and-sorting.md @@ -11,16 +11,16 @@ Use the following functions for searching and sorting. ## Searching and sorting functions -|Function|Search or Sort| -|--------------|--------------------| -|[`bsearch`](./reference/bsearch.md)|Binary search| -|[`bsearch_s`](./reference/bsearch-s.md)|A more secure version of `bsearch`| -|[`_lfind`](./reference/lfind.md)|Linear search for given value| -|[`_lfind_s`](./reference/lfind-s.md)|A more secure version of `_lfind`| -|[`_lsearch`](./reference/lsearch.md)|Linear search for given value, which is added to array if not found| -|[`_lsearch_s`](./reference/lsearch-s.md)|A more secure version of `_lsearch`| -|[`qsort`](./reference/qsort.md)|Quick sort| -|[`qsort_s`](./reference/qsort-s.md)|A more secure version of `qsort`| +| Function | Search or Sort | +|---|---| +| [`bsearch`](./reference/bsearch.md) | Binary search | +| [`bsearch_s`](./reference/bsearch-s.md) | A more secure version of `bsearch` | +| [`_lfind`](./reference/lfind.md) | Linear search for given value | +| [`_lfind_s`](./reference/lfind-s.md) | A more secure version of `_lfind` | +| [`_lsearch`](./reference/lsearch.md) | Linear search for given value, which is added to array if not found | +| [`_lsearch_s`](./reference/lsearch-s.md) | A more secure version of `_lsearch` | +| [`qsort`](./reference/qsort.md) | Quick sort | +| [`qsort_s`](./reference/qsort-s.md) | A more secure version of `qsort` | ## See also diff --git a/docs/c-runtime-library/security-enhanced-versions-of-crt-functions.md b/docs/c-runtime-library/security-enhanced-versions-of-crt-functions.md index 989e6bda3b6..30a570fbaaa 100644 --- a/docs/c-runtime-library/security-enhanced-versions-of-crt-functions.md +++ b/docs/c-runtime-library/security-enhanced-versions-of-crt-functions.md @@ -11,85 +11,85 @@ More secure versions of run-time library routines are available. For more inform ## Secure functions -|CRT Function|Security enhanced function|Use| -|------------------|--------------------------------|---------| -|[`_access`, `_waccess`](./reference/access-waccess.md)|[`_access_s`, `_waccess_s`](./reference/access-s-waccess-s.md)|Determine file-access permission| -|[`_alloca`](./reference/alloca.md)|[`_malloca`](./reference/malloca.md)|Allocate memory on the stack| -|[`asctime`, `_wasctime`](./reference/asctime-wasctime.md)|[`asctime_s`, `_wasctime_s`](./reference/asctime-s-wasctime-s.md)|Convert time from type `struct tm` to character string| -|[`bsearch`](./reference/bsearch.md)|[`bsearch_s`](./reference/bsearch-s.md)|Perform a binary search of a sorted array| -|[`_cgets`, `_cgetws`](./cgets-cgetws.md)|[`_cgets_s`, `_cgetws_s`](./reference/cgets-s-cgetws-s.md)|Get a character string from the console| -|[`_chsize`](./reference/chsize.md)|[`_chsize_s`](./reference/chsize-s.md)|Change the size of a file| -|[`clearerr`](./reference/clearerr.md)|[`clearerr_s`](./reference/clearerr-s.md)|Reset the error indicator for a stream| -|[`_control87`, `_controlfp`, `__control87_2`](./reference/control87-controlfp-control87-2.md)|[`_controlfp_s`](./reference/controlfp-s.md)|Get and set the floating-point control word| -|[`_cprintf`, `_cprintf_l`, `_cwprintf`, `_cwprintf_l`](./reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md)|[`_cprintf_s`, `_cprintf_s_l`, `_cwprintf_s`, `_cwprintf_s_l`](./reference/cprintf-s-cprintf-s-l-cwprintf-s-cwprintf-s-l.md)|Format and print to the console| -|[`_cscanf`, `_cscanf_l`, `_cwscanf`, `_cwscanf_l`](./reference/cscanf-cscanf-l-cwscanf-cwscanf-l.md)|[`_cscanf_s`, `_cscanf_s_l`, `_cwscanf_s`, `_cwscanf_s_l`](./reference/cscanf-s-cscanf-s-l-cwscanf-s-cwscanf-s-l.md)|Read formatted data from the console| -|[`ctime`, `_ctime32`, `_ctime64`, `_wctime`, `_wctime32`, `_wctime64`](./reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md)|[`_ctime_s`, `_ctime32_s`, `_ctime64_s`, `_wctime_s`, `_wctime32_s`, `_wctime64_s`](./reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md)|Convert time from type `time_t`, `__time32_t` or `__time64_t` to character string| -|[`_ecvt`](./reference/ecvt.md)|[`_ecvt_s`](./reference/ecvt-s.md)|Convert a **`double`** number to a string| -|[`_fcvt`](./reference/fcvt.md)|[`_fcvt_s`](./reference/fcvt-s.md)|Converts a floating-point number to a string| -|[`fopen`, `_wfopen`](./reference/fopen-wfopen.md)|[`fopen_s`, `_wfopen_s`](./reference/fopen-s-wfopen-s.md)|Open a file| -|[`fprintf`, `_fprintf_l`, `fwprintf`, `_fwprintf_l`](./reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md)|[`fprintf_s`, `_fprintf_s_l`, `fwprintf_s`, `_fwprintf_s_l`](./reference/fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md)|Print formatted data to a stream| -|[`fread`](./reference/fread.md)|[`fread_s`](./reference/fread-s.md)|Read from a file| -|[`_fread_nolock`](./reference/fread-nolock.md)|[`_fread_nolock_s`](./reference/fread-nolock-s2.md)|Read from a file without using a multi-thread write lock| -|[`freopen`, `_wfreopen`](./reference/freopen-wfreopen.md)|[`freopen_s`, `_wfreopen_s`](./reference/freopen-s-wfreopen-s.md)|Reopen the file| -|[`fscanf`, `_fscanf_l`, `fwscanf`, `_fwscanf_l`](./reference/fscanf-fscanf-l-fwscanf-fwscanf-l.md)|[`fscanf_s`, `_fscanf_s_l`, `fwscanf_s`, `_fwscanf_s_l`](./reference/fscanf-s-fscanf-s-l-fwscanf-s-fwscanf-s-l.md)|Read formatted data from a stream| -|[`_ftime`, `_ftime32`, `_ftime64`](./reference/ftime-ftime32-ftime64.md)|[`_ftime_s`, `_ftime32_s`, `_ftime64_s`](./reference/ftime-s-ftime32-s-ftime64-s.md)|Get the current time| -|[`_gcvt`](./reference/gcvt.md)|[`_gcvt_s`](./reference/gcvt-s.md)|Convert a floating-point value to a string, and store it in a buffer| -|[`getenv`, `_wgetenv`](./reference/getenv-wgetenv.md)|[`getenv_s`, `_wgetenv_s`](./reference/getenv-s-wgetenv-s.md)|Get a value from the current environment.| -|[`gets`, `getws`](./gets-getws.md)|[`gets_s`, `_getws_s`](./reference/gets-s-getws-s.md)|Get a line from the `stdin` stream| -|[`gmtime`, `_gmtime32`, `_gmtime64`](./reference/gmtime-gmtime32-gmtime64.md)|[`_gmtime32_s`, `_gmtime64_s`](./reference/gmtime-s-gmtime32-s-gmtime64-s.md)|Convert time from type `time_t` to `struct tm` or from type `__time64_t` to `struct tm`| -|[`itoa`, `_itoa`, `ltoa`, `_ltoa`, `ultoa`, `_ultoa`, `_i64toa`, `_ui64toa`, `_itow`, `_ltow`, `_ultow`, `_i64tow`, `_ui64tow`](./reference/itoa-itow.md)|[`_itoa_s`, `_ltoa_s`, `_ultoa_s`, `_i64toa_s`, `_ui64toa_s`, `_itow_s`, `_ltow_s`, `_ultow_s`, `_i64tow_s`, `_ui64tow_s`](./reference/itoa-s-itow-s.md)|Convert an integral type to a string| -|[`_lfind`](./reference/lfind.md)|[`_lfind_s`](./reference/lfind-s.md)|Perform a linear search for the specified key| -|[`localtime`, `_localtime32`, `_localtime64`](./reference/localtime-localtime32-localtime64.md)|[`localtime_s`, `_localtime32_s`, `_localtime64_s`](./reference/localtime-s-localtime32-s-localtime64-s.md)|Convert time from type `time_t` to `struct tm` or from type `__time64_t` to `struct tm` with local correction| -|[`_lsearch`](./reference/lsearch.md)|[`_lsearch_s`](./reference/lsearch-s.md)|Perform a linear search for a value; adds to end of list if not found| -|[`_makepath`, `_wmakepath`](./reference/makepath-wmakepath.md)|[`_makepath_s`, `_wmakepath_s`](./reference/makepath-s-wmakepath-s.md)|Create a path name from components| -|[`_mbccpy`, `_mbccpy_l`](./reference/mbccpy-mbccpy-l.md)|[`_mbccpy_s`, `_mbccpy_s_l`](./reference/mbccpy-s-mbccpy-s-l.md)|Copy a multibyte character from one string to another string| -|[`_mbsnbcat`, `_mbsnbcat_l`](./reference/mbsnbcat-mbsnbcat-l.md)|[`_mbsnbcat_s`, `_mbsnbcat_s_l`](./reference/mbsnbcat-s-mbsnbcat-s-l.md)|Append at most the first *n* bytes of one multibyte character string to another| -|[`_mbsnbcpy`, `_mbsnbcpy_l`](./reference/mbsnbcpy-mbsnbcpy-l.md)|[`_mbsnbcpy_s`, `_mbsnbcpy_s_l`](./reference/mbsnbcpy-s-mbsnbcpy-s-l.md)|Copy *n* bytes of a string to a destination string| -|[`_mbsnbset`, `_mbsnbset_l`](./reference/mbsnbset-mbsnbset-l.md)|[`_mbsnbset_s`, `_mbsnbset_s_l`](./reference/mbsnbset-s-mbsnbset-s-l.md)|Set the first *n* bytes of a string to a specified character| -|[`mbsrtowcs`](./reference/mbsrtowcs.md)|[`mbsrtowcs_s`](./reference/mbsrtowcs-s.md)|Convert a multibyte character string to a corresponding wide character string| -|[`mbstowcs`, `_mbstowcs_l`](./reference/mbstowcs-mbstowcs-l.md)|[`mbstowcs_s`, `_mbstowcs_s_l`](./reference/mbstowcs-s-mbstowcs-s-l.md)|Convert a sequence of multibyte characters to a corresponding sequence of wide characters| -|[`memcpy`, `wmemcpy`](./reference/memcpy-wmemcpy.md)|[`memcpy_s`, `wmemcpy_s`](./reference/memcpy-s-wmemcpy-s.md)|Copy characters between buffers| -|[`memmove`, `wmemmove`](./reference/memmove-wmemmove.md)|[`memmove_s`, `wmemmove_s`](./reference/memmove-s-wmemmove-s.md)|Move one buffer to another| -|[`_mktemp`, `_wmktemp`](./reference/mktemp-wmktemp.md)|[`_mktemp_s`, `_wmktemp_s`](./reference/mktemp-s-wmktemp-s.md)|Create a unique filename| -|[`printf`, `_printf_l`, `wprintf`, `_wprintf_l`](./reference/printf-printf-l-wprintf-wprintf-l.md)|[`printf_s`, `_printf_s_l`, `wprintf_s`, `_wprintf_s_l`](./reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md)|Print formatted output to the standard output stream| -|[`_putenv`, `_wputenv`](./reference/putenv-wputenv.md)|[`_putenv_s`, `_wputenv_s`](./reference/putenv-s-wputenv-s.md)|Create, modify, or remove environment variables| -|[`qsort`](./reference/qsort.md)|[`qsort_s`](./reference/qsort-s.md)|Perform a quick sort| -|[`rand`](./reference/rand.md)|[`rand_s`](./reference/rand-s.md)|Generate a pseudorandom number| -|[`scanf`, `_scanf_l`, `wscanf`, `_wscanf_l`](./reference/scanf-scanf-l-wscanf-wscanf-l.md)|[`scanf_s`, `_scanf_s_l`, `wscanf_s`, `_wscanf_s_l`](./reference/scanf-s-scanf-s-l-wscanf-s-wscanf-s-l.md)|Read formatted data from the standard input stream| -|[`_searchenv`, `_wsearchenv`](./reference/searchenv-wsearchenv.md)|[`_searchenv_s`, `_wsearchenv_s`](./reference/searchenv-s-wsearchenv-s.md)|Search for a file using environment paths| -|[`snprintf`, `_snprintf`, `_snprintf_l`, `_snwprintf`, `_snwprintf_l`](./reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md)|[`_snprintf_s`, `_snprintf_s_l`, `_snwprintf_s`, `_snwprintf_s_l`](./reference/snprintf-s-snprintf-s-l-snwprintf-s-snwprintf-s-l.md)|Write formatted data to a string| -|[`_snscanf`, `_snscanf_l`, `_snwscanf`, `_snwscanf_l`](./reference/snscanf-snscanf-l-snwscanf-snwscanf-l.md)|[`_snscanf_s`, `_snscanf_s_l`, `_snwscanf_s`, `_snwscanf_s_l`](./reference/snscanf-s-snscanf-s-l-snwscanf-s-snwscanf-s-l.md)|Read formatted data of a specified length from a string.| -|[`_sopen`, `_wsopen`](./reference/sopen-wsopen.md)|[`_sopen_s`, `_wsopen_s`](./reference/sopen-s-wsopen-s.md)|Open a file for sharing| -|[`_splitpath`, `_wsplitpath`](./reference/splitpath-wsplitpath.md)|[`_splitpath_s`, `_wsplitpath_s`](./reference/splitpath-s-wsplitpath-s.md)|Break a path name into components| -|[`sprintf`, `_sprintf_l`, `swprintf`, `_swprintf_l`, `__swprintf_l`](./reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md)|[`sprintf_s`, `_sprintf_s_l`, `swprintf_s`, `_swprintf_s_l`](./reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md)|Write formatted data to a string| -|[`sscanf`, `_sscanf_l`, `swscanf`, `_swscanf_l`](./reference/sscanf-sscanf-l-swscanf-swscanf-l.md)|[`sscanf_s`, `_sscanf_s_l`, `swscanf_s`, `_swscanf_s_l`](./reference/sscanf-s-sscanf-s-l-swscanf-s-swscanf-s-l.md)|Read formatted data from a string| -|[`strcat`, `wcscat`, `_mbscat`](./reference/strcat-wcscat-mbscat.md)|[`strcat_s`, `wcscat_s`, `_mbscat_s`](./reference/strcat-s-wcscat-s-mbscat-s.md)|Append a string| -|[`strcpy`, `wcscpy`, `_mbscpy`](./reference/strcpy-wcscpy-mbscpy.md)|[`strcpy_s`, `wcscpy_s`, `_mbscpy_s`](./reference/strcpy-s-wcscpy-s-mbscpy-s.md)|Copy a string| -|[`_strdate`, `_wstrdate`](./reference/strdate-wstrdate.md)|[`_strdate_s`, `_wstrdate_s`](./reference/strdate-s-wstrdate-s.md)|Return current system date as string| -|[`strerror`, `_strerror`, `_wcserror`, `__wcserror`](./reference/strerror-strerror-wcserror-wcserror.md)|[`strerror_s`, `_strerror_s`, `_wcserror_s`, `__wcserror_s`](./reference/strerror-s-strerror-s-wcserror-s-wcserror-s.md)|Get a system error message (`strerror`, `_wcserror`) or print a user-supplied error message (`_strerror`, `__wcserror`)| -|[`_strlwr`, `_wcslwr`, `_mbslwr`, `_strlwr_l`, `_wcslwr_l`, `_mbslwr_l`](./reference/strlwr-wcslwr-mbslwr-strlwr-l-wcslwr-l-mbslwr-l.md)|[`_strlwr_s`, `_strlwr_s_l`, `_mbslwr_s`, `_mbslwr_s_l`, `_wcslwr_s`, `_wcslwr_s_l`](./reference/strlwr-s-strlwr-s-l-mbslwr-s-mbslwr-s-l-wcslwr-s-wcslwr-s-l.md)|Convert a string to lowercase| -|[`strncat`, `_strncat_l`, `wcsncat`, `_wcsncat_l`, `_mbsncat`, `_mbsncat_l`](./reference/strncat-strncat-l-wcsncat-wcsncat-l-mbsncat-mbsncat-l.md)|[`strncat_s`, `_strncat_s_l`, `wcsncat_s`, `_wcsncat_s_l`, `_mbsncat_s`, `_mbsncat_s_l`](./reference/strncat-s-strncat-s-l-wcsncat-s-wcsncat-s-l-mbsncat-s-mbsncat-s-l.md)|Append characters to a string| -|[`strncpy`, `_strncpy_l`, `wcsncpy`, `_wcsncpy_l`, `_mbsncpy`, `_mbsncpy_l`](./reference/strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md)|[`strncpy_s`, `_strncpy_s_l`, `wcsncpy_s`, `_wcsncpy_s_l`, `_mbsncpy_s`, `_mbsncpy_s_l`](./reference/strncpy-s-strncpy-s-l-wcsncpy-s-wcsncpy-s-l-mbsncpy-s-mbsncpy-s-l.md)|Copy characters of one string to another| -|[`_strnset`, `_strnset_l`, `_wcsnset`, `_wcsnset_l`, `_mbsnset`, `_mbsnset_l`](./reference/strnset-strnset-l-wcsnset-wcsnset-l-mbsnset-mbsnset-l.md)|[`_strnset_s`, `_strnset_s_l`, `_wcsnset_s`, `_wcsnset_s_l`, `_mbsnset_s`, `_mbsnset_s_l`](./reference/strnset-s-strnset-s-l-wcsnset-s-wcsnset-s-l-mbsnset-s-mbsnset-s-l.md)|Set the first n characters of a string to the specified character| -|[`_strset`, `_strset_l`, `_wcsset`, `_wcsset_l`, `_mbsset`, `_mbsset_l`](./reference/strset-strset-l-wcsset-wcsset-l-mbsset-mbsset-l.md)|[`_strset_s`, `_strset_s_l`, `_wcsset_s`, `_wcsset_s_l`, `_mbsset_s`, `_mbsset_s_l`](./reference/strset-s-strset-s-l-wcsset-s-wcsset-s-l-mbsset-s-mbsset-s-l.md)|Set all the characters of a string to the specified character| -|[`_strtime`, `_wstrtime`](./reference/strtime-wstrtime.md)|[`_strtime_s`, `_wstrtime_s`](./reference/strtime-s-wstrtime-s.md)|Return current system time as string| -|[`strtok`, `_strtok_l`, `wcstok`, `_wcstok_l`, `_mbstok`, `_mbstok_l`](./reference/strtok-strtok-l-wcstok-wcstok-l-mbstok-mbstok-l.md)|[`strtok_s`, `_strtok_s_l`, `wcstok_s`, `_wcstok_s_l`, `_mbstok_s`, `_mbstok_s_l`](./reference/strtok-s-strtok-s-l-wcstok-s-wcstok-s-l-mbstok-s-mbstok-s-l.md)|Find the next token in a string, using the current locale or a locale passed in| -|[`_strupr`, `_strupr_l`, `_mbsupr`, `_mbsupr_l`, `_wcsupr_l`, `_wcsupr`](./reference/strupr-strupr-l-mbsupr-mbsupr-l-wcsupr-l-wcsupr.md)|[`_strupr_s`, `_strupr_s_l`, `_mbsupr_s`, `_mbsupr_s_l`, `_wcsupr_s`, `_wcsupr_s_l`](./reference/strupr-s-strupr-s-l-mbsupr-s-mbsupr-s-l-wcsupr-s-wcsupr-s-l.md)|Convert a string to uppercase| -|[`tmpfile`](./reference/tmpfile.md)|[`tmpfile_s`](./reference/tmpfile-s.md)|Create a temporary file| -|[`_tempnam`, `_wtempnam`, `tmpnam`, `_wtmpnam`](./reference/tempnam-wtempnam-tmpnam-wtmpnam.md)|[`tmpnam_s`, `_wtmpnam_s`](./reference/tmpnam-s-wtmpnam-s.md)|Generate names you can use to create temporary files| -|[`_umask`](./reference/umask.md)|[`_umask_s`](./reference/umask-s.md)|Set the default file-permission mask| -|[`_vcprintf`, `_vcprintf_l`, `_vcwprintf`, `_vcwprintf_l`](./reference/vcprintf-vcprintf-l-vcwprintf-vcwprintf-l.md)|[`_vcprintf_s`, `_vcprintf_s_l`, `_vcwprintf_s`, `_vcwprintf_s_l`](./reference/vcprintf-s-vcprintf-s-l-vcwprintf-s-vcwprintf-s-l.md)|Write formatted output to the console using a pointer to a list of arguments| -|[`vfprintf`, `_vfprintf_l`, `vfwprintf`, `_vfwprintf_l`](./reference/vfprintf-vfprintf-l-vfwprintf-vfwprintf-l.md)|[`vfprintf_s`, `_vfprintf_s_l`, `vfwprintf_s`, `_vfwprintf_s_l`](./reference/vfprintf-s-vfprintf-s-l-vfwprintf-s-vfwprintf-s-l.md)|Write formatted output using a pointer to a list of arguments| -|[`vfscanf`, `vfwscanf`](./reference/vfscanf-vfwscanf.md)|[`vfscanf_s`, `vfwscanf_s`](./reference/vfscanf-s-vfwscanf-s.md)|Read formatted data from a stream| -|[`vprintf`, `_vprintf_l`, `vwprintf`, `_vwprintf_l`](./reference/vprintf-vprintf-l-vwprintf-vwprintf-l.md)|[`vprintf_s`, `_vprintf_s_l`, `vwprintf_s`, `_vwprintf_s_l`](./reference/vprintf-s-vprintf-s-l-vwprintf-s-vwprintf-s-l.md)|Write formatted output using a pointer to a list of arguments| -|[`vscanf`, `vwscanf`](./reference/vscanf-vwscanf.md)|[`vscanf_s`, `vwscanf_s`](./reference/vscanf-s-vwscanf-s.md)|Read formatted data from the standard input stream| -|[`vsnprintf`, `_vsnprintf`, `_vsnprintf_l`, `_vsnwprintf`, `_vsnwprintf_l`](./reference/vsnprintf-vsnprintf-vsnprintf-l-vsnwprintf-vsnwprintf-l.md)|[`vsnprintf_s`, `_vsnprintf_s`, `_vsnprintf_s_l`, `_vsnwprintf_s`, `_vsnwprintf_s_l`](./reference/vsnprintf-s-vsnprintf-s-vsnprintf-s-l-vsnwprintf-s-vsnwprintf-s-l.md)|Write formatted output using a pointer to a list of arguments| -|[`vsprintf`, `_vsprintf_l`, `vswprintf`, `_vswprintf_l`, `__vswprintf_l`](./reference/vsprintf-vsprintf-l-vswprintf-vswprintf-l-vswprintf-l.md)|[`vsprintf_s`, `_vsprintf_s_l`, `vswprintf_s`, `_vswprintf_s_l`](./reference/vsprintf-s-vsprintf-s-l-vswprintf-s-vswprintf-s-l.md)|Write formatted output using a pointer to a list of arguments| -|[`vsscanf`, `vswscanf`](./reference/vsscanf-vswscanf.md)|[`vsscanf_s`, `vswscanf_s`](./reference/vsscanf-s-vswscanf-s.md)|Read formatted data from a string| -|[`wcrtomb`](./reference/wcrtomb.md)|[`wcrtomb_s`](./reference/wcrtomb-s.md)|Convert a wide character into its multibyte character representation| -|[`wcsrtombs`](./reference/wcsrtombs.md)|[`wcsrtombs_s`](./reference/wcsrtombs-s.md)|Convert a wide character string to its multibyte character string representation| -|[`wcstombs`, `_wcstombs_l`](./reference/wcstombs-wcstombs-l.md)|[`wcstombs_s`, `_wcstombs_s_l`](./reference/wcstombs-s-wcstombs-s-l.md)|Convert a sequence of wide characters to a corresponding sequence of multibyte characters| -|[`wctomb`, `_wctomb_l`](./reference/wctomb-wctomb-l.md)|[`wctomb_s`, `_wctomb_s_l`](./reference/wctomb-s-wctomb-s-l.md)|Convert a wide character to the corresponding multibyte character| +| CRT Function | Security enhanced function | Use | +|---|---|---| +| [`_access`, `_waccess`](./reference/access-waccess.md) | [`_access_s`, `_waccess_s`](./reference/access-s-waccess-s.md) | Determine file-access permission | +| [`_alloca`](./reference/alloca.md) | [`_malloca`](./reference/malloca.md) | Allocate memory on the stack | +| [`asctime`, `_wasctime`](./reference/asctime-wasctime.md) | [`asctime_s`, `_wasctime_s`](./reference/asctime-s-wasctime-s.md) | Convert time from type `struct tm` to character string | +| [`bsearch`](./reference/bsearch.md) | [`bsearch_s`](./reference/bsearch-s.md) | Perform a binary search of a sorted array | +| [`_cgets`, `_cgetws`](./cgets-cgetws.md) | [`_cgets_s`, `_cgetws_s`](./reference/cgets-s-cgetws-s.md) | Get a character string from the console | +| [`_chsize`](./reference/chsize.md) | [`_chsize_s`](./reference/chsize-s.md) | Change the size of a file | +| [`clearerr`](./reference/clearerr.md) | [`clearerr_s`](./reference/clearerr-s.md) | Reset the error indicator for a stream | +| [`_control87`, `_controlfp`, `__control87_2`](./reference/control87-controlfp-control87-2.md) | [`_controlfp_s`](./reference/controlfp-s.md) | Get and set the floating-point control word | +| [`_cprintf`, `_cprintf_l`, `_cwprintf`, `_cwprintf_l`](./reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md) | [`_cprintf_s`, `_cprintf_s_l`, `_cwprintf_s`, `_cwprintf_s_l`](./reference/cprintf-s-cprintf-s-l-cwprintf-s-cwprintf-s-l.md) | Format and print to the console | +| [`_cscanf`, `_cscanf_l`, `_cwscanf`, `_cwscanf_l`](./reference/cscanf-cscanf-l-cwscanf-cwscanf-l.md) | [`_cscanf_s`, `_cscanf_s_l`, `_cwscanf_s`, `_cwscanf_s_l`](./reference/cscanf-s-cscanf-s-l-cwscanf-s-cwscanf-s-l.md) | Read formatted data from the console | +| [`ctime`, `_ctime32`, `_ctime64`, `_wctime`, `_wctime32`, `_wctime64`](./reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md) | [`_ctime_s`, `_ctime32_s`, `_ctime64_s`, `_wctime_s`, `_wctime32_s`, `_wctime64_s`](./reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md) | Convert time from type `time_t`, `__time32_t` or `__time64_t` to character string | +| [`_ecvt`](./reference/ecvt.md) | [`_ecvt_s`](./reference/ecvt-s.md) | Convert a **`double`** number to a string | +| [`_fcvt`](./reference/fcvt.md) | [`_fcvt_s`](./reference/fcvt-s.md) | Converts a floating-point number to a string | +| [`fopen`, `_wfopen`](./reference/fopen-wfopen.md) | [`fopen_s`, `_wfopen_s`](./reference/fopen-s-wfopen-s.md) | Open a file | +| [`fprintf`, `_fprintf_l`, `fwprintf`, `_fwprintf_l`](./reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md) | [`fprintf_s`, `_fprintf_s_l`, `fwprintf_s`, `_fwprintf_s_l`](./reference/fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md) | Print formatted data to a stream | +| [`fread`](./reference/fread.md) | [`fread_s`](./reference/fread-s.md) | Read from a file | +| [`_fread_nolock`](./reference/fread-nolock.md) | [`_fread_nolock_s`](./reference/fread-nolock-s2.md) | Read from a file without using a multi-thread write lock | +| [`freopen`, `_wfreopen`](./reference/freopen-wfreopen.md) | [`freopen_s`, `_wfreopen_s`](./reference/freopen-s-wfreopen-s.md) | Reopen the file | +| [`fscanf`, `_fscanf_l`, `fwscanf`, `_fwscanf_l`](./reference/fscanf-fscanf-l-fwscanf-fwscanf-l.md) | [`fscanf_s`, `_fscanf_s_l`, `fwscanf_s`, `_fwscanf_s_l`](./reference/fscanf-s-fscanf-s-l-fwscanf-s-fwscanf-s-l.md) | Read formatted data from a stream | +| [`_ftime`, `_ftime32`, `_ftime64`](./reference/ftime-ftime32-ftime64.md) | [`_ftime_s`, `_ftime32_s`, `_ftime64_s`](./reference/ftime-s-ftime32-s-ftime64-s.md) | Get the current time | +| [`_gcvt`](./reference/gcvt.md) | [`_gcvt_s`](./reference/gcvt-s.md) | Convert a floating-point value to a string, and store it in a buffer | +| [`getenv`, `_wgetenv`](./reference/getenv-wgetenv.md) | [`getenv_s`, `_wgetenv_s`](./reference/getenv-s-wgetenv-s.md) | Get a value from the current environment. | +| [`gets`, `getws`](./gets-getws.md) | [`gets_s`, `_getws_s`](./reference/gets-s-getws-s.md) | Get a line from the `stdin` stream | +| [`gmtime`, `_gmtime32`, `_gmtime64`](./reference/gmtime-gmtime32-gmtime64.md) | [`_gmtime32_s`, `_gmtime64_s`](./reference/gmtime-s-gmtime32-s-gmtime64-s.md) | Convert time from type `time_t` to `struct tm` or from type `__time64_t` to `struct tm` | +| [`itoa`, `_itoa`, `ltoa`, `_ltoa`, `ultoa`, `_ultoa`, `_i64toa`, `_ui64toa`, `_itow`, `_ltow`, `_ultow`, `_i64tow`, `_ui64tow`](./reference/itoa-itow.md) | [`_itoa_s`, `_ltoa_s`, `_ultoa_s`, `_i64toa_s`, `_ui64toa_s`, `_itow_s`, `_ltow_s`, `_ultow_s`, `_i64tow_s`, `_ui64tow_s`](./reference/itoa-s-itow-s.md) | Convert an integral type to a string | +| [`_lfind`](./reference/lfind.md) | [`_lfind_s`](./reference/lfind-s.md) | Perform a linear search for the specified key | +| [`localtime`, `_localtime32`, `_localtime64`](./reference/localtime-localtime32-localtime64.md) | [`localtime_s`, `_localtime32_s`, `_localtime64_s`](./reference/localtime-s-localtime32-s-localtime64-s.md) | Convert time from type `time_t` to `struct tm` or from type `__time64_t` to `struct tm` with local correction | +| [`_lsearch`](./reference/lsearch.md) | [`_lsearch_s`](./reference/lsearch-s.md) | Perform a linear search for a value; adds to end of list if not found | +| [`_makepath`, `_wmakepath`](./reference/makepath-wmakepath.md) | [`_makepath_s`, `_wmakepath_s`](./reference/makepath-s-wmakepath-s.md) | Create a path name from components | +| [`_mbccpy`, `_mbccpy_l`](./reference/mbccpy-mbccpy-l.md) | [`_mbccpy_s`, `_mbccpy_s_l`](./reference/mbccpy-s-mbccpy-s-l.md) | Copy a multibyte character from one string to another string | +| [`_mbsnbcat`, `_mbsnbcat_l`](./reference/mbsnbcat-mbsnbcat-l.md) | [`_mbsnbcat_s`, `_mbsnbcat_s_l`](./reference/mbsnbcat-s-mbsnbcat-s-l.md) | Append at most the first *n* bytes of one multibyte character string to another | +| [`_mbsnbcpy`, `_mbsnbcpy_l`](./reference/mbsnbcpy-mbsnbcpy-l.md) | [`_mbsnbcpy_s`, `_mbsnbcpy_s_l`](./reference/mbsnbcpy-s-mbsnbcpy-s-l.md) | Copy *n* bytes of a string to a destination string | +| [`_mbsnbset`, `_mbsnbset_l`](./reference/mbsnbset-mbsnbset-l.md) | [`_mbsnbset_s`, `_mbsnbset_s_l`](./reference/mbsnbset-s-mbsnbset-s-l.md) | Set the first *n* bytes of a string to a specified character | +| [`mbsrtowcs`](./reference/mbsrtowcs.md) | [`mbsrtowcs_s`](./reference/mbsrtowcs-s.md) | Convert a multibyte character string to a corresponding wide character string | +| [`mbstowcs`, `_mbstowcs_l`](./reference/mbstowcs-mbstowcs-l.md) | [`mbstowcs_s`, `_mbstowcs_s_l`](./reference/mbstowcs-s-mbstowcs-s-l.md) | Convert a sequence of multibyte characters to a corresponding sequence of wide characters | +| [`memcpy`, `wmemcpy`](./reference/memcpy-wmemcpy.md) | [`memcpy_s`, `wmemcpy_s`](./reference/memcpy-s-wmemcpy-s.md) | Copy characters between buffers | +| [`memmove`, `wmemmove`](./reference/memmove-wmemmove.md) | [`memmove_s`, `wmemmove_s`](./reference/memmove-s-wmemmove-s.md) | Move one buffer to another | +| [`_mktemp`, `_wmktemp`](./reference/mktemp-wmktemp.md) | [`_mktemp_s`, `_wmktemp_s`](./reference/mktemp-s-wmktemp-s.md) | Create a unique filename | +| [`printf`, `_printf_l`, `wprintf`, `_wprintf_l`](./reference/printf-printf-l-wprintf-wprintf-l.md) | [`printf_s`, `_printf_s_l`, `wprintf_s`, `_wprintf_s_l`](./reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md) | Print formatted output to the standard output stream | +| [`_putenv`, `_wputenv`](./reference/putenv-wputenv.md) | [`_putenv_s`, `_wputenv_s`](./reference/putenv-s-wputenv-s.md) | Create, modify, or remove environment variables | +| [`qsort`](./reference/qsort.md) | [`qsort_s`](./reference/qsort-s.md) | Perform a quick sort | +| [`rand`](./reference/rand.md) | [`rand_s`](./reference/rand-s.md) | Generate a pseudorandom number | +| [`scanf`, `_scanf_l`, `wscanf`, `_wscanf_l`](./reference/scanf-scanf-l-wscanf-wscanf-l.md) | [`scanf_s`, `_scanf_s_l`, `wscanf_s`, `_wscanf_s_l`](./reference/scanf-s-scanf-s-l-wscanf-s-wscanf-s-l.md) | Read formatted data from the standard input stream | +| [`_searchenv`, `_wsearchenv`](./reference/searchenv-wsearchenv.md) | [`_searchenv_s`, `_wsearchenv_s`](./reference/searchenv-s-wsearchenv-s.md) | Search for a file using environment paths | +| [`snprintf`, `_snprintf`, `_snprintf_l`, `_snwprintf`, `_snwprintf_l`](./reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md) | [`_snprintf_s`, `_snprintf_s_l`, `_snwprintf_s`, `_snwprintf_s_l`](./reference/snprintf-s-snprintf-s-l-snwprintf-s-snwprintf-s-l.md) | Write formatted data to a string | +| [`_snscanf`, `_snscanf_l`, `_snwscanf`, `_snwscanf_l`](./reference/snscanf-snscanf-l-snwscanf-snwscanf-l.md) | [`_snscanf_s`, `_snscanf_s_l`, `_snwscanf_s`, `_snwscanf_s_l`](./reference/snscanf-s-snscanf-s-l-snwscanf-s-snwscanf-s-l.md) | Read formatted data of a specified length from a string. | +| [`_sopen`, `_wsopen`](./reference/sopen-wsopen.md) | [`_sopen_s`, `_wsopen_s`](./reference/sopen-s-wsopen-s.md) | Open a file for sharing | +| [`_splitpath`, `_wsplitpath`](./reference/splitpath-wsplitpath.md) | [`_splitpath_s`, `_wsplitpath_s`](./reference/splitpath-s-wsplitpath-s.md) | Break a path name into components | +| [`sprintf`, `_sprintf_l`, `swprintf`, `_swprintf_l`, `__swprintf_l`](./reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md) | [`sprintf_s`, `_sprintf_s_l`, `swprintf_s`, `_swprintf_s_l`](./reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md) | Write formatted data to a string | +| [`sscanf`, `_sscanf_l`, `swscanf`, `_swscanf_l`](./reference/sscanf-sscanf-l-swscanf-swscanf-l.md) | [`sscanf_s`, `_sscanf_s_l`, `swscanf_s`, `_swscanf_s_l`](./reference/sscanf-s-sscanf-s-l-swscanf-s-swscanf-s-l.md) | Read formatted data from a string | +| [`strcat`, `wcscat`, `_mbscat`](./reference/strcat-wcscat-mbscat.md) | [`strcat_s`, `wcscat_s`, `_mbscat_s`](./reference/strcat-s-wcscat-s-mbscat-s.md) | Append a string | +| [`strcpy`, `wcscpy`, `_mbscpy`](./reference/strcpy-wcscpy-mbscpy.md) | [`strcpy_s`, `wcscpy_s`, `_mbscpy_s`](./reference/strcpy-s-wcscpy-s-mbscpy-s.md) | Copy a string | +| [`_strdate`, `_wstrdate`](./reference/strdate-wstrdate.md) | [`_strdate_s`, `_wstrdate_s`](./reference/strdate-s-wstrdate-s.md) | Return current system date as string | +| [`strerror`, `_strerror`, `_wcserror`, `__wcserror`](./reference/strerror-strerror-wcserror-wcserror.md) | [`strerror_s`, `_strerror_s`, `_wcserror_s`, `__wcserror_s`](./reference/strerror-s-strerror-s-wcserror-s-wcserror-s.md) | Get a system error message (`strerror`, `_wcserror`) or print a user-supplied error message (`_strerror`, `__wcserror`) | +| [`_strlwr`, `_wcslwr`, `_mbslwr`, `_strlwr_l`, `_wcslwr_l`, `_mbslwr_l`](./reference/strlwr-wcslwr-mbslwr-strlwr-l-wcslwr-l-mbslwr-l.md) | [`_strlwr_s`, `_strlwr_s_l`, `_mbslwr_s`, `_mbslwr_s_l`, `_wcslwr_s`, `_wcslwr_s_l`](./reference/strlwr-s-strlwr-s-l-mbslwr-s-mbslwr-s-l-wcslwr-s-wcslwr-s-l.md) | Convert a string to lowercase | +| [`strncat`, `_strncat_l`, `wcsncat`, `_wcsncat_l`, `_mbsncat`, `_mbsncat_l`](./reference/strncat-strncat-l-wcsncat-wcsncat-l-mbsncat-mbsncat-l.md) | [`strncat_s`, `_strncat_s_l`, `wcsncat_s`, `_wcsncat_s_l`, `_mbsncat_s`, `_mbsncat_s_l`](./reference/strncat-s-strncat-s-l-wcsncat-s-wcsncat-s-l-mbsncat-s-mbsncat-s-l.md) | Append characters to a string | +| [`strncpy`, `_strncpy_l`, `wcsncpy`, `_wcsncpy_l`, `_mbsncpy`, `_mbsncpy_l`](./reference/strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md) | [`strncpy_s`, `_strncpy_s_l`, `wcsncpy_s`, `_wcsncpy_s_l`, `_mbsncpy_s`, `_mbsncpy_s_l`](./reference/strncpy-s-strncpy-s-l-wcsncpy-s-wcsncpy-s-l-mbsncpy-s-mbsncpy-s-l.md) | Copy characters of one string to another | +| [`_strnset`, `_strnset_l`, `_wcsnset`, `_wcsnset_l`, `_mbsnset`, `_mbsnset_l`](./reference/strnset-strnset-l-wcsnset-wcsnset-l-mbsnset-mbsnset-l.md) | [`_strnset_s`, `_strnset_s_l`, `_wcsnset_s`, `_wcsnset_s_l`, `_mbsnset_s`, `_mbsnset_s_l`](./reference/strnset-s-strnset-s-l-wcsnset-s-wcsnset-s-l-mbsnset-s-mbsnset-s-l.md) | Set the first n characters of a string to the specified character | +| [`_strset`, `_strset_l`, `_wcsset`, `_wcsset_l`, `_mbsset`, `_mbsset_l`](./reference/strset-strset-l-wcsset-wcsset-l-mbsset-mbsset-l.md) | [`_strset_s`, `_strset_s_l`, `_wcsset_s`, `_wcsset_s_l`, `_mbsset_s`, `_mbsset_s_l`](./reference/strset-s-strset-s-l-wcsset-s-wcsset-s-l-mbsset-s-mbsset-s-l.md) | Set all the characters of a string to the specified character | +| [`_strtime`, `_wstrtime`](./reference/strtime-wstrtime.md) | [`_strtime_s`, `_wstrtime_s`](./reference/strtime-s-wstrtime-s.md) | Return current system time as string | +| [`strtok`, `_strtok_l`, `wcstok`, `_wcstok_l`, `_mbstok`, `_mbstok_l`](./reference/strtok-strtok-l-wcstok-wcstok-l-mbstok-mbstok-l.md) | [`strtok_s`, `_strtok_s_l`, `wcstok_s`, `_wcstok_s_l`, `_mbstok_s`, `_mbstok_s_l`](./reference/strtok-s-strtok-s-l-wcstok-s-wcstok-s-l-mbstok-s-mbstok-s-l.md) | Find the next token in a string, using the current locale or a locale passed in | +| [`_strupr`, `_strupr_l`, `_mbsupr`, `_mbsupr_l`, `_wcsupr_l`, `_wcsupr`](./reference/strupr-strupr-l-mbsupr-mbsupr-l-wcsupr-l-wcsupr.md) | [`_strupr_s`, `_strupr_s_l`, `_mbsupr_s`, `_mbsupr_s_l`, `_wcsupr_s`, `_wcsupr_s_l`](./reference/strupr-s-strupr-s-l-mbsupr-s-mbsupr-s-l-wcsupr-s-wcsupr-s-l.md) | Convert a string to uppercase | +| [`tmpfile`](./reference/tmpfile.md) | [`tmpfile_s`](./reference/tmpfile-s.md) | Create a temporary file | +| [`_tempnam`, `_wtempnam`, `tmpnam`, `_wtmpnam`](./reference/tempnam-wtempnam-tmpnam-wtmpnam.md) | [`tmpnam_s`, `_wtmpnam_s`](./reference/tmpnam-s-wtmpnam-s.md) | Generate names you can use to create temporary files | +| [`_umask`](./reference/umask.md) | [`_umask_s`](./reference/umask-s.md) | Set the default file-permission mask | +| [`_vcprintf`, `_vcprintf_l`, `_vcwprintf`, `_vcwprintf_l`](./reference/vcprintf-vcprintf-l-vcwprintf-vcwprintf-l.md) | [`_vcprintf_s`, `_vcprintf_s_l`, `_vcwprintf_s`, `_vcwprintf_s_l`](./reference/vcprintf-s-vcprintf-s-l-vcwprintf-s-vcwprintf-s-l.md) | Write formatted output to the console using a pointer to a list of arguments | +| [`vfprintf`, `_vfprintf_l`, `vfwprintf`, `_vfwprintf_l`](./reference/vfprintf-vfprintf-l-vfwprintf-vfwprintf-l.md) | [`vfprintf_s`, `_vfprintf_s_l`, `vfwprintf_s`, `_vfwprintf_s_l`](./reference/vfprintf-s-vfprintf-s-l-vfwprintf-s-vfwprintf-s-l.md) | Write formatted output using a pointer to a list of arguments | +| [`vfscanf`, `vfwscanf`](./reference/vfscanf-vfwscanf.md) | [`vfscanf_s`, `vfwscanf_s`](./reference/vfscanf-s-vfwscanf-s.md) | Read formatted data from a stream | +| [`vprintf`, `_vprintf_l`, `vwprintf`, `_vwprintf_l`](./reference/vprintf-vprintf-l-vwprintf-vwprintf-l.md) | [`vprintf_s`, `_vprintf_s_l`, `vwprintf_s`, `_vwprintf_s_l`](./reference/vprintf-s-vprintf-s-l-vwprintf-s-vwprintf-s-l.md) | Write formatted output using a pointer to a list of arguments | +| [`vscanf`, `vwscanf`](./reference/vscanf-vwscanf.md) | [`vscanf_s`, `vwscanf_s`](./reference/vscanf-s-vwscanf-s.md) | Read formatted data from the standard input stream | +| [`vsnprintf`, `_vsnprintf`, `_vsnprintf_l`, `_vsnwprintf`, `_vsnwprintf_l`](./reference/vsnprintf-vsnprintf-vsnprintf-l-vsnwprintf-vsnwprintf-l.md) | [`vsnprintf_s`, `_vsnprintf_s`, `_vsnprintf_s_l`, `_vsnwprintf_s`, `_vsnwprintf_s_l`](./reference/vsnprintf-s-vsnprintf-s-vsnprintf-s-l-vsnwprintf-s-vsnwprintf-s-l.md) | Write formatted output using a pointer to a list of arguments | +| [`vsprintf`, `_vsprintf_l`, `vswprintf`, `_vswprintf_l`, `__vswprintf_l`](./reference/vsprintf-vsprintf-l-vswprintf-vswprintf-l-vswprintf-l.md) | [`vsprintf_s`, `_vsprintf_s_l`, `vswprintf_s`, `_vswprintf_s_l`](./reference/vsprintf-s-vsprintf-s-l-vswprintf-s-vswprintf-s-l.md) | Write formatted output using a pointer to a list of arguments | +| [`vsscanf`, `vswscanf`](./reference/vsscanf-vswscanf.md) | [`vsscanf_s`, `vswscanf_s`](./reference/vsscanf-s-vswscanf-s.md) | Read formatted data from a string | +| [`wcrtomb`](./reference/wcrtomb.md) | [`wcrtomb_s`](./reference/wcrtomb-s.md) | Convert a wide character into its multibyte character representation | +| [`wcsrtombs`](./reference/wcsrtombs.md) | [`wcsrtombs_s`](./reference/wcsrtombs-s.md) | Convert a wide character string to its multibyte character string representation | +| [`wcstombs`, `_wcstombs_l`](./reference/wcstombs-wcstombs-l.md) | [`wcstombs_s`, `_wcstombs_s_l`](./reference/wcstombs-s-wcstombs-s-l.md) | Convert a sequence of wide characters to a corresponding sequence of multibyte characters | +| [`wctomb`, `_wctomb_l`](./reference/wctomb-wctomb-l.md) | [`wctomb_s`, `_wctomb_s_l`](./reference/wctomb-s-wctomb-s-l.md) | Convert a wide character to the corresponding multibyte character | ## See also diff --git a/docs/c-runtime-library/set-app-type.md b/docs/c-runtime-library/set-app-type.md index d4ed2b14065..a7edb0868e6 100644 --- a/docs/c-runtime-library/set-app-type.md +++ b/docs/c-runtime-library/set-app-type.md @@ -33,11 +33,11 @@ void __cdecl _set_app_type( *`appType`*\ A value that indicates the application type. The possible values are: -|Value|Description| -|----------------|-----------------| -|_crt_unknown_app|Unknown application type.| -|_crt_console_app|Console (command-line) application.| -|_crt_gui_app|GUI (Windows) application.| +| Value | Description | +|---|---| +| `_crt_unknown_app` | Unknown application type. | +| `_crt_console_app` | Console (command-line) application. | +| `_crt_gui_app` | GUI (Windows) application. | ## Remarks @@ -47,6 +47,6 @@ By default, this function's global state is scoped to the application. To change ## Requirements -|Routine|Required header| -|-------------|---------------------| -|_set_app_type|process.h| +| Routine | Required header | +|---|---| +| **`_set_app_type`** | `` | diff --git a/docs/c-runtime-library/set-output-format.md b/docs/c-runtime-library/set-output-format.md index c1d050bc01c..551c5d90e08 100644 --- a/docs/c-runtime-library/set-output-format.md +++ b/docs/c-runtime-library/set-output-format.md @@ -19,7 +19,7 @@ Customizes output formats used by formatted I/O functions. ## Syntax -``` +```C unsigned int _set_output_format( unsigned int format ); @@ -36,17 +36,17 @@ The previous output format. ## Remarks -`_set_output_format` is used to configure the output of formatted I/O functions such as [`printf_s`](./reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md). The only formatting convention that can be changed by this function is the number of digits displayed in exponents in the output of floating point numbers. +**`_set_output_format`** is used to configure the output of formatted I/O functions such as [`printf_s`](./reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md). The only formatting convention that can be changed by this function is the number of digits displayed in exponents in the output of floating point numbers. -By default, the output of floating point numbers by functions such as `printf_s`, `wprintf_s`, and related functions in the Visual C++ Standard C library prints three digits for the exponent, even if three digits aren't required to represent the value of the exponent. Zeroes are used to pad the value to three digits. `_set_output_format` allows you to change this behavior so that only two digits are printed in the exponent unless a third digit is required by the size of the exponent. +By default, the output of floating point numbers by functions such as `printf_s`, `wprintf_s`, and related functions in the Visual C++ Standard C library prints three digits for the exponent, even if three digits aren't required to represent the value of the exponent. Zeroes are used to pad the value to three digits. **`_set_output_format`** allows you to change this behavior so that only two digits are printed in the exponent unless a third digit is required by the size of the exponent. To enable two-digit exponents, call this function with the parameter `_TWO_DIGIT_EXPONENT`, as shown in the example. To disable two digit exponents, call this function with an argument of 0. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`_set_output_format`|\| +| Routine | Required header | +|---|---| +| **`_set_output_format`** | \ | For more compatibility information, see [Compatibility](./compatibility.md) in the Introduction. diff --git a/docs/c-runtime-library/setjmp3.md b/docs/c-runtime-library/setjmp3.md index 46352b7e2cb..7be5c11b77c 100644 --- a/docs/c-runtime-library/setjmp3.md +++ b/docs/c-runtime-library/setjmp3.md @@ -16,7 +16,7 @@ Internal CRT function. A new implementation of the `setjmp` function. ## Syntax -``` +```C int _setjmp3( OUT jmp_buf env, int count, diff --git a/docs/c-runtime-library/setlc-active-func-unguarded-readlc-active-add-func.md b/docs/c-runtime-library/setlc-active-func-unguarded-readlc-active-add-func.md index 6677c9a3edb..b725aaed44c 100644 --- a/docs/c-runtime-library/setlc-active-func-unguarded-readlc-active-add-func.md +++ b/docs/c-runtime-library/setlc-active-func-unguarded-readlc-active-add-func.md @@ -27,13 +27,13 @@ The value returned isn't significant. ## Remarks -Although the internal CRT functions `___setlc_active_func` and `___unguarded_readlc_active_add_func` are obsolete and no longer used, they're exported by the CRT library to preserve binary compatibility. The original purpose of `___setlc_active_func` was to return the number of currently active calls to the `setlocale` function. The original purpose of `___unguarded_readlc_active_add_func` was to return the number of functions that referenced the locale without locking it. +Although the internal CRT functions **`___setlc_active_func`** and **`___unguarded_readlc_active_add_func`** are obsolete and no longer used, they're exported by the CRT library to preserve binary compatibility. The original purpose of **`___setlc_active_func`** was to return the number of currently active calls to the `setlocale` function. The original purpose of **`___unguarded_readlc_active_add_func`** was to return the number of functions that referenced the locale without locking it. ## Requirements -|Routine|Required header| -|-------------|---------------------| -|`___setlc_active_func`, `___unguarded_readlc_active_add_func`|none| +| Routine | Required header | +|---|---| +| **`___setlc_active_func`**, **`___unguarded_readlc_active_add_func`** | none | ## See also diff --git a/docs/c-runtime-library/setusermatherr.md b/docs/c-runtime-library/setusermatherr.md index ce0cbd725e1..16a9bc0757f 100644 --- a/docs/c-runtime-library/setusermatherr.md +++ b/docs/c-runtime-library/setusermatherr.md @@ -33,6 +33,6 @@ The type of the *`pf`* parameter is declared as `typedef int (__cdecl * _HANDLE_ ## Requirements -|Routine|Required header| -|-------------|---------------------| -|__setusermatherr|matherr.c| +| Routine | Required header | +|---|---| +| **`__setusermatherr`** | `matherr.c` | diff --git a/docs/c-runtime-library/setvbuf-constants.md b/docs/c-runtime-library/setvbuf-constants.md index 4f440c1143e..a9a6965f71f 100644 --- a/docs/c-runtime-library/setvbuf-constants.md +++ b/docs/c-runtime-library/setvbuf-constants.md @@ -10,7 +10,7 @@ ms.assetid: a6ec4dd5-1f24-498c-871a-e874cd28d33c ## Syntax -``` +```C #include ``` @@ -20,11 +20,11 @@ These constants represent the type of buffer for `setvbuf`. The possible values are given by the following manifest constants: -|Constant|Meaning| -|--------------|-------------| -|`_IOFBF`|Full buffering: Buffer specified in call to `setvbuf` is used and its size is as specified in `setvbuf` call. If buffer pointer is `NULL`, automatically allocated buffer of specified size is used.| -|`_IOLBF`|Same as `_IOFBF`.| -|`_IONBF`|No buffer is used, regardless of arguments in call to `setvbuf`.| +| Constant | Meaning | +|---|---| +| `_IOFBF` | Full buffering: Buffer specified in call to `setvbuf` is used and its size is as specified in `setvbuf` call. If buffer pointer is `NULL`, automatically allocated buffer of specified size is used. | +| `_IOLBF` | Same as `_IOFBF`. | +| `_IONBF` | No buffer is used, regardless of arguments in call to `setvbuf`. | ## See also diff --git a/docs/c-runtime-library/sharing-constants.md b/docs/c-runtime-library/sharing-constants.md index ff469c6d47e..887ae56c88c 100644 --- a/docs/c-runtime-library/sharing-constants.md +++ b/docs/c-runtime-library/sharing-constants.md @@ -12,7 +12,7 @@ Constants for file-sharing modes. ## Syntax -``` +```C #include ``` @@ -22,13 +22,13 @@ The *`shflag`* argument determines the sharing mode, which consists of one or mo The following table lists the constants and their meanings: -|Constant|Meaning| -|--------------|-------------| -|`_SH_DENYRW`|Denies read and write access to file| -|`_SH_DENYWR`|Denies write access to file| -|`_SH_DENYRD`|Denies read access to file| -|`_SH_DENYNO`|Permits read and write access| -|`_SH_SECURE`|Sets secure mode (shared read, exclusive write access).| +| Constant | Meaning | +|---|---| +| `_SH_DENYRW` | Denies read and write access to file | +| `_SH_DENYWR` | Denies write access to file | +| `_SH_DENYRD` | Denies read access to file | +| `_SH_DENYNO` | Permits read and write access | +| `_SH_SECURE` | Sets secure mode (shared read, exclusive write access). | ## See also diff --git a/docs/c-runtime-library/signal-action-constants.md b/docs/c-runtime-library/signal-action-constants.md index fb30a59353c..13bbfc980c0 100644 --- a/docs/c-runtime-library/signal-action-constants.md +++ b/docs/c-runtime-library/signal-action-constants.md @@ -12,7 +12,7 @@ The action taken when the interrupt signal is received depends on the value of ` ## Syntax -``` +```C #include ``` @@ -20,13 +20,13 @@ The action taken when the interrupt signal is received depends on the value of ` The `func` argument must be either a function address or one of the manifest constants listed below and defined in SIGNAL.H. -|Constant|Description| -|-|-| -| `SIG_DFL` | Uses system-default response. If the calling program uses stream I/O, buffers created by the run-time library aren't flushed. | -| `SIG_IGN` | Ignores interrupt signal. This value should never be given for `SIGFPE`, since the floating-point state of the process is left undefined. | -| `SIG_SGE` | Indicates an error occurred in the signal. | -| `SIG_ACK` | Indicates an acknowledgment was received. | -| `SIG_ERR` | A return type from a signal indicating an error has occurred. | +| Constant | Description | +|---|---| +| `SIG_DFL` | Uses system-default response. If the calling program uses stream I/O, buffers created by the run-time library aren't flushed. | +| `SIG_IGN` | Ignores interrupt signal. This value should never be given for `SIGFPE`, since the floating-point state of the process is left undefined. | +| `SIG_SGE` | Indicates an error occurred in the signal. | +| `SIG_ACK` | Indicates an acknowledgment was received. | +| `SIG_ERR` | A return type from a signal indicating an error has occurred. | ## See also diff --git a/docs/c-runtime-library/signal-constants.md b/docs/c-runtime-library/signal-constants.md index 977599a568d..0618aab2a5c 100644 --- a/docs/c-runtime-library/signal-constants.md +++ b/docs/c-runtime-library/signal-constants.md @@ -10,7 +10,7 @@ ms.assetid: a3b39281-dae7-4e44-8d68-e6a610c669dd ## Syntax -``` +```C #include ``` @@ -18,16 +18,16 @@ ms.assetid: a3b39281-dae7-4e44-8d68-e6a610c669dd The `sig` argument must be one of the manifest constants listed below (defined in SIGNAL.H). -|Constant|Description| -|-|-| -|SIGABRT|Abnormal termination. The default action terminates the calling program with exit code 3. | -|SIGABRT_COMPAT|Same as SIGABRT. For compatibility with other platforms. | -|SIGFPE|Floating-point error, such as overflow, division by zero, or invalid operation. The default action terminates the calling program. | -|SIGILL|Illegal instruction. The default action terminates the calling program. | -|SIGINT|CTRL+C interrupt. The default action terminates the calling program with exit code 3. | -|SIGSEGV|Illegal storage access. The default action terminates the calling program. | -|SIGTERM|Termination request sent to the program. The default action terminates the calling program with exit code 3. | -|SIG_ERR|A return type from a signal indicating an error has occurred. | +| Constant | Description | +|---|---| +| `SIGABRT` | Abnormal termination. The default action terminates the calling program with exit code 3. | +| `SIGABRT_COMPAT` | Same as `SIGABRT`. For compatibility with other platforms. | +| `SIGFPE` | Floating-point error, such as overflow, division by zero, or invalid operation. The default action terminates the calling program. | +| `SIGILL` | Illegal instruction. The default action terminates the calling program. | +| `SIGINT` | CTRL+C interrupt. The default action terminates the calling program with exit code 3. | +| `SIGSEGV` | Illegal storage access. The default action terminates the calling program. | +| `SIGTERM` | Termination request sent to the program. The default action terminates the calling program with exit code 3. | +| `SIG_ERR` | A return type from a signal indicating an error has occurred. | ## See also diff --git a/docs/c-runtime-library/spawn-constants.md b/docs/c-runtime-library/spawn-constants.md index bf43282b0db..b31b2decbf5 100644 --- a/docs/c-runtime-library/spawn-constants.md +++ b/docs/c-runtime-library/spawn-constants.md @@ -10,7 +10,7 @@ ms.assetid: e0533e88-d362-46fc-b53c-5f193226d879 ## Syntax -``` +```C #include ``` @@ -18,12 +18,12 @@ ms.assetid: e0533e88-d362-46fc-b53c-5f193226d879 The `mode` argument determines the action taken by the calling process before and during a spawn operation. The following values for `mode` are possible: -|Constant|Meaning| -|--------------|-------------| -|`_P_OVERLAY`|Overlays calling process with new process, destroying calling process (same effect as `_exec` calls).| -|`_P_WAIT`|Suspends calling thread until execution of new process is complete (synchronous `_spawn`).| -|`_P_NOWAIT`, `_P_NOWAITO`|Continues to execute calling process concurrently with new process (asynchronous `_spawn`).| -|`_P_DETACH`|Continues to execute calling process; new process is run in background with no access to console or keyboard. Calls to `_cwait` against new process will fail. This `_spawn` is asynchronous.| +| Constant | Meaning | +|---|---| +| `_P_OVERLAY` | Overlays calling process with new process, destroying calling process (same effect as `_exec` calls). | +| `_P_WAIT` | Suspends calling thread until execution of new process is complete (synchronous `_spawn`). | +| `_P_NOWAIT`, `_P_NOWAITO` | Continues to execute calling process concurrently with new process (asynchronous `_spawn`). | +| `_P_DETACH` | Continues to execute calling process; new process is run in background with no access to console or keyboard. Calls to `_cwait` against new process will fail. This `_spawn` is asynchronous. | ## See also diff --git a/docs/c-runtime-library/spawn-wspawn-functions.md b/docs/c-runtime-library/spawn-wspawn-functions.md index 9920bba06be..e05d4f36573 100644 --- a/docs/c-runtime-library/spawn-wspawn-functions.md +++ b/docs/c-runtime-library/spawn-wspawn-functions.md @@ -29,12 +29,12 @@ Each of the `_spawn` functions creates and executes a new process: The letters at the end of the function name determine the variation. -|Letter|Variant| -|-|-| -| `e` | `envp`, array of pointers to environment settings, is passed to new process. | -| `l` | Command-line arguments are passed individually to `_spawn` function. This suffix is typically used when some parameters to a new process are known in advance. | -| `p` | `PATH` environment variable is used to find the file to execute. | -| `v` | `argv`, array of pointers to command-line arguments, is passed to `_spawn` function. This suffix is typically used when several parameters to a new process are variable. | +| Letter | Variant | +|---|---| +| `e` | `envp`, array of pointers to environment settings, is passed to new process. | +| `l` | Command-line arguments are passed individually to `_spawn` function. This suffix is typically used when some parameters to a new process are known in advance. | +| `p` | `PATH` environment variable is used to find the file to execute. | +| `v` | `argv`, array of pointers to command-line arguments, is passed to `_spawn` function. This suffix is typically used when several parameters to a new process are variable. | ## Remarks @@ -42,25 +42,25 @@ The `_spawn` functions each create and execute a new process. They automatically ### Generic-text routine mappings -|`Tchar.h` routine|`_UNICODE` and `_MBCS` not defined|`_MBCS` defined|`_UNICODE` defined| -|---------------------|--------------------------------------|--------------------|-----------------------| -|`_tspawnl`|`_spawnl`|`_spawnl`|`_wspawnl`| -|`_tspawnle`|`_spawnle`|`_spawnle`|`_wspawnle`| -|`_tspawnlp`|`_spawnlp`|`_spawnlp`|`_wspawnlp`| -|`_tspawnlpe`|`_spawnlpe`|`_spawnlpe`|`_wspawnlpe`| -|`_tspawnv`|`_spawnv`|`_spawnv`|`_wspawnv`| -|`_tspawnve`|`_spawnve`|`_spawnve`|`_wspawnve`| -|`_tspawnvp`|`_spawnvp`|`_spawnvp`|`_wspawnvp`| -|`_tspawnvpe`|`_spawnvpe`|`_spawnvpe`|`_wspawnvpe`| +| `Tchar.h` routine | `_UNICODE` and `_MBCS` not defined | `_MBCS` defined | `_UNICODE` defined | +|---|---|---|---| +| `_tspawnl` | `_spawnl` | `_spawnl` | `_wspawnl` | +| `_tspawnle` | `_spawnle` | `_spawnle` | `_wspawnle` | +| `_tspawnlp` | `_spawnlp` | `_spawnlp` | `_wspawnlp` | +| `_tspawnlpe` | `_spawnlpe` | `_spawnlpe` | `_wspawnlpe` | +| `_tspawnv` | `_spawnv` | `_spawnv` | `_wspawnv` | +| `_tspawnve` | `_spawnve` | `_spawnve` | `_wspawnve` | +| `_tspawnvp` | `_spawnvp` | `_spawnvp` | `_wspawnvp` | +| `_tspawnvpe` | `_spawnvpe` | `_spawnvpe` | `_wspawnvpe` | Enough memory must be available for loading and executing the new process. The `mode` argument determines the action taken by the calling process before and during `_spawn`. The following values for `mode` are defined in `Process.h`: -|Value|Description| -|-|-| -| `_P_OVERLAY` | Overlays a calling process with a new process, destroying the calling process (same effect as `_exec` calls). | -| `_P_WAIT` | Suspends a calling thread until execution of the new process is complete (synchronous `_spawn`). | -| `_P_NOWAIT` or `_P_NOWAITO` | Continues to execute a calling process concurrently with the new process (asynchronous `_spawn`). | -| `_P_DETACH` | Continues to execute the calling process; the new process is run in the background with no access to the console or keyboard. Calls to `_cwait` against the new process fail (asynchronous `_spawn`). | +| Value | Description | +|---|---| +| `_P_OVERLAY` | Overlays a calling process with a new process, destroying the calling process (same effect as `_exec` calls). | +| `_P_WAIT` | Suspends a calling thread until execution of the new process is complete (synchronous `_spawn`). | +| `_P_NOWAIT` or `_P_NOWAITO` | Continues to execute a calling process concurrently with the new process (asynchronous `_spawn`). | +| `_P_DETACH` | Continues to execute the calling process; the new process is run in the background with no access to the console or keyboard. Calls to `_cwait` against the new process fail (asynchronous `_spawn`). | The `cmdname` argument specifies the file that is executed as the new process and can specify a full path (from the root), a partial path (from the current working directory), or just a file name. If `cmdname` doesn't have a file name extension or doesn't end with a period (.), the `_spawn` function first tries the .com file name extension and then the .exe file name extension, the .bat file name extension, and finally the .cmd file name extension. diff --git a/docs/c-runtime-library/standard-types.md b/docs/c-runtime-library/standard-types.md index e707c6e855a..31a35b082c6 100644 --- a/docs/c-runtime-library/standard-types.md +++ b/docs/c-runtime-library/standard-types.md @@ -12,85 +12,85 @@ The Microsoft run-time library defines the following standard types and typedefs ### Fixed-width integral types (`stdint.h`) -|Name|Equivalent built-in type| -|----------|-------------------------------| -|`int8_t`, `uint8_t`|`signed char`, `unsigned char`| -|`int16_t`, `uint16_t`|`short`, `unsigned short`| -|`int32_t`, `uint32_t`|`int`, `unsigned int`| -|`int64_t`, `uint64_t`|`long long`, `unsigned long long`| -|`int_least8_t`, `uint_least8_t`|`signed char`, `unsigned char`| -|`int_least16_t`, `uint_least16_t`|`short`, `unsigned short`| -|`int_least32_t`, `uint_least32_t`|`int`, `unsigned int`| -|`int_least64_t`, `uint_least64_t`|`long long`, `unsigned long long`| -|`int_fast8_t`, `uint_fast8_t`|`signed char`, `unsigned char`| -|`int_fast16_t`, `uint_fast16_t`|`int`, `unsigned int`| -|`int_fast32_t`, `uint_fast32_t`|`int`, `unsigned int`| -|`int_fast64_t`, `uint_fast64_t`|`long long`, `unsigned long long`| -|`intmax_t`, `uintmax_t`|`long long`, `unsigned long long`| +| Name | Equivalent built-in type | +|---|---| +| `int8_t`, `uint8_t` | `signed char`, `unsigned char` | +| `int16_t`, `uint16_t` | `short`, `unsigned short` | +| `int32_t`, `uint32_t` | `int`, `unsigned int` | +| `int64_t`, `uint64_t` | `long long`, `unsigned long long` | +| `int_least8_t`, `uint_least8_t` | `signed char`, `unsigned char` | +| `int_least16_t`, `uint_least16_t` | `short`, `unsigned short` | +| `int_least32_t`, `uint_least32_t` | `int`, `unsigned int` | +| `int_least64_t`, `uint_least64_t` | `long long`, `unsigned long long` | +| `int_fast8_t`, `uint_fast8_t` | `signed char`, `unsigned char` | +| `int_fast16_t`, `uint_fast16_t` | `int`, `unsigned int` | +| `int_fast32_t`, `uint_fast32_t` | `int`, `unsigned int` | +| `int_fast64_t`, `uint_fast64_t` | `long long`, `unsigned long long` | +| `intmax_t`, `uintmax_t` | `long long`, `unsigned long long` | -|Type|Description|Declared in| -|----------|-----------------|-----------------| -|`clock_t` (long)|Stores time values; used by [`clock`](./reference/clock.md).|`TIME.H`| -|`_complex` structure|Stores real and imaginary parts of complex numbers; used by [`_cabs`](./reference/cabs.md).|`MATH.H`| -|`_CRT_ALLOC_HOOK`|A type definition for the user-defined hook function. Used in [`_CrtSetAllocHook`](./reference/crtsetallochook.md).|`CRTDBG.H`| -|`_CRT_DUMP_CLIENT`,

`_CRT_DUMP_CLIENT_M`|A type definition for a call-back function that will get called in [`_CrtMemDumpAllObjectsSince`](./reference/crtmemdumpallobjectssince.md).|`CRTDBG.H`| -|`_CrtMemState` structure|Provides information about the current state of the C run-time debug heap.|`CRTDBG.H`| -|`_CRT_REPORT_HOOK`,

`_CRT_REPORT_HOOKW`,

`_CRT_REPORT_HOOKW_M`|A type definition for a call-back function that will get called in [`_CrtDbgReport`](./reference/crtdbgreport-crtdbgreportw.md).

The parameters for this function are: report type, output message and the return value from the call-back function.|`CRTDBG.H`| -|`dev_t`, `_dev_t` short or unsigned integer|Represents device handles.|`SYS\TYPES.H`| -|`_diskfree_t` structure|Contains information about a disk drive. Used by [`_getdiskfree`](./reference/getdiskfree.md)**.**|`DOS.H` and `DIRECT.H`| -|`div_t`, `ldiv_t` and `lldiv_t` structures|Store values returned by [`div`](reference/div.md), [`ldiv`](./reference/div.md), and [`lldiv`](./reference/div.md), respectively.|`STDLIB.H`| -|`errno_t` integer|Used for a function return type or parameter that deals with the error codes of `errno`.|`STDDEF.H`,

`CRTDEFS.H`| -|`_exception` structure|Stores error information for [`_matherr`](./reference/matherr.md).|`MATH.H`| -|`_EXCEPTION_POINTERS`|Contains an exception record. For more information, see [`EXCEPTION_POINTERS`](/windows/win32/api/winnt/ns-winnt-exception_pointers).|`FPIEEE.H`| -|`FILE` structure|Stores information about current state of stream; used in all stream I/O operations.|`STDIO.H`| -|`_finddata_t`, `_wfinddata_t`, `_finddata32_t`, `_wfinddata32_t`, `_finddatai64_t`, `_wfinddatai64_t`, `__finddata64_t`, `__wfinddata64_t`, `__finddata32i64_t`, `__wfinddata32i64_t`, `__finddata64i32_t`, `__wfinddata64i32_t` structures|Store file-attribute information returned by [`_findfirst`, `_wfindfirst`, and related functions](./reference/findfirst-functions.md) and [`_findnext`, `_wfindnext` and related functions](./reference/findnext-functions.md). See [Filename search functions](./filename-search-functions.md) for information on structure members.|`IO.H`, `WCHAR.H`| -|`_FPIEEE_RECORD` structure|Contains information pertaining to IEEE floating-point exception; passed to user-defined trap handler by [`_fpieee_flt`](./reference/fpieee-flt.md).|`FPIEEE.H`| -|`fpos_t` (`long integer`, **`__int64`**, or structure, depending on the target platform)|Used by [`fgetpos`](./reference/fgetpos.md) and [`fsetpos`](./reference/fsetpos.md) to record information for uniquely specifying every position within a file.|`STDIO.H`| -|`_fsize_t` (`unsigned long integer`)|Used to represent the size of a file.|`IO.H`,

`WCHAR.H`| -|`_HEAPINFO` structure|Contains information about next heap entry for [`_heapwalk`](./reference/heapwalk.md).|`MALLOC.H`| -|`_HFILE` (void \*)|An operating system file handle.|`CRTDBG.H`| -|`imaxdiv_t`|The type of value that's returned by the [`imaxdiv`](./reference/imaxdiv.md) function, containing both the quotient and the remainder.|`inttypes.h`| -|`ino_t`, `_ino_t` (`unsigned short`)|For returning status information.|`WCHAR.H`| -|`intmax_t`|A signed integer type capable of representing any value of any signed integer type.|stdint.h| -|`intptr_t` (`long integer` or **`__int64`**, depending on the target platform)|Stores a pointer (or `HANDLE`) on both Win32 and Win64 platforms.|`STDDEF.H` and other include files| -|`jmp_buf` array|Used by [`setjmp`](./reference/setjmp.md) and [`longjmp`](./reference/longjmp.md) to save and restore program environment.|`SETJMP.H`| -|`lconv` structure|Contains formatting rules for numeric values in different countries/regions. Used by [`localeconv`](./reference/localeconv.md).|`LOCALE.H`| -|`_LDOUBLE`,

`_LONGDOUBLE`,

`_LDBL12` (long double or an unsigned char array)|Use to represent a long double value.|`STDLIB.H`| -|`_locale_t` structure|Stores current locale values; used in all locale specific C run-time libraries.|`CRTDEFS.H`| -|`mbstate_t`|Tracks the state of a multibyte character conversion.|`WCHAR.H`| -|`off_t`, `_off_t` `long integer`|Represents file-offset value.|`WCHAR.H`, `SYS\TYPES.H`| -|`_onexit_t`,

`_onexit_m_t` pointer|Returned by [`_onexit`, `_onexit_m`](./reference/onexit-onexit-m.md).|`STDLIB.H`| -|`_PNH` pointer to function|Type of argument to [`_set_new_handler`](./reference/set-new-handler.md).|`NEW.H`| -|`ptrdiff_t` (long integer or **`__int64`**, depending on the target platform)|Result of subtraction of two pointers.|`CRTDEFS.H`| -|`_purecall_handler`,

`_purecall_handler_m`|A type definition for a call-back function that is called when a pure virtual function is called. Used by [`_get_purecall_handler`, _set_purecall_handler](./reference/get-purecall-handler-set-purecall-handler.md). A `_purecall_handler` function should have a void return type.|`STDLIB.H`| -|`_RTC_error_fn` type definition|A type definition for a function that will handle run-time error checks. Used in [`_RTC_SetErrorFunc`](./reference/rtc-seterrorfunc.md).|`RTCAPI.H`| -|`_RTC_error_fnW` type definition|A type definition for a function that will handle run-time error checks. Used in [`_RTC_SetErrorFuncW`](./reference/rtc-seterrorfuncw.md).|`RTCAPI.H`| -|`_RTC_ErrorNumber` enumeration|Defines error conditions for [`_RTC_GetErrDesc`](./reference/rtc-geterrdesc.md) and [`_RTC_SetErrorType`](./reference/rtc-seterrortype.md).|`RTCAPI.H`| -|`_se_translator_function`|A type definition for a call-back function that translates an exception. The first parameter is the exception code and the second parameter is the exception record. Used by [`_set_se_translator`](./reference/set-se-translator.md).|`EH.H`| -|`sig_atomic_t` integer|Type of object that can be modified as atomic entity, even in presence of asynchronous interrupts; used with [`signal`](./reference/signal.md).|`SIGNAL.H`| -|`size_t` (`unsigned __int64` or `unsigned integer`, depending on the target platform)|Result of **`sizeof`** operator.|`CRTDEFS.H` and other include files| -|`_stat` structure|Contains file-status information returned by [`_stat`](./reference/stat-functions.md) and [`_fstat`](./reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md).|`SYS\STAT.H`| -|`__stat64` structure|Contains file-status information returned by [`_fstat64`](./reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md) and [`_stat64`](./reference/stat-functions.md), and [`_wstat64`](./reference/stat-functions.md).|`SYS\STAT.H`| -|`_stati64` structure|Contains file-status information returned by [`_fstati64`](./reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md), [`_stati64`](./reference/stat-functions.md), and [`_wstati64`](./reference/stat-functions.md).|`SYS\STAT.H`| -|`terminate_function` type definition|A type definition for a call-back function that is called when [`terminate`](./reference/terminate-crt.md) is called. Used by [`set_terminate`](./reference/set-terminate-crt.md).|`EH.H`| -|`time_t` (`__int64` or `long integer`)|Represents time values in [`mktime`](./reference/mktime-mktime32-mktime64.md), [`time`](./reference/time-time32-time64.md), [`ctime`, `_ctime32`, `_ctime64`, `_wctime`, `_wctime32`, `_wctime64`](./reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md), [`ctime_s`, `_ctime32_s`, `_ctime64_s`, `_wctime_s`, _wctime32_s, _wctime64_s](./reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md), [`ctime`, `_ctime32`, `_ctime64`, `_wctime`, `_wctime32`, `_wctime64`](./reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md) and [`gmtime`, `_gmtime32`, `_gmtime64`](./reference/gmtime-gmtime32-gmtime64.md). The number of seconds since January 1, 1970, 0:00 UTC. If `_USE_32BIT_TIME_T` is defined, `time_t` is a long integer. If not defined, it's a 64-bit integer.|`TIME.H`,

`SYS\STAT.H`,

`SYS\TIMEB.H`| -|`__time32_t` (`long integer`)|Represents time values in [`mktime`, `_mktime32`, `_mktime64`](./reference/mktime-mktime32-mktime64.md), [`ctime`, `_ctime32`, `_ctime64`, `_wctime`, `_wctime32`, `_wctime64`](./reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md), [`ctime_s`, `_ctime32_s`, `_ctime64_s`, `_wctime_s`, `_wctime32_s`, `_wctime64_s`](./reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md), [`gmtime`, `_gmtime32`, `_gmtime64`](./reference/gmtime-gmtime32-gmtime64.md) and [`localtime`, `_localtime32`, `_localtime64`](./reference/localtime-localtime32-localtime64.md).|`CRTDEFS.H`, `SYS\STAT.H`,

`SYS\TIMEB.H`| -|`__time64_t` (**`__int64`**)|Represents time values in [`mktime`, `_mktime32`, `_mktime64`](./reference/mktime-mktime32-mktime64.md), [`_ctime64`, `_wctime64`](./reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md), [`ctime_s`, `_ctime32_s`, `_ctime64_s`, `_wctime_s`, `_wctime32_s`, `_wctime64_s`](./reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md), [`_gmtime64`](./reference/gmtime-gmtime32-gmtime64.md), [`_localtime64`](./reference/localtime-localtime32-localtime64.md) and [`_time64`](./reference/time-time32-time64.md).|`TIME.H`,

`SYS\STAT.H`,

`SYS\TIMEB.H`| -|`_timeb` structure|The [`_ftime`](./reference/ftime-ftime32-ftime64.md) and [`_ftime_s`, `_ftime32_s`, `_ftime64_s`](./reference/ftime-s-ftime32-s-ftime64-s.md) functions use it to store current system time.|`SYS\TIMEB.H`| -|`__timeb32` structure|The [`_ftime`, `_ftime32`, `_ftime64`](./reference/ftime-ftime32-ftime64.md) and [`_ftime_s`, `_ftime32_s`, `_ftime64_s`](./reference/ftime-s-ftime32-s-ftime64-s.md) functions use it to store current system time.|`SYS\TIMEB.H`| -|`__timeb64` structure|The [`_ftime64`](./reference/ftime-ftime32-ftime64.md) and [`_ftime_s`, `_ftime32_s`, `_ftime64_s`](./reference/ftime-s-ftime32-s-ftime64-s.md) functions use it to store current system time.|`SYS\TIMEB.H`| -|`tm` structure|The [`asctime`, `_wasctime`](./reference/asctime-wasctime.md), [`asctime_s`, `_wasctime_s`](./reference/asctime-s-wasctime-s.md), [`gmtime`, `_gmtime32`, `_gmtime64`](./reference/gmtime-gmtime32-gmtime64.md), [`gmtime_s`, `_gmtime32_s`, `_gmtime64_s`](./reference/gmtime-s-gmtime32-s-gmtime64-s.md), [`localtime`, `_localtime32`, `_localtime64`](./reference/localtime-localtime32-localtime64.md), [`localtime_s`, `_localtime32_s`, `_localtime64_s`](./reference/localtime-s-localtime32-s-localtime64-s.md), [`mktime`, `_mktime32`, `_mktime64`](./reference/mktime-mktime32-mktime64.md) and [`strftime`, `wcsftime`, _strftime_l, _wcsftime_l](./reference/strftime-wcsftime-strftime-l-wcsftime-l.md) functions use it to store and retrieve time information.|`TIME.H`| -|`uintmax_t`|An `unsigned integer` type capable of representing any value of any `unsigned integer` type.|`stdint.h`| -|`uintptr_t` (`long integer` or **`__int64`**, depending on the target platform)|An `unsigned integer` or `unsigned __int64` version of `intptr_t`.|`STDDEF.H` and other include files| -|`unexpected_function`|A type definition for a call-back function that is called when [`unexpected`](./reference/unexpected-crt.md) is called. Used by [`set_unexpected`](./reference/set-unexpected-crt.md).|`EH.H`| -|`_utimbuf` structure|Stores file access and modification times used by [`_utime`, `_wutime`](./reference/utime-utime32-utime64-wutime-wutime32-wutime64.md) and [`_futime`, `_futime32`, `_futime64`](./reference/futime-futime32-futime64.md) to change file-modification dates.|`SYS\UTIME.H`| -|`_utimbuf32` structure|Stores file access and modification times used by [`_utime`, `_utime32`, `_utime64`, `_wutime`, `_wutime32`, `_wutime64`](./reference/utime-utime32-utime64-wutime-wutime32-wutime64.md) and [`_futime`, `_futime32`, `_futime64`](./reference/futime-futime32-futime64.md) to change file-modification dates.|`SYS\UTIME.H`| -|`__utimbuf64` structure|The [`_utime64`, `_wutime64`](./reference/utime-utime32-utime64-wutime-wutime32-wutime64.md) and [`_futime64`](./reference/futime-futime32-futime64.md) functions use it to store the current time.|`SYS\UTIME.H`| -|`va_list` structure|Used to hold information needed by [`va_arg`](./reference/va-arg-va-copy-va-end-va-start.md) and [`va_end`](./reference/va-arg-va-copy-va-end-va-start.md) macros. Called function declares variable of type `va_list` that can be passed as argument to another function.|`STDARG.H`,

`CRTDEFS.H`| -|**`wchar_t`** wide character|Useful for writing portable programs for international markets.|`STDDEF.H`, `STDLIB.H`,

`CRTDEFS.H`,

`SYS\STAT.H`| -|`wctrans_t` integer|Represents locale-specific character mappings.|`WCTYPE.H`| -|`wctype_t` integer|Can represent all characters of any language character set.|`WCHAR.H`,

`CRTDEFS.H`| -|`wint_t` integer|Type of data object that can hold any wide character or wide end-of-file value.|`WCHAR.H`,

`CRTDEFS.H`| +| Type | Description | Declared in | +|---|---|---| +| `clock_t` (long) | Stores time values; used by [`clock`](./reference/clock.md). | `TIME.H` | +| `_complex` structure | Stores real and imaginary parts of complex numbers; used by [`_cabs`](./reference/cabs.md). | `MATH.H` | +| `_CRT_ALLOC_HOOK` | A type definition for the user-defined hook function. Used in [`_CrtSetAllocHook`](./reference/crtsetallochook.md). | `CRTDBG.H` | +| `_CRT_DUMP_CLIENT`,

`_CRT_DUMP_CLIENT_M` | A type definition for a call-back function that will get called in [`_CrtMemDumpAllObjectsSince`](./reference/crtmemdumpallobjectssince.md). | `CRTDBG.H` | +| `_CrtMemState` structure | Provides information about the current state of the C run-time debug heap. | `CRTDBG.H` | +| `_CRT_REPORT_HOOK`,

`_CRT_REPORT_HOOKW`,

`_CRT_REPORT_HOOKW_M` | A type definition for a call-back function that will get called in [`_CrtDbgReport`](./reference/crtdbgreport-crtdbgreportw.md).

The parameters for this function are: report type, output message and the return value from the call-back function. | `CRTDBG.H` | +| `dev_t`, `_dev_t` short or unsigned integer | Represents device handles. | `SYS\TYPES.H` | +| `_diskfree_t` structure | Contains information about a disk drive. Used by [`_getdiskfree`](./reference/getdiskfree.md)**.** | `DOS.H` and `DIRECT.H` | +| `div_t`, `ldiv_t` and `lldiv_t` structures | Store values returned by [`div`](reference/div.md), [`ldiv`](./reference/div.md), and [`lldiv`](./reference/div.md), respectively. | `STDLIB.H` | +| `errno_t` integer | Used for a function return type or parameter that deals with the error codes of `errno`. | `STDDEF.H`,

`CRTDEFS.H` | +| `_exception` structure | Stores error information for [`_matherr`](./reference/matherr.md). | `MATH.H` | +| `_EXCEPTION_POINTERS` | Contains an exception record. For more information, see [`EXCEPTION_POINTERS`](/windows/win32/api/winnt/ns-winnt-exception_pointers). | `FPIEEE.H` | +| `FILE` structure | Stores information about current state of stream; used in all stream I/O operations. | `STDIO.H` | +| `_finddata_t`, `_wfinddata_t`, `_finddata32_t`, `_wfinddata32_t`, `_finddatai64_t`, `_wfinddatai64_t`, `__finddata64_t`, `__wfinddata64_t`, `__finddata32i64_t`, `__wfinddata32i64_t`, `__finddata64i32_t`, `__wfinddata64i32_t` structures | Store file-attribute information returned by [`_findfirst`, `_wfindfirst`, and related functions](./reference/findfirst-functions.md) and [`_findnext`, `_wfindnext` and related functions](./reference/findnext-functions.md). See [Filename search functions](./filename-search-functions.md) for information on structure members. | `IO.H`, `WCHAR.H` | +| `_FPIEEE_RECORD` structure | Contains information pertaining to IEEE floating-point exception; passed to user-defined trap handler by [`_fpieee_flt`](./reference/fpieee-flt.md). | `FPIEEE.H` | +| `fpos_t` (`long integer`, **`__int64`**, or structure, depending on the target platform) | Used by [`fgetpos`](./reference/fgetpos.md) and [`fsetpos`](./reference/fsetpos.md) to record information for uniquely specifying every position within a file. | `STDIO.H` | +| `_fsize_t` (`unsigned long integer`) | Used to represent the size of a file. | `IO.H`,

`WCHAR.H` | +| `_HEAPINFO` structure | Contains information about next heap entry for [`_heapwalk`](./reference/heapwalk.md). | `MALLOC.H` | +| `_HFILE` (void \*) | An operating system file handle. | `CRTDBG.H` | +| `imaxdiv_t` | The type of value that's returned by the [`imaxdiv`](./reference/imaxdiv.md) function, containing both the quotient and the remainder. | `inttypes.h` | +| `ino_t`, `_ino_t` (`unsigned short`) | For returning status information. | `WCHAR.H` | +| `intmax_t` | A signed integer type capable of representing any value of any signed integer type. | stdint.h | +| `intptr_t` (`long integer` or **`__int64`**, depending on the target platform) | Stores a pointer (or `HANDLE`) on both Win32 and Win64 platforms. | `STDDEF.H` and other include files | +| `jmp_buf` array | Used by [`setjmp`](./reference/setjmp.md) and [`longjmp`](./reference/longjmp.md) to save and restore program environment. | `SETJMP.H` | +| `lconv` structure | Contains formatting rules for numeric values in different countries/regions. Used by [`localeconv`](./reference/localeconv.md). | `LOCALE.H` | +| `_LDOUBLE`,

`_LONGDOUBLE`,

`_LDBL12` (long double or an unsigned char array) | Use to represent a long double value. | `STDLIB.H` | +| `_locale_t` structure | Stores current locale values; used in all locale specific C run-time libraries. | `CRTDEFS.H` | +| `mbstate_t` | Tracks the state of a multibyte character conversion. | `WCHAR.H` | +| `off_t`, `_off_t` `long integer` | Represents file-offset value. | `WCHAR.H`, `SYS\TYPES.H` | +| `_onexit_t`,

`_onexit_m_t` pointer | Returned by [`_onexit`, `_onexit_m`](./reference/onexit-onexit-m.md). | `STDLIB.H` | +| `_PNH` pointer to function | Type of argument to [`_set_new_handler`](./reference/set-new-handler.md). | `NEW.H` | +| `ptrdiff_t` (long integer or **`__int64`**, depending on the target platform) | Result of subtraction of two pointers. | `CRTDEFS.H` | +| `_purecall_handler`,

`_purecall_handler_m` | A type definition for a call-back function that is called when a pure virtual function is called. Used by [`_get_purecall_handler`, _set_purecall_handler](./reference/get-purecall-handler-set-purecall-handler.md). A `_purecall_handler` function should have a void return type. | `STDLIB.H` | +| `_RTC_error_fn` type definition | A type definition for a function that will handle run-time error checks. Used in [`_RTC_SetErrorFunc`](./reference/rtc-seterrorfunc.md). | `RTCAPI.H` | +| `_RTC_error_fnW` type definition | A type definition for a function that will handle run-time error checks. Used in [`_RTC_SetErrorFuncW`](./reference/rtc-seterrorfuncw.md). | `RTCAPI.H` | +| `_RTC_ErrorNumber` enumeration | Defines error conditions for [`_RTC_GetErrDesc`](./reference/rtc-geterrdesc.md) and [`_RTC_SetErrorType`](./reference/rtc-seterrortype.md). | `RTCAPI.H` | +| `_se_translator_function` | A type definition for a call-back function that translates an exception. The first parameter is the exception code and the second parameter is the exception record. Used by [`_set_se_translator`](./reference/set-se-translator.md). | `EH.H` | +| `sig_atomic_t` integer | Type of object that can be modified as atomic entity, even in presence of asynchronous interrupts; used with [`signal`](./reference/signal.md). | `SIGNAL.H` | +| `size_t` (`unsigned __int64` or `unsigned integer`, depending on the target platform) | Result of **`sizeof`** operator. | `CRTDEFS.H` and other include files | +| `_stat` structure | Contains file-status information returned by [`_stat`](./reference/stat-functions.md) and [`_fstat`](./reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md). | `SYS\STAT.H` | +| `__stat64` structure | Contains file-status information returned by [`_fstat64`](./reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md) and [`_stat64`](./reference/stat-functions.md), and [`_wstat64`](./reference/stat-functions.md). | `SYS\STAT.H` | +| `_stati64` structure | Contains file-status information returned by [`_fstati64`](./reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md), [`_stati64`](./reference/stat-functions.md), and [`_wstati64`](./reference/stat-functions.md). | `SYS\STAT.H` | +| `terminate_function` type definition | A type definition for a call-back function that is called when [`terminate`](./reference/terminate-crt.md) is called. Used by [`set_terminate`](./reference/set-terminate-crt.md). | `EH.H` | +| `time_t` (`__int64` or `long integer`) | Represents time values in [`mktime`](./reference/mktime-mktime32-mktime64.md), [`time`](./reference/time-time32-time64.md), [`ctime`, `_ctime32`, `_ctime64`, `_wctime`, `_wctime32`, `_wctime64`](./reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md), [`ctime_s`, `_ctime32_s`, `_ctime64_s`, `_wctime_s`, _wctime32_s, _wctime64_s](./reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md), [`ctime`, `_ctime32`, `_ctime64`, `_wctime`, `_wctime32`, `_wctime64`](./reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md) and [`gmtime`, `_gmtime32`, `_gmtime64`](./reference/gmtime-gmtime32-gmtime64.md). The number of seconds since January 1, 1970, 0:00 UTC. If `_USE_32BIT_TIME_T` is defined, `time_t` is a long integer. If not defined, it's a 64-bit integer. | `TIME.H`,

`SYS\STAT.H`,

`SYS\TIMEB.H` | +| `__time32_t` (`long integer`) | Represents time values in [`mktime`, `_mktime32`, `_mktime64`](./reference/mktime-mktime32-mktime64.md), [`ctime`, `_ctime32`, `_ctime64`, `_wctime`, `_wctime32`, `_wctime64`](./reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md), [`ctime_s`, `_ctime32_s`, `_ctime64_s`, `_wctime_s`, `_wctime32_s`, `_wctime64_s`](./reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md), [`gmtime`, `_gmtime32`, `_gmtime64`](./reference/gmtime-gmtime32-gmtime64.md) and [`localtime`, `_localtime32`, `_localtime64`](./reference/localtime-localtime32-localtime64.md). | `CRTDEFS.H`, `SYS\STAT.H`,

`SYS\TIMEB.H` | +| `__time64_t` (**`__int64`**) | Represents time values in [`mktime`, `_mktime32`, `_mktime64`](./reference/mktime-mktime32-mktime64.md), [`_ctime64`, `_wctime64`](./reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md), [`ctime_s`, `_ctime32_s`, `_ctime64_s`, `_wctime_s`, `_wctime32_s`, `_wctime64_s`](./reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md), [`_gmtime64`](./reference/gmtime-gmtime32-gmtime64.md), [`_localtime64`](./reference/localtime-localtime32-localtime64.md) and [`_time64`](./reference/time-time32-time64.md). | `TIME.H`,

`SYS\STAT.H`,

`SYS\TIMEB.H` | +| `_timeb` structure | The [`_ftime`](./reference/ftime-ftime32-ftime64.md) and [`_ftime_s`, `_ftime32_s`, `_ftime64_s`](./reference/ftime-s-ftime32-s-ftime64-s.md) functions use it to store current system time. | `SYS\TIMEB.H` | +| `__timeb32` structure | The [`_ftime`, `_ftime32`, `_ftime64`](./reference/ftime-ftime32-ftime64.md) and [`_ftime_s`, `_ftime32_s`, `_ftime64_s`](./reference/ftime-s-ftime32-s-ftime64-s.md) functions use it to store current system time. | `SYS\TIMEB.H` | +| `__timeb64` structure | The [`_ftime64`](./reference/ftime-ftime32-ftime64.md) and [`_ftime_s`, `_ftime32_s`, `_ftime64_s`](./reference/ftime-s-ftime32-s-ftime64-s.md) functions use it to store current system time. | `SYS\TIMEB.H` | +| `tm` structure | The [`asctime`, `_wasctime`](./reference/asctime-wasctime.md), [`asctime_s`, `_wasctime_s`](./reference/asctime-s-wasctime-s.md), [`gmtime`, `_gmtime32`, `_gmtime64`](./reference/gmtime-gmtime32-gmtime64.md), [`gmtime_s`, `_gmtime32_s`, `_gmtime64_s`](./reference/gmtime-s-gmtime32-s-gmtime64-s.md), [`localtime`, `_localtime32`, `_localtime64`](./reference/localtime-localtime32-localtime64.md), [`localtime_s`, `_localtime32_s`, `_localtime64_s`](./reference/localtime-s-localtime32-s-localtime64-s.md), [`mktime`, `_mktime32`, `_mktime64`](./reference/mktime-mktime32-mktime64.md) and [`strftime`, `wcsftime`, _strftime_l, _wcsftime_l](./reference/strftime-wcsftime-strftime-l-wcsftime-l.md) functions use it to store and retrieve time information. | `TIME.H` | +| `uintmax_t` | An `unsigned integer` type capable of representing any value of any `unsigned integer` type. | `stdint.h` | +| `uintptr_t` (`long integer` or **`__int64`**, depending on the target platform) | An `unsigned integer` or `unsigned __int64` version of `intptr_t`. | `STDDEF.H` and other include files | +| `unexpected_function` | A type definition for a call-back function that is called when [`unexpected`](./reference/unexpected-crt.md) is called. Used by [`set_unexpected`](./reference/set-unexpected-crt.md). | `EH.H` | +| `_utimbuf` structure | Stores file access and modification times used by [`_utime`, `_wutime`](./reference/utime-utime32-utime64-wutime-wutime32-wutime64.md) and [`_futime`, `_futime32`, `_futime64`](./reference/futime-futime32-futime64.md) to change file-modification dates. | `SYS\UTIME.H` | +| `_utimbuf32` structure | Stores file access and modification times used by [`_utime`, `_utime32`, `_utime64`, `_wutime`, `_wutime32`, `_wutime64`](./reference/utime-utime32-utime64-wutime-wutime32-wutime64.md) and [`_futime`, `_futime32`, `_futime64`](./reference/futime-futime32-futime64.md) to change file-modification dates. | `SYS\UTIME.H` | +| `__utimbuf64` structure | The [`_utime64`, `_wutime64`](./reference/utime-utime32-utime64-wutime-wutime32-wutime64.md) and [`_futime64`](./reference/futime-futime32-futime64.md) functions use it to store the current time. | `SYS\UTIME.H` | +| `va_list` structure | Used to hold information needed by [`va_arg`](./reference/va-arg-va-copy-va-end-va-start.md) and [`va_end`](./reference/va-arg-va-copy-va-end-va-start.md) macros. Called function declares variable of type `va_list` that can be passed as argument to another function. | `STDARG.H`,

`CRTDEFS.H` | +| **`wchar_t`** wide character | Useful for writing portable programs for international markets. | `STDDEF.H`, `STDLIB.H`,

`CRTDEFS.H`,

`SYS\STAT.H` | +| `wctrans_t` integer | Represents locale-specific character mappings. | `WCTYPE.H` | +| `wctype_t` integer | Can represent all characters of any language character set. | `WCHAR.H`,

`CRTDEFS.H` | +| `wint_t` integer | Type of data object that can hold any wide character or wide end-of-file value. | `WCHAR.H`,

`CRTDEFS.H` | ## See also diff --git a/docs/c-runtime-library/stat-structure-st-mode-field-constants.md b/docs/c-runtime-library/stat-structure-st-mode-field-constants.md index 29a7d22430b..8adc48ed74c 100644 --- a/docs/c-runtime-library/stat-structure-st-mode-field-constants.md +++ b/docs/c-runtime-library/stat-structure-st-mode-field-constants.md @@ -10,7 +10,7 @@ ms.assetid: fd462004-7563-4766-8443-30b0a86174b6 ## Syntax -``` +```C #include ``` @@ -20,15 +20,15 @@ These constants are used to indicate file type in the `st_mode` field of the [`_ The bit mask constants are described below: -|Constant|Meaning| -|--------------|-------------| -|`_S_IFMT`|File type mask| -|`_S_IFDIR`|Directory| -|`_S_IFCHR`|Character special (indicates a device if set)| -|`_S_IFREG`|Regular| -|`_S_IREAD`|Read permission, owner| -|`_S_IWRITE`|Write permission, owner| -|`_S_IEXEC`|Execute/search permission, owner| +| Constant | Meaning | +|---|---| +| `_S_IFMT` | File type mask | +| `_S_IFDIR` | Directory | +| `_S_IFCHR` | Character special (indicates a device if set) | +| `_S_IFREG` | Regular | +| `_S_IREAD` | Read permission, owner | +| `_S_IWRITE` | Write permission, owner | +| `_S_IEXEC` | Execute/search permission, owner | ## See also diff --git a/docs/c-runtime-library/stdin-stdout-stderr.md b/docs/c-runtime-library/stdin-stdout-stderr.md index c4b684ec0da..583eb8c47dd 100644 --- a/docs/c-runtime-library/stdin-stdout-stderr.md +++ b/docs/c-runtime-library/stdin-stdout-stderr.md @@ -10,7 +10,7 @@ ms.assetid: badd4735-596d-4498-857c-ec8b7e670e4c ## Syntax -``` +```C FILE *stdin; FILE *stdout; FILE *stderr; @@ -19,19 +19,19 @@ FILE *stderr; ## Remarks -The `stdin`, `stdout`, and `stderr` global constant pointers are standard streams for input, output, and error output. +The **`stdin`**, **`stdout`**, and **`stderr`** global constant pointers are standard streams for input, output, and error output. By default, standard input is read from the keyboard, while standard output and standard error are printed to the screen. The following stream pointers are available to access the standard streams: -|Pointer|Stream| -|-------------|------------| -|`stdin`|Standard input| -|`stdout`|Standard output| -|`stderr`|Standard error| +| Pointer | Stream | +|---|---| +| **`stdin`** | Standard input | +| **`stdout`** | Standard output | +| **`stderr`** | Standard error | -These pointers can be used as arguments to functions. Some functions, such as [`getchar`](./reference/getchar-getwchar.md) and [`putchar`](./reference/putchar-putwchar.md), use `stdin` and `stdout` automatically. +These pointers can be used as arguments to functions. Some functions, such as [`getchar`](./reference/getchar-getwchar.md) and [`putchar`](./reference/putchar-putwchar.md), use **`stdin`** and **`stdout`** automatically. These pointers are constants, and can't be assigned new values. The [`freopen`](./reference/freopen-wfreopen.md) function can be used to redirect the streams to disk files or to other devices. The operating system allows you to redirect a program's standard input and output at the command level. diff --git a/docs/c-runtime-library/strcoll-functions.md b/docs/c-runtime-library/strcoll-functions.md index e1f227f681a..4bd33814e55 100644 --- a/docs/c-runtime-library/strcoll-functions.md +++ b/docs/c-runtime-library/strcoll-functions.md @@ -15,12 +15,12 @@ Each of the `strcoll` and `wcscoll` functions compares two strings according to ### strcoll Functions -|SBCS|Unicode|MBCS|Description| -|----------|-------------|----------|-----------------| -|[`strcoll`](./reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md)|[`wcscoll`](./reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md)|[`_mbscoll`](./reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md)|Collate two strings| -|[`_stricoll`](./reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md)|[`_wcsicoll`](./reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md)|[`_mbsicoll`](./reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md)|Collate two strings (case insensitive)| -|[`_strncoll`](./reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md)|[`_wcsncoll`](./reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md)|[`_mbsncoll`](./reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md)|Collate first `count` characters of two strings| -|[`_strnicoll`](./reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md)|[`_wcsnicoll`](./reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md)|[`_mbsnicoll`](./reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md)|Collate first `count` characters of two strings (case-insensitive)| +| SBCS | Unicode | MBCS | Description | +|---|---|---|---| +| [`strcoll`](./reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md) | [`wcscoll`](./reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md) | [`_mbscoll`](./reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md) | Collate two strings | +| [`_stricoll`](./reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md) | [`_wcsicoll`](./reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md) | [`_mbsicoll`](./reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md) | Collate two strings (case insensitive) | +| [`_strncoll`](./reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md) | [`_wcsncoll`](./reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md) | [`_mbsncoll`](./reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md) | Collate first `count` characters of two strings | +| [`_strnicoll`](./reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md) | [`_wcsnicoll`](./reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md) | [`_mbsnicoll`](./reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md) | Collate first `count` characters of two strings (case-insensitive) | ## Remarks diff --git a/docs/c-runtime-library/stream-i-o.md b/docs/c-runtime-library/stream-i-o.md index 9179e21a4ce..180ecf2b1f3 100644 --- a/docs/c-runtime-library/stream-i-o.md +++ b/docs/c-runtime-library/stream-i-o.md @@ -11,63 +11,63 @@ These functions process data in different sizes and formats, from single charact ## Stream I/O routines -|Routine|Use| -|-------------|---------| -|[`clearerr`](./reference/clearerr.md), [`clearerr_s`](./reference/clearerr-s.md)|Clear error indicator for stream| -|[`fclose`](./reference/fclose-fcloseall.md)|Close stream| -|[`_fcloseall`](./reference/fclose-fcloseall.md)|Close all open streams except **`stdin`**, **`stdout`**, and **`stderr`**| -|[`_fdopen`, `wfdopen`](./reference/fdopen-wfdopen.md)|Associate stream with file descriptor of open file| -|[`feof`](./reference/feof.md)|Test for end of file on stream| -|[`ferror`](./reference/ferror.md)|Test for error on stream| -|[`fflush`](./reference/fflush.md)|Flush stream to buffer or storage device| -|[`fgetc`, `fgetwc`](./reference/fgetc-fgetwc.md)|Read character from stream (function versions of **`getc`** and **`getwc`**)| -|[`_fgetchar`, `_fgetwchar`](./reference/fgetc-fgetwc.md)|Read character from **`stdin`** (function versions of **`getchar`** and **`getwchar`**)| -|[`fgetpos`](./reference/fgetpos.md)|Get position indicator of stream| -|[`fgets`, `fgetws`](./reference/fgets-fgetws.md)|Read string from stream| -|[`_fileno`](./reference/fileno.md)|Get file descriptor associated with stream| -|[`_flushall`](./reference/flushall.md)|Flush all streams to buffer or storage device| -|[`fopen`, `_wfopen`](./reference/fopen-wfopen.md), [`fopen_s`, `_wfopen_s`](./reference/fopen-s-wfopen-s.md)|Open stream| -|[`fprintf`, `_fprintf_l`, `fwprintf`, `_fwprintf_l`](./reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md), [`fprintf_s`, `_fprintf_s_l`, `fwprintf_s`, `_fwprintf_s_l`](./reference/fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md)|Write formatted data to stream| -|[`fputc`, `fputwc`](./reference/fputc-fputwc.md)|Write a character to a stream (function versions of **`putc`** and **`putwc`**)| -|[`_fputchar`, `_fputwchar`](./reference/fputc-fputwc.md)|Write character to **`stdout`** (function versions of **`putchar`** and **`putwchar`**)| -|[`fputs`, `fputws`](./reference/fputs-fputws.md)|Write string to stream| -|[`fread`](./reference/fread.md)|Read unformatted data from stream| -|[`freopen`, `_wfreopen`](./reference/freopen-wfreopen.md), [`freopen_s`, `_wfreopen_s`](./reference/freopen-s-wfreopen-s.md)|Reassign `FILE` stream pointer to new file or device| -|[`fscanf`, `fwscanf`](./reference/fscanf-fscanf-l-fwscanf-fwscanf-l.md), [`fscanf_s`, `_fscanf_s_l`, `fwscanf_s`, `_fwscanf_s_l`](./reference/fscanf-s-fscanf-s-l-fwscanf-s-fwscanf-s-l.md)|Read formatted data from stream| -|[`fseek`, `_fseeki64`](./reference/fseek-fseeki64.md)|Move file position to given location| -|[`fsetpos`](./reference/fsetpos.md)|Set position indicator of stream| -|[`_fsopen`, `_wfsopen`](./reference/fsopen-wfsopen.md)|Open stream with file sharing| -|[`ftell`, `_ftelli64`](./reference/ftell-ftelli64.md)|Get current file position| -|[`fwrite`](./reference/fwrite.md)|Write unformatted data items to stream| -|[`getc`, `getwc`](./reference/getc-getwc.md)|Read character from stream (macro versions of **`fgetc`** and **`fgetwc`**)| -|[`getchar`, `getwchar`](./reference/getc-getwc.md)|Read character from **`stdin`** (macro versions of **`fgetchar`** and **`fgetwchar`**)| -|[`_getmaxstdio`](./reference/getmaxstdio.md)|Returns the number of simultaneously open files permitted at the stream I/O level.| -|[`gets_s`, `_getws_s`](./reference/gets-s-getws-s.md)|Read line from **`stdin`**| -|[`_getw`](./reference/getw.md)|Read binary **`int`** from stream| -|[`printf`, `_printf_l`, `wprintf`, `_wprintf_l`](./reference/printf-printf-l-wprintf-wprintf-l.md),[`printf_s`, `_printf_s_l`, `wprintf_s`, `_wprintf_s_l`](./reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md)|Write formatted data to **`stdout`**| -|[`putc`, `putwc`](./reference/putc-putwc.md)|Write character to a stream (macro versions of **`fputc`** and **`fputwc`**)| -|[`putchar`, `putwchar`](./reference/putc-putwc.md)|Write character to **`stdout`** (macro versions of **`fputchar`** and **`fputwchar`**)| -|[`puts`, `_putws`](./reference/puts-putws.md)|Write line to stream| -|[`_putw`](./reference/putw.md)|Write binary **`int`** to stream| -|[`rewind`](./reference/rewind.md)|Move file position to beginning of stream| -|[`_rmtmp`](./reference/rmtmp.md)|Remove temporary files created by **`tmpfile`**| -|[`scanf`, `_scanf_l`, `wscanf`, `_wscanf_l`](./reference/scanf-scanf-l-wscanf-wscanf-l.md),[`scanf_s`, `_scanf_s_l`, `wscanf_s`, `_wscanf_s_l`](./reference/scanf-s-scanf-s-l-wscanf-s-wscanf-s-l.md)|Read formatted data from **`stdin`**| -|[`setbuf`](./reference/setbuf.md)|Control stream buffering| -|[`_setmaxstdio`](./reference/setmaxstdio.md)|Set a maximum for the number of simultaneously open files at the stream I/O level.| -|[`setvbuf`](./reference/setvbuf.md)|Control stream buffering and buffer size| -|[`_snprintf`, `_snwprintf`](./reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md), [`_snprintf_s`, `_snprintf_s_l`, `_snwprintf_s`, `_snwprintf_s_l`](./reference/snprintf-s-snprintf-s-l-snwprintf-s-snwprintf-s-l.md)|Write formatted data of specified length to string| -|[`_snscanf`, `_snwscanf`](./reference/snscanf-snscanf-l-snwscanf-snwscanf-l.md), [`_snscanf_s`, `_snscanf_s_l`, `_snwscanf_s`, `_snwscanf_s_l`](./reference/snscanf-s-snscanf-s-l-snwscanf-s-snwscanf-s-l.md)|Read formatted data of a specified length from the standard input stream.| -|[`sprintf`, `swprintf`](./reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md), [`sprintf_s`, `_sprintf_s_l`, `swprintf_s`, `_swprintf_s_l`](./reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md)|Write formatted data to string| -|[`sscanf`, `swscanf`](./reference/sscanf-sscanf-l-swscanf-swscanf-l.md), [`sscanf_s`, _sscanf_s_l, `swscanf_s`, `_swscanf_s_l`](./reference/sscanf-s-sscanf-s-l-swscanf-s-swscanf-s-l.md)|Read formatted data from string| -|[`_tempnam`, `_wtempnam`](./reference/tempnam-wtempnam-tmpnam-wtmpnam.md)|Generate temporary filename in given directory| -|[`tmpfile`](./reference/tmpfile.md), [`tmpfile_s`](./reference/tmpfile-s.md)|Create temporary file| -|[`tmpnam`, `_wtmpnam`](./reference/tempnam-wtempnam-tmpnam-wtmpnam.md), [`tmpnam_s`, `_wtmpnam_s`](./reference/tmpnam-s-wtmpnam-s.md)|Generate temporary filename| -|[`ungetc`, `ungetwc`](./reference/ungetc-ungetwc.md)|Push character back onto stream| -|[`_vcprintf`, `_vcwprintf`](./reference/vcprintf-vcprintf-l-vcwprintf-vcwprintf-l.md), [`_vcprintf_s`, `_vcprintf_s_l`, `_vcwprintf_s`, `_vcwprintf_s_l`](./reference/vcprintf-s-vcprintf-s-l-vcwprintf-s-vcwprintf-s-l.md)|Write formatted data to the console.| -|[`vfprintf`, `vfwprintf`](./reference/vfprintf-vfprintf-l-vfwprintf-vfwprintf-l.md), [`vfprintf_s`, `_vfprintf_s_l`, `vfwprintf_s`, `_vfwprintf_s_l`](./reference/vfprintf-s-vfprintf-s-l-vfwprintf-s-vfwprintf-s-l.md)|Write formatted data to stream| -|[`vprintf`, `vwprintf`](./reference/vprintf-vprintf-l-vwprintf-vwprintf-l.md), [`vprintf_s`, `_vprintf_s_l`, `vwprintf_s`, `_vwprintf_s_l`](./reference/vprintf-s-vprintf-s-l-vwprintf-s-vwprintf-s-l.md)|Write formatted data to **`stdout`**| -|[`_vsnprintf`, `_vsnwprintf`](./reference/vsnprintf-vsnprintf-vsnprintf-l-vsnwprintf-vsnwprintf-l.md), [`vsnprintf_s`, `_vsnprintf_s`, `_vsnprintf_s_l`, `_vsnwprintf_s`, `_vsnwprintf_s_l`](./reference/vsnprintf-s-vsnprintf-s-vsnprintf-s-l-vsnwprintf-s-vsnwprintf-s-l.md)|Write formatted data of specified length to buffer| -|[`vsprintf`, `vswprintf`](./reference/vsprintf-vsprintf-l-vswprintf-vswprintf-l-vswprintf-l.md), [`vsprintf_s`, `_vsprintf_s_l`, `vswprintf_s`, `_vswprintf_s_l`](./reference/vsprintf-s-vsprintf-s-l-vswprintf-s-vswprintf-s-l.md)|Write formatted data to buffer| +| Routine | Use | +|---|---| +| [`clearerr`](./reference/clearerr.md), [`clearerr_s`](./reference/clearerr-s.md) | Clear error indicator for stream | +| [`fclose`](./reference/fclose-fcloseall.md) | Close stream | +| [`_fcloseall`](./reference/fclose-fcloseall.md) | Close all open streams except **`stdin`**, **`stdout`**, and **`stderr`** | +| [`_fdopen`, `wfdopen`](./reference/fdopen-wfdopen.md) | Associate stream with file descriptor of open file | +| [`feof`](./reference/feof.md) | Test for end of file on stream | +| [`ferror`](./reference/ferror.md) | Test for error on stream | +| [`fflush`](./reference/fflush.md) | Flush stream to buffer or storage device | +| [`fgetc`, `fgetwc`](./reference/fgetc-fgetwc.md) | Read character from stream (function versions of **`getc`** and **`getwc`**) | +| [`_fgetchar`, `_fgetwchar`](./reference/fgetc-fgetwc.md) | Read character from **`stdin`** (function versions of **`getchar`** and **`getwchar`**) | +| [`fgetpos`](./reference/fgetpos.md) | Get position indicator of stream | +| [`fgets`, `fgetws`](./reference/fgets-fgetws.md) | Read string from stream | +| [`_fileno`](./reference/fileno.md) | Get file descriptor associated with stream | +| [`_flushall`](./reference/flushall.md) | Flush all streams to buffer or storage device | +| [`fopen`, `_wfopen`](./reference/fopen-wfopen.md), [`fopen_s`, `_wfopen_s`](./reference/fopen-s-wfopen-s.md) | Open stream | +| [`fprintf`, `_fprintf_l`, `fwprintf`, `_fwprintf_l`](./reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md), [`fprintf_s`, `_fprintf_s_l`, `fwprintf_s`, `_fwprintf_s_l`](./reference/fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md) | Write formatted data to stream | +| [`fputc`, `fputwc`](./reference/fputc-fputwc.md) | Write a character to a stream (function versions of **`putc`** and **`putwc`**) | +| [`_fputchar`, `_fputwchar`](./reference/fputc-fputwc.md) | Write character to **`stdout`** (function versions of **`putchar`** and **`putwchar`**) | +| [`fputs`, `fputws`](./reference/fputs-fputws.md) | Write string to stream | +| [`fread`](./reference/fread.md) | Read unformatted data from stream | +| [`freopen`, `_wfreopen`](./reference/freopen-wfreopen.md), [`freopen_s`, `_wfreopen_s`](./reference/freopen-s-wfreopen-s.md) | Reassign `FILE` stream pointer to new file or device | +| [`fscanf`, `fwscanf`](./reference/fscanf-fscanf-l-fwscanf-fwscanf-l.md), [`fscanf_s`, `_fscanf_s_l`, `fwscanf_s`, `_fwscanf_s_l`](./reference/fscanf-s-fscanf-s-l-fwscanf-s-fwscanf-s-l.md) | Read formatted data from stream | +| [`fseek`, `_fseeki64`](./reference/fseek-fseeki64.md) | Move file position to given location | +| [`fsetpos`](./reference/fsetpos.md) | Set position indicator of stream | +| [`_fsopen`, `_wfsopen`](./reference/fsopen-wfsopen.md) | Open stream with file sharing | +| [`ftell`, `_ftelli64`](./reference/ftell-ftelli64.md) | Get current file position | +| [`fwrite`](./reference/fwrite.md) | Write unformatted data items to stream | +| [`getc`, `getwc`](./reference/getc-getwc.md) | Read character from stream (macro versions of **`fgetc`** and **`fgetwc`**) | +| [`getchar`, `getwchar`](./reference/getc-getwc.md) | Read character from **`stdin`** (macro versions of **`fgetchar`** and **`fgetwchar`**) | +| [`_getmaxstdio`](./reference/getmaxstdio.md) | Returns the number of simultaneously open files permitted at the stream I/O level. | +| [`gets_s`, `_getws_s`](./reference/gets-s-getws-s.md) | Read line from **`stdin`** | +| [`_getw`](./reference/getw.md) | Read binary **`int`** from stream | +| [`printf`, `_printf_l`, `wprintf`, `_wprintf_l`](./reference/printf-printf-l-wprintf-wprintf-l.md),[`printf_s`, `_printf_s_l`, `wprintf_s`, `_wprintf_s_l`](./reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md) | Write formatted data to **`stdout`** | +| [`putc`, `putwc`](./reference/putc-putwc.md) | Write character to a stream (macro versions of **`fputc`** and **`fputwc`**) | +| [`putchar`, `putwchar`](./reference/putc-putwc.md) | Write character to **`stdout`** (macro versions of **`fputchar`** and **`fputwchar`**) | +| [`puts`, `_putws`](./reference/puts-putws.md) | Write line to stream | +| [`_putw`](./reference/putw.md) | Write binary **`int`** to stream | +| [`rewind`](./reference/rewind.md) | Move file position to beginning of stream | +| [`_rmtmp`](./reference/rmtmp.md) | Remove temporary files created by **`tmpfile`** | +| [`scanf`, `_scanf_l`, `wscanf`, `_wscanf_l`](./reference/scanf-scanf-l-wscanf-wscanf-l.md),[`scanf_s`, `_scanf_s_l`, `wscanf_s`, `_wscanf_s_l`](./reference/scanf-s-scanf-s-l-wscanf-s-wscanf-s-l.md) | Read formatted data from **`stdin`** | +| [`setbuf`](./reference/setbuf.md) | Control stream buffering | +| [`_setmaxstdio`](./reference/setmaxstdio.md) | Set a maximum for the number of simultaneously open files at the stream I/O level. | +| [`setvbuf`](./reference/setvbuf.md) | Control stream buffering and buffer size | +| [`_snprintf`, `_snwprintf`](./reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md), [`_snprintf_s`, `_snprintf_s_l`, `_snwprintf_s`, `_snwprintf_s_l`](./reference/snprintf-s-snprintf-s-l-snwprintf-s-snwprintf-s-l.md) | Write formatted data of specified length to string | +| [`_snscanf`, `_snwscanf`](./reference/snscanf-snscanf-l-snwscanf-snwscanf-l.md), [`_snscanf_s`, `_snscanf_s_l`, `_snwscanf_s`, `_snwscanf_s_l`](./reference/snscanf-s-snscanf-s-l-snwscanf-s-snwscanf-s-l.md) | Read formatted data of a specified length from the standard input stream. | +| [`sprintf`, `swprintf`](./reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md), [`sprintf_s`, `_sprintf_s_l`, `swprintf_s`, `_swprintf_s_l`](./reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md) | Write formatted data to string | +| [`sscanf`, `swscanf`](./reference/sscanf-sscanf-l-swscanf-swscanf-l.md), [`sscanf_s`, _sscanf_s_l, `swscanf_s`, `_swscanf_s_l`](./reference/sscanf-s-sscanf-s-l-swscanf-s-swscanf-s-l.md) | Read formatted data from string | +| [`_tempnam`, `_wtempnam`](./reference/tempnam-wtempnam-tmpnam-wtmpnam.md) | Generate temporary filename in given directory | +| [`tmpfile`](./reference/tmpfile.md), [`tmpfile_s`](./reference/tmpfile-s.md) | Create temporary file | +| [`tmpnam`, `_wtmpnam`](./reference/tempnam-wtempnam-tmpnam-wtmpnam.md), [`tmpnam_s`, `_wtmpnam_s`](./reference/tmpnam-s-wtmpnam-s.md) | Generate temporary filename | +| [`ungetc`, `ungetwc`](./reference/ungetc-ungetwc.md) | Push character back onto stream | +| [`_vcprintf`, `_vcwprintf`](./reference/vcprintf-vcprintf-l-vcwprintf-vcwprintf-l.md), [`_vcprintf_s`, `_vcprintf_s_l`, `_vcwprintf_s`, `_vcwprintf_s_l`](./reference/vcprintf-s-vcprintf-s-l-vcwprintf-s-vcwprintf-s-l.md) | Write formatted data to the console. | +| [`vfprintf`, `vfwprintf`](./reference/vfprintf-vfprintf-l-vfwprintf-vfwprintf-l.md), [`vfprintf_s`, `_vfprintf_s_l`, `vfwprintf_s`, `_vfwprintf_s_l`](./reference/vfprintf-s-vfprintf-s-l-vfwprintf-s-vfwprintf-s-l.md) | Write formatted data to stream | +| [`vprintf`, `vwprintf`](./reference/vprintf-vprintf-l-vwprintf-vwprintf-l.md), [`vprintf_s`, `_vprintf_s_l`, `vwprintf_s`, `_vwprintf_s_l`](./reference/vprintf-s-vprintf-s-l-vwprintf-s-vwprintf-s-l.md) | Write formatted data to **`stdout`** | +| [`_vsnprintf`, `_vsnwprintf`](./reference/vsnprintf-vsnprintf-vsnprintf-l-vsnwprintf-vsnwprintf-l.md), [`vsnprintf_s`, `_vsnprintf_s`, `_vsnprintf_s_l`, `_vsnwprintf_s`, `_vsnwprintf_s_l`](./reference/vsnprintf-s-vsnprintf-s-vsnprintf-s-l-vsnwprintf-s-vsnwprintf-s-l.md) | Write formatted data of specified length to buffer | +| [`vsprintf`, `vswprintf`](./reference/vsprintf-vsprintf-l-vswprintf-vswprintf-l-vswprintf-l.md), [`vsprintf_s`, `_vsprintf_s_l`, `vswprintf_s`, `_vswprintf_s_l`](./reference/vsprintf-s-vsprintf-s-l-vswprintf-s-vswprintf-s-l.md) | Write formatted data to buffer | When a program begins execution, the startup code automatically opens several streams: standard input (pointed to by **`stdin`**), standard output (pointed to by **`stdout`**), and standard error (pointed to by **`stderr`**). These streams are directed to the console (keyboard and screen) by default. Use **`freopen`** to redirect **`stdin`**, **`stdout`**, or **`stderr`** to a disk file or a device. diff --git a/docs/c-runtime-library/string-manipulation-crt.md b/docs/c-runtime-library/string-manipulation-crt.md index aae81dd68d3..6ce3a07f7c1 100644 --- a/docs/c-runtime-library/string-manipulation-crt.md +++ b/docs/c-runtime-library/string-manipulation-crt.md @@ -11,53 +11,53 @@ These routines operate on null-terminated single-byte character, wide-character, ## String-manipulation routines -|Routine|Use| -|-------------|---------| -|[`strcoll`, `wcscoll`, `_mbscoll`, `_strcoll_l`, `_wcscoll_l`, `_mbscoll_l`](./reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md), [`_stricoll`, `_wcsicoll`, `_mbsicoll`, `_stricoll_l`, `_wcsicoll_l`, `_mbsicoll_l`](./reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md), [`_strncoll`, `_wcsncoll`, `_mbsncoll`, `_strncoll_l`, `_wcsncoll_l`, `_mbsncoll_l`](./reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md), [`_strnicoll`, `_wcsnicoll`, `_mbsnicoll`, `_strnicoll_l`, `_wcsnicoll_l`, `_mbsnicoll_l`](./reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md)|Compare two character strings using code page information (**`_mbsicoll`** and **`_mbsnicoll`** are case-insensitive)| -|[`_strdec`, `_wcsdec`, `_mbsdec`, `_mbsdec_l`](./reference/strdec-wcsdec-mbsdec-mbsdec-l.md)|Move string pointer back one character| -|[`_strinc`, `_wcsinc`, `_mbsinc`, `_mbsinc_l`](./reference/strinc-wcsinc-mbsinc-mbsinc-l.md)|Advance string pointer by one character| -|[`_mbsnbcat`, `_mbsnbcat_l`](./reference/mbsnbcat-mbsnbcat-l.md), [`_mbsnbcat_s`, `_mbsnbcat_s_l`](./reference/mbsnbcat-s-mbsnbcat-s-l.md)|Append, at most, first *n* bytes of one character string to another| -|[`_mbsnbcmp`, `_mbsnbcmp_l`](./reference/mbsnbcmp-mbsnbcmp-l.md)|Compare first *n* bytes of two character strings| -|[`_strncnt`, `_wcsncnt`, `_mbsnbcnt`, `_mbsnbcnt_l`, `_mbsnccnt`, `_mbsnccnt_l`](./reference/strncnt-wcsncnt-mbsnbcnt-mbsnbcnt-l-mbsnccnt-mbsnccnt-l.md)|Return number of character bytes within supplied character count| -|[`_mbsnbcpy`, `_mbsnbcpy_l`](./reference/mbsnbcpy-mbsnbcpy-l.md), [`_mbsnbcpy_s`, `_mbsnbcpy_s_l`](./reference/mbsnbcpy-s-mbsnbcpy-s-l.md)|Copy *n* bytes of string| -|[`_mbsnbicmp`, `_mbsnbicmp_l`](./reference/mbsnbicmp-mbsnbicmp-l.md)|Compare *n* bytes of two character strings, ignoring case| -|[`_mbsnbset`, `_mbsnbset_l`](./reference/mbsnbset-mbsnbset-l.md)|Set first *n* bytes of character string to specified character| -|[`_strncnt`, `_wcsncnt`, `_mbsnbcnt`, `_mbsnbcnt_l`, `_mbsnccnt`, `_mbsnccnt_l`](./reference/strncnt-wcsncnt-mbsnbcnt-mbsnbcnt-l-mbsnccnt-mbsnccnt-l.md)|Return number of characters within supplied byte count| -|[`_strnextc`, `_wcsnextc`, `_mbsnextc`, `_mbsnextc_l`](./reference/strnextc-wcsnextc-mbsnextc-mbsnextc-l.md)|Find next character in string| -|[`_strninc`, `_wcsninc`, `_mbsninc`, `_mbsninc_l`](./reference/strninc-wcsninc-mbsninc-mbsninc-l.md)|Advance string pointer by *n* characters| -|[`_strspnp`, `_wcsspnp`, `_mbsspnp`, `_mbsspnp_l`](./reference/strspnp-wcsspnp-mbsspnp-mbsspnp-l.md)|Return pointer to first character in given string that isn't in another given string| -|[`_scprintf`, `_scprintf_l`, `_scwprintf`, `_scwprintf_l`](./reference/scprintf-scprintf-l-scwprintf-scwprintf-l.md)|Return the number of characters in a formatted string| -|[`_snscanf`, `_snscanf_l`, `_snwscanf`, `_snwscanf_l`](./reference/snscanf-snscanf-l-snwscanf-snwscanf-l.md), [`_snscanf_s`, `_snscanf_s_l`, `_snwscanf_s`, `_snwscanf_s_l`](./reference/snscanf-s-snscanf-s-l-snwscanf-s-snwscanf-s-l.md)|Read formatted data of a specified length from the standard input stream.| -|[`sscanf`, `_sscanf_l`, `swscanf`, `_swscanf_l`](./reference/sscanf-sscanf-l-swscanf-swscanf-l.md), [`sscanf_s`, `_sscanf_s_l`, `swscanf_s`, `_swscanf_s_l`](./reference/sscanf-s-sscanf-s-l-swscanf-s-swscanf-s-l.md)|Read formatted data of a specified length from the standard input stream.| -|[`sprintf`, `_sprintf_l`, `swprintf`, `_swprintf_l`, `__swprintf_l`](./reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md), [`sprintf_s`, `_sprintf_s_l`, `swprintf_s`, `_swprintf_s_l`](./reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md), [`_sprintf_p`, `_sprintf_p_l`, `_swprintf_p`, `_swprintf_p_l`](./reference/sprintf-p-sprintf-p-l-swprintf-p-swprintf-p-l.md)|Write formatted data to a string| -|[`strcat`, `wcscat`, `_mbscat`](./reference/strcat-wcscat-mbscat.md), [`strcat_s`, `wcscat_s`, `_mbscat_s`](./reference/strcat-s-wcscat-s-mbscat-s.md)|Append one string to another| -|[`strchr`, `wcschr`, `_mbschr`, `_mbschr_l`](./reference/strchr-wcschr-mbschr-mbschr-l.md)|Find first occurrence of specified character in string| -|[`strcmp`, `wcscmp`, `_mbscmp`](./reference/strcmp-wcscmp-mbscmp.md)|Compare two strings| -|[`strcoll`, `wcscoll`, `_mbscoll`, `_strcoll_l`, `_wcscoll_l`, `_mbscoll_l`](./reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md), [`_stricoll`, `_wcsicoll`, `_mbsicoll`, `_stricoll_l`, `_wcsicoll_l`, `_mbsicoll_l`](./reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md), [`_strncoll`, `_wcsncoll`, `_mbsncoll`, `_strncoll_l`, `_wcsncoll_l`, `_mbsncoll_l`](./reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md), [`_strnicoll`, `_wcsnicoll`, `_mbsnicoll`, `_strnicoll_l`, `_wcsnicoll_l`, `_mbsnicoll_l`](./reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md)|Compare two strings using current locale code page information (**`_stricoll`**, **`_wcsicoll`**, **`_strnicoll`**, and **`_wcsnicoll`** are case-insensitive)| -|[`strcpy`, `wcscpy`, `_mbscpy`](./reference/strcpy-wcscpy-mbscpy.md), [`strcpy_s`, `wcscpy_s`, `_mbscpy_s`](./reference/strcpy-s-wcscpy-s-mbscpy-s.md)|Copy one string to another| -|[`strcspn`, `wcscspn`, `_mbscspn`, `_mbscspn_l`](./reference/strcspn-wcscspn-mbscspn-mbscspn-l.md)|Find first occurrence of character from specified character set in string| -|[`_strdup`, `_wcsdup`, `_mbsdup`](./reference/strdup-wcsdup-mbsdup.md), [`_strdup_dbg`, `_wcsdup_dbg`](./reference/strdup-dbg-wcsdup-dbg.md)|Duplicate string| -|[`strerror`, `_strerror`, `_wcserror`, `__wcserror`](./reference/strerror-strerror-wcserror-wcserror.md), [`strerror_s`, `_strerror_s`, `_wcserror_s`, `__wcserror_s`](./reference/strerror-s-strerror-s-wcserror-s-wcserror-s.md)|Map error number to message string| -|[`strftime`, `wcsftime`, `_strftime_l`, `_wcsftime_l`](./reference/strftime-wcsftime-strftime-l-wcsftime-l.md)|Format date-and-time string| -|[`_stricmp`, `_wcsicmp`, `_mbsicmp`, `_stricmp_l`, `_wcsicmp_l`, `_mbsicmp_l`](./reference/stricmp-wcsicmp-mbsicmp-stricmp-l-wcsicmp-l-mbsicmp-l.md)|Compare two strings without regard to case| -|[`strlen`, `wcslen`, `_mbslen`, `_mbslen_l`, `_mbstrlen`, `_mbstrlen_l`](./reference/strlen-wcslen-mbslen-mbslen-l-mbstrlen-mbstrlen-l.md), [`strnlen`, `strnlen_s`, `wcsnlen`, `wcsnlen_s`, `_mbsnlen`, `_mbsnlen_l`, `_mbstrnlen`, `_mbstrnlen_l`](./reference/strnlen-strnlen-s.md)|Find length of string| -|[`_strlwr`, `_wcslwr`, `_mbslwr`, `_strlwr_l`, `_wcslwr_l`, `_mbslwr_l`](./reference/strlwr-wcslwr-mbslwr-strlwr-l-wcslwr-l-mbslwr-l.md), [`_strlwr_s`, `_strlwr_s_l`, `_mbslwr_s`, `_mbslwr_s_l`, `_wcslwr_s`, `_wcslwr_s_l`](./reference/strlwr-s-strlwr-s-l-mbslwr-s-mbslwr-s-l-wcslwr-s-wcslwr-s-l.md)|Convert string to lowercase| -|[`strncat`, `_strncat_l`, `wcsncat`, `_wcsncat_l`, `_mbsncat`, `_mbsncat_l`](./reference/strncat-strncat-l-wcsncat-wcsncat-l-mbsncat-mbsncat-l.md), [`strncat_s`, `_strncat_s_l`, `wcsncat_s`, `_wcsncat_s_l`, `_mbsncat_s`, `_mbsncat_s_l`](./reference/strncat-s-strncat-s-l-wcsncat-s-wcsncat-s-l-mbsncat-s-mbsncat-s-l.md)|Append characters of string| -|[`strncmp`, `wcsncmp`, `_mbsncmp`, `_mbsncmp_l`](./reference/strncmp-wcsncmp-mbsncmp-mbsncmp-l.md)|Compare characters of two strings| -|[`strncpy`, `_strncpy_l`, `wcsncpy`, `_wcsncpy_l`, `_mbsncpy`, `_mbsncpy_l`](./reference/strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md), [`strncpy_s`, `_strncpy_s_l`, `wcsncpy_s`, `_wcsncpy_s_l`, `_mbsncpy_s`, `_mbsncpy_s_l`](./reference/strncpy-s-strncpy-s-l-wcsncpy-s-wcsncpy-s-l-mbsncpy-s-mbsncpy-s-l.md)|Copy characters of one string to another| -|[`_strnicmp`, `_wcsnicmp`, `_mbsnicmp`, `_strnicmp_l`, `_wcsnicmp_l`, `_mbsnicmp_l`](./reference/strnicmp-wcsnicmp-mbsnicmp-strnicmp-l-wcsnicmp-l-mbsnicmp-l.md)|Compare characters of two strings without regard to case| -|[`_strnset`, `_strnset_l`, `_wcsnset`, `_wcsnset_l`, `_mbsnset`, `_mbsnset_l`](./reference/strnset-strnset-l-wcsnset-wcsnset-l-mbsnset-mbsnset-l.md)|Set first *n* characters of string to specified character| -|[`strpbrk`, `wcspbrk`, `_mbspbrk`, `_mbspbrk_l`](./reference/strpbrk-wcspbrk-mbspbrk-mbspbrk-l.md)|Find first occurrence of character from one string in another string| -|[`strrchr`, `wcsrchr`, `_mbsrchr`, `_mbsrchr_l`](./reference/strrchr-wcsrchr-mbsrchr-mbsrchr-l.md)|Find last occurrence of given character in string| -|[`_strrev`, `_wcsrev`, `_mbsrev`, `_mbsrev_l`](./reference/strrev-wcsrev-mbsrev-mbsrev-l.md)|Reverse string| -|[`_strset`, `_strset_l`, `_wcsset`, `_wcsset_l`, `_mbsset`, `_mbsset_l`](./reference/strset-strset-l-wcsset-wcsset-l-mbsset-mbsset-l.md)|Set all characters of string to specified character| -|[`strspn`, `wcsspn`, `_mbsspn`, `_mbsspn_l`](./reference/strspn-wcsspn-mbsspn-mbsspn-l.md)|Find first occurrence in a string of a character not found in another string| -|[`strstr`, `wcsstr`, `_mbsstr`, `_mbsstr_l`](./reference/strstr-wcsstr-mbsstr-mbsstr-l.md)|Find first occurrence of specified string in another string| -|[`strtok`, `_strtok_l`, `wcstok`, `_wcstok_l`, `_mbstok`, `_mbstok_l`](./reference/strtok-strtok-l-wcstok-wcstok-l-mbstok-mbstok-l.md), [`strtok_s`, `_strtok_s_l`, `wcstok_s`, `_wcstok_s_l`, `_mbstok_s`, `_mbstok_s_l`](./reference/strtok-s-strtok-s-l-wcstok-s-wcstok-s-l-mbstok-s-mbstok-s-l.md)|Find next token in string| -|[`_strupr`, `_strupr_l`, `_mbsupr`, `_mbsupr_l`, `_wcsupr_l`, `_wcsupr`](./reference/strupr-strupr-l-mbsupr-mbsupr-l-wcsupr-l-wcsupr.md), [`_strupr_s`, `_strupr_s_l`, `_mbsupr_s`, `_mbsupr_s_l`, `_wcsupr_s`, `_wcsupr_s_l`](./reference/strupr-s-strupr-s-l-mbsupr-s-mbsupr-s-l-wcsupr-s-wcsupr-s-l.md)|Convert string to uppercase| -|[`strxfrm`, `wcsxfrm`, `_strxfrm_l`, `_wcsxfrm_l`](./reference/strxfrm-wcsxfrm-strxfrm-l-wcsxfrm-l.md)|Transform string into collated form based on locale-specific information| -|[`vsprintf`, `_vsprintf_l`, `vswprintf`, `_vswprintf_l`, `__vswprintf_l`](./reference/vsprintf-vsprintf-l-vswprintf-vswprintf-l-vswprintf-l.md), [`vsprintf_s`, `_vsprintf_s_l`, `vswprintf_s`, `_vswprintf_s_l`](./reference/vsprintf-s-vsprintf-s-l-vswprintf-s-vswprintf-s-l.md), [`_vsprintf_p`, `_vsprintf_p_l`, `_vswprintf_p`, `_vswprintf_p_l`](./reference/vsprintf-p-vsprintf-p-l-vswprintf-p-vswprintf-p-l.md)|Write formatted output using a pointer to a list of arguments| -|[`vsnprintf`, `_vsnprintf`, `_vsnprintf_l`, `_vsnwprintf`, `_vsnwprintf_l`](./reference/vsnprintf-vsnprintf-vsnprintf-l-vsnwprintf-vsnwprintf-l.md), [`vsnprintf_s`, `_vsnprintf_s`, `_vsnprintf_s_l`, `_vsnwprintf_s`, `_vsnwprintf_s_l`](./reference/vsnprintf-s-vsnprintf-s-vsnprintf-s-l-vsnwprintf-s-vsnwprintf-s-l.md)|Write formatted output using a pointer to a list of arguments| +| Routine | Use | +|---|---| +| [`strcoll`, `wcscoll`, `_mbscoll`, `_strcoll_l`, `_wcscoll_l`, `_mbscoll_l`](./reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md), [`_stricoll`, `_wcsicoll`, `_mbsicoll`, `_stricoll_l`, `_wcsicoll_l`, `_mbsicoll_l`](./reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md), [`_strncoll`, `_wcsncoll`, `_mbsncoll`, `_strncoll_l`, `_wcsncoll_l`, `_mbsncoll_l`](./reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md), [`_strnicoll`, `_wcsnicoll`, `_mbsnicoll`, `_strnicoll_l`, `_wcsnicoll_l`, `_mbsnicoll_l`](./reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md) | Compare two character strings using code page information (**`_mbsicoll`** and **`_mbsnicoll`** are case-insensitive) | +| [`_strdec`, `_wcsdec`, `_mbsdec`, `_mbsdec_l`](./reference/strdec-wcsdec-mbsdec-mbsdec-l.md) | Move string pointer back one character | +| [`_strinc`, `_wcsinc`, `_mbsinc`, `_mbsinc_l`](./reference/strinc-wcsinc-mbsinc-mbsinc-l.md) | Advance string pointer by one character | +| [`_mbsnbcat`, `_mbsnbcat_l`](./reference/mbsnbcat-mbsnbcat-l.md), [`_mbsnbcat_s`, `_mbsnbcat_s_l`](./reference/mbsnbcat-s-mbsnbcat-s-l.md) | Append, at most, first *n* bytes of one character string to another | +| [`_mbsnbcmp`, `_mbsnbcmp_l`](./reference/mbsnbcmp-mbsnbcmp-l.md) | Compare first *n* bytes of two character strings | +| [`_strncnt`, `_wcsncnt`, `_mbsnbcnt`, `_mbsnbcnt_l`, `_mbsnccnt`, `_mbsnccnt_l`](./reference/strncnt-wcsncnt-mbsnbcnt-mbsnbcnt-l-mbsnccnt-mbsnccnt-l.md) | Return number of character bytes within supplied character count | +| [`_mbsnbcpy`, `_mbsnbcpy_l`](./reference/mbsnbcpy-mbsnbcpy-l.md), [`_mbsnbcpy_s`, `_mbsnbcpy_s_l`](./reference/mbsnbcpy-s-mbsnbcpy-s-l.md) | Copy *n* bytes of string | +| [`_mbsnbicmp`, `_mbsnbicmp_l`](./reference/mbsnbicmp-mbsnbicmp-l.md) | Compare *n* bytes of two character strings, ignoring case | +| [`_mbsnbset`, `_mbsnbset_l`](./reference/mbsnbset-mbsnbset-l.md) | Set first *n* bytes of character string to specified character | +| [`_strncnt`, `_wcsncnt`, `_mbsnbcnt`, `_mbsnbcnt_l`, `_mbsnccnt`, `_mbsnccnt_l`](./reference/strncnt-wcsncnt-mbsnbcnt-mbsnbcnt-l-mbsnccnt-mbsnccnt-l.md) | Return number of characters within supplied byte count | +| [`_strnextc`, `_wcsnextc`, `_mbsnextc`, `_mbsnextc_l`](./reference/strnextc-wcsnextc-mbsnextc-mbsnextc-l.md) | Find next character in string | +| [`_strninc`, `_wcsninc`, `_mbsninc`, `_mbsninc_l`](./reference/strninc-wcsninc-mbsninc-mbsninc-l.md) | Advance string pointer by *n* characters | +| [`_strspnp`, `_wcsspnp`, `_mbsspnp`, `_mbsspnp_l`](./reference/strspnp-wcsspnp-mbsspnp-mbsspnp-l.md) | Return pointer to first character in given string that isn't in another given string | +| [`_scprintf`, `_scprintf_l`, `_scwprintf`, `_scwprintf_l`](./reference/scprintf-scprintf-l-scwprintf-scwprintf-l.md) | Return the number of characters in a formatted string | +| [`_snscanf`, `_snscanf_l`, `_snwscanf`, `_snwscanf_l`](./reference/snscanf-snscanf-l-snwscanf-snwscanf-l.md), [`_snscanf_s`, `_snscanf_s_l`, `_snwscanf_s`, `_snwscanf_s_l`](./reference/snscanf-s-snscanf-s-l-snwscanf-s-snwscanf-s-l.md) | Read formatted data of a specified length from the standard input stream. | +| [`sscanf`, `_sscanf_l`, `swscanf`, `_swscanf_l`](./reference/sscanf-sscanf-l-swscanf-swscanf-l.md), [`sscanf_s`, `_sscanf_s_l`, `swscanf_s`, `_swscanf_s_l`](./reference/sscanf-s-sscanf-s-l-swscanf-s-swscanf-s-l.md) | Read formatted data of a specified length from the standard input stream. | +| [`sprintf`, `_sprintf_l`, `swprintf`, `_swprintf_l`, `__swprintf_l`](./reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md), [`sprintf_s`, `_sprintf_s_l`, `swprintf_s`, `_swprintf_s_l`](./reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md), [`_sprintf_p`, `_sprintf_p_l`, `_swprintf_p`, `_swprintf_p_l`](./reference/sprintf-p-sprintf-p-l-swprintf-p-swprintf-p-l.md) | Write formatted data to a string | +| [`strcat`, `wcscat`, `_mbscat`](./reference/strcat-wcscat-mbscat.md), [`strcat_s`, `wcscat_s`, `_mbscat_s`](./reference/strcat-s-wcscat-s-mbscat-s.md) | Append one string to another | +| [`strchr`, `wcschr`, `_mbschr`, `_mbschr_l`](./reference/strchr-wcschr-mbschr-mbschr-l.md) | Find first occurrence of specified character in string | +| [`strcmp`, `wcscmp`, `_mbscmp`](./reference/strcmp-wcscmp-mbscmp.md) | Compare two strings | +| [`strcoll`, `wcscoll`, `_mbscoll`, `_strcoll_l`, `_wcscoll_l`, `_mbscoll_l`](./reference/strcoll-wcscoll-mbscoll-strcoll-l-wcscoll-l-mbscoll-l.md), [`_stricoll`, `_wcsicoll`, `_mbsicoll`, `_stricoll_l`, `_wcsicoll_l`, `_mbsicoll_l`](./reference/stricoll-wcsicoll-mbsicoll-stricoll-l-wcsicoll-l-mbsicoll-l.md), [`_strncoll`, `_wcsncoll`, `_mbsncoll`, `_strncoll_l`, `_wcsncoll_l`, `_mbsncoll_l`](./reference/strncoll-wcsncoll-mbsncoll-strncoll-l-wcsncoll-l-mbsncoll-l.md), [`_strnicoll`, `_wcsnicoll`, `_mbsnicoll`, `_strnicoll_l`, `_wcsnicoll_l`, `_mbsnicoll_l`](./reference/strnicoll-wcsnicoll-mbsnicoll-strnicoll-l-wcsnicoll-l-mbsnicoll-l.md) | Compare two strings using current locale code page information (**`_stricoll`**, **`_wcsicoll`**, **`_strnicoll`**, and **`_wcsnicoll`** are case-insensitive) | +| [`strcpy`, `wcscpy`, `_mbscpy`](./reference/strcpy-wcscpy-mbscpy.md), [`strcpy_s`, `wcscpy_s`, `_mbscpy_s`](./reference/strcpy-s-wcscpy-s-mbscpy-s.md) | Copy one string to another | +| [`strcspn`, `wcscspn`, `_mbscspn`, `_mbscspn_l`](./reference/strcspn-wcscspn-mbscspn-mbscspn-l.md) | Find first occurrence of character from specified character set in string | +| [`_strdup`, `_wcsdup`, `_mbsdup`](./reference/strdup-wcsdup-mbsdup.md), [`_strdup_dbg`, `_wcsdup_dbg`](./reference/strdup-dbg-wcsdup-dbg.md) | Duplicate string | +| [`strerror`, `_strerror`, `_wcserror`, `__wcserror`](./reference/strerror-strerror-wcserror-wcserror.md), [`strerror_s`, `_strerror_s`, `_wcserror_s`, `__wcserror_s`](./reference/strerror-s-strerror-s-wcserror-s-wcserror-s.md) | Map error number to message string | +| [`strftime`, `wcsftime`, `_strftime_l`, `_wcsftime_l`](./reference/strftime-wcsftime-strftime-l-wcsftime-l.md) | Format date-and-time string | +| [`_stricmp`, `_wcsicmp`, `_mbsicmp`, `_stricmp_l`, `_wcsicmp_l`, `_mbsicmp_l`](./reference/stricmp-wcsicmp-mbsicmp-stricmp-l-wcsicmp-l-mbsicmp-l.md) | Compare two strings without regard to case | +| [`strlen`, `wcslen`, `_mbslen`, `_mbslen_l`, `_mbstrlen`, `_mbstrlen_l`](./reference/strlen-wcslen-mbslen-mbslen-l-mbstrlen-mbstrlen-l.md), [`strnlen`, `strnlen_s`, `wcsnlen`, `wcsnlen_s`, `_mbsnlen`, `_mbsnlen_l`, `_mbstrnlen`, `_mbstrnlen_l`](./reference/strnlen-strnlen-s.md) | Find length of string | +| [`_strlwr`, `_wcslwr`, `_mbslwr`, `_strlwr_l`, `_wcslwr_l`, `_mbslwr_l`](./reference/strlwr-wcslwr-mbslwr-strlwr-l-wcslwr-l-mbslwr-l.md), [`_strlwr_s`, `_strlwr_s_l`, `_mbslwr_s`, `_mbslwr_s_l`, `_wcslwr_s`, `_wcslwr_s_l`](./reference/strlwr-s-strlwr-s-l-mbslwr-s-mbslwr-s-l-wcslwr-s-wcslwr-s-l.md) | Convert string to lowercase | +| [`strncat`, `_strncat_l`, `wcsncat`, `_wcsncat_l`, `_mbsncat`, `_mbsncat_l`](./reference/strncat-strncat-l-wcsncat-wcsncat-l-mbsncat-mbsncat-l.md), [`strncat_s`, `_strncat_s_l`, `wcsncat_s`, `_wcsncat_s_l`, `_mbsncat_s`, `_mbsncat_s_l`](./reference/strncat-s-strncat-s-l-wcsncat-s-wcsncat-s-l-mbsncat-s-mbsncat-s-l.md) | Append characters of string | +| [`strncmp`, `wcsncmp`, `_mbsncmp`, `_mbsncmp_l`](./reference/strncmp-wcsncmp-mbsncmp-mbsncmp-l.md) | Compare characters of two strings | +| [`strncpy`, `_strncpy_l`, `wcsncpy`, `_wcsncpy_l`, `_mbsncpy`, `_mbsncpy_l`](./reference/strncpy-strncpy-l-wcsncpy-wcsncpy-l-mbsncpy-mbsncpy-l.md), [`strncpy_s`, `_strncpy_s_l`, `wcsncpy_s`, `_wcsncpy_s_l`, `_mbsncpy_s`, `_mbsncpy_s_l`](./reference/strncpy-s-strncpy-s-l-wcsncpy-s-wcsncpy-s-l-mbsncpy-s-mbsncpy-s-l.md) | Copy characters of one string to another | +| [`_strnicmp`, `_wcsnicmp`, `_mbsnicmp`, `_strnicmp_l`, `_wcsnicmp_l`, `_mbsnicmp_l`](./reference/strnicmp-wcsnicmp-mbsnicmp-strnicmp-l-wcsnicmp-l-mbsnicmp-l.md) | Compare characters of two strings without regard to case | +| [`_strnset`, `_strnset_l`, `_wcsnset`, `_wcsnset_l`, `_mbsnset`, `_mbsnset_l`](./reference/strnset-strnset-l-wcsnset-wcsnset-l-mbsnset-mbsnset-l.md) | Set first *n* characters of string to specified character | +| [`strpbrk`, `wcspbrk`, `_mbspbrk`, `_mbspbrk_l`](./reference/strpbrk-wcspbrk-mbspbrk-mbspbrk-l.md) | Find first occurrence of character from one string in another string | +| [`strrchr`, `wcsrchr`, `_mbsrchr`, `_mbsrchr_l`](./reference/strrchr-wcsrchr-mbsrchr-mbsrchr-l.md) | Find last occurrence of given character in string | +| [`_strrev`, `_wcsrev`, `_mbsrev`, `_mbsrev_l`](./reference/strrev-wcsrev-mbsrev-mbsrev-l.md) | Reverse string | +| [`_strset`, `_strset_l`, `_wcsset`, `_wcsset_l`, `_mbsset`, `_mbsset_l`](./reference/strset-strset-l-wcsset-wcsset-l-mbsset-mbsset-l.md) | Set all characters of string to specified character | +| [`strspn`, `wcsspn`, `_mbsspn`, `_mbsspn_l`](./reference/strspn-wcsspn-mbsspn-mbsspn-l.md) | Find first occurrence in a string of a character not found in another string | +| [`strstr`, `wcsstr`, `_mbsstr`, `_mbsstr_l`](./reference/strstr-wcsstr-mbsstr-mbsstr-l.md) | Find first occurrence of specified string in another string | +| [`strtok`, `_strtok_l`, `wcstok`, `_wcstok_l`, `_mbstok`, `_mbstok_l`](./reference/strtok-strtok-l-wcstok-wcstok-l-mbstok-mbstok-l.md), [`strtok_s`, `_strtok_s_l`, `wcstok_s`, `_wcstok_s_l`, `_mbstok_s`, `_mbstok_s_l`](./reference/strtok-s-strtok-s-l-wcstok-s-wcstok-s-l-mbstok-s-mbstok-s-l.md) | Find next token in string | +| [`_strupr`, `_strupr_l`, `_mbsupr`, `_mbsupr_l`, `_wcsupr_l`, `_wcsupr`](./reference/strupr-strupr-l-mbsupr-mbsupr-l-wcsupr-l-wcsupr.md), [`_strupr_s`, `_strupr_s_l`, `_mbsupr_s`, `_mbsupr_s_l`, `_wcsupr_s`, `_wcsupr_s_l`](./reference/strupr-s-strupr-s-l-mbsupr-s-mbsupr-s-l-wcsupr-s-wcsupr-s-l.md) | Convert string to uppercase | +| [`strxfrm`, `wcsxfrm`, `_strxfrm_l`, `_wcsxfrm_l`](./reference/strxfrm-wcsxfrm-strxfrm-l-wcsxfrm-l.md) | Transform string into collated form based on locale-specific information | +| [`vsprintf`, `_vsprintf_l`, `vswprintf`, `_vswprintf_l`, `__vswprintf_l`](./reference/vsprintf-vsprintf-l-vswprintf-vswprintf-l-vswprintf-l.md), [`vsprintf_s`, `_vsprintf_s_l`, `vswprintf_s`, `_vswprintf_s_l`](./reference/vsprintf-s-vsprintf-s-l-vswprintf-s-vswprintf-s-l.md), [`_vsprintf_p`, `_vsprintf_p_l`, `_vswprintf_p`, `_vswprintf_p_l`](./reference/vsprintf-p-vsprintf-p-l-vswprintf-p-vswprintf-p-l.md) | Write formatted output using a pointer to a list of arguments | +| [`vsnprintf`, `_vsnprintf`, `_vsnprintf_l`, `_vsnwprintf`, `_vsnwprintf_l`](./reference/vsnprintf-vsnprintf-vsnprintf-l-vsnwprintf-vsnwprintf-l.md), [`vsnprintf_s`, `_vsnprintf_s`, `_vsnprintf_s_l`, `_vsnwprintf_s`, `_vsnwprintf_s_l`](./reference/vsnprintf-s-vsnprintf-s-vsnprintf-s-l-vsnwprintf-s-vsnwprintf-s-l.md) | Write formatted output using a pointer to a list of arguments | ## See also diff --git a/docs/c-runtime-library/system-calls.md b/docs/c-runtime-library/system-calls.md index b72b786c7eb..050ca9ac2b5 100644 --- a/docs/c-runtime-library/system-calls.md +++ b/docs/c-runtime-library/system-calls.md @@ -12,11 +12,11 @@ The following functions are Windows operating system calls. ## System call functions -|Function|Use| -|--------------|---------| -|[`_findclose`](./reference/findclose.md)|Release resources from previous find operations| -|[`_findfirst`, `_findfirst32`, `_findfirst64`, `_findfirsti64`, `_findfirst32i64`, `_findfirst64i32`, `_wfindfirst`, `_wfindfirst32`, `_wfindfirst64`, `_wfindfirsti64`, `_wfindfirst32i64`, `_wfindfirst64i32`](./reference/findfirst-functions.md)|Find file with specified attributes| -|[`_findnext`, `_findnext32`, `_findnext64`, `_findnexti64`, `_findnext32i64`, `_findnext64i32`, `_wfindnext`, `_wfindnext32`, `_wfindnexti64`, `_wfindnext64`, `_wfindnexti64`](./reference/findnext-functions.md)|Find next file with specified attributes| +| Function | Use | +|---|---| +| [`_findclose`](./reference/findclose.md) | Release resources from previous find operations | +| [`_findfirst`, `_findfirst32`, `_findfirst64`, `_findfirsti64`, `_findfirst32i64`, `_findfirst64i32`, `_wfindfirst`, `_wfindfirst32`, `_wfindfirst64`, `_wfindfirsti64`, `_wfindfirst32i64`, `_wfindfirst64i32`](./reference/findfirst-functions.md) | Find file with specified attributes | +| [`_findnext`, `_findnext32`, `_findnext64`, `_findnexti64`, `_findnext32i64`, `_findnext64i32`, `_wfindnext`, `_wfindnext32`, `_wfindnexti64`, `_wfindnext64`, `_wfindnexti64`](./reference/findnext-functions.md) | Find next file with specified attributes | ## See also diff --git a/docs/c-runtime-library/tgmath.md b/docs/c-runtime-library/tgmath.md index 60b6d0749a5..dff2a61f166 100644 --- a/docs/c-runtime-library/tgmath.md +++ b/docs/c-runtime-library/tgmath.md @@ -20,68 +20,68 @@ These macros are in their own header so that programs written using the `` and what they expand to. `modf` isn't included in this table because it doesn't have a corresponding type-generic macro because it isn't clear how to make it safe without complicating type resolution. -|Macro |Real
`float` | Real
`double` | Real
`long double` | Complex
`float` | Complex
`double` | Complex
`long double` | -|---------|---------|---------|---------|---------|---------|---------| -`acos` | [`acosf`](reference/mbsnbicmp-mbsnbicmp-l.md) | [`acos`](reference/mbsnbicmp-mbsnbicmp-l.md) | [`acosl`](reference/mbsnbicmp-mbsnbicmp-l.md) | [`cacosf`](reference/cacos-cacosf-cacosl.md) | [`cacos`](reference/cacos-cacosf-cacosl.md) | [`cacosl`](reference/cacos-cacosf-cacosl.md) | -`acosh` | [`acoshf`](reference/acosh-acoshf-acoshl.md) | [`acosh`](reference/acosh-acoshf-acoshl.md) | [`acoshl`](reference/acosh-acoshf-acoshl.md) | [`cacoshf`](reference/cacosh-cacoshf-cacoshl.md) | [`cacosh`](reference/cacosh-cacoshf-cacoshl.md) | [`cacoshl`](reference/cacosh-cacoshf-cacoshl.md) | -`asin` | [`asinf`](reference/asin-asinf-asinl.md) | [`asin`](reference/asin-asinf-asinl.md) | [`asinl`](reference/asin-asinf-asinl.md) | [`casinf`](reference/casin-casinf-casinl.md) | [`casin`](reference/casin-casinf-casinl.md) | [`casinl`](reference/casin-casinf-casinl.md) | -`asinh` | [`asinhf`](reference/asin-asinf-asinl.md) | [`asinh`](reference/asin-asinf-asinl.md) | [`asinhl`](reference/asin-asinf-asinl.md) | [`casinhf`](reference/casinh-casinhf-casinhl.md) | [`casinh`](reference/casinh-casinhf-casinhl.md) | [`casinhl`](reference/casinh-casinhf-casinhl.md) | -`atan` | [`atanf`](reference/atan-atanf-atanl-atan2-atan2f-atan2l.md) | [`atan`](reference/atan-atanf-atanl-atan2-atan2f-atan2l.md) | [`atanl`](reference/atan-atanf-atanl-atan2-atan2f-atan2l.md) | [`catanf`](reference/catan-catanf-catanl.md) | [`catan`](reference/catan-catanf-catanl.md) | [`catanl`](reference/catan-catanf-catanl.md) | -`atanh` | [`atanhf`](reference/atanh-atanhf-atanhl.md) | [`atanh`](reference/atanh-atanhf-atanhl.md) | [`atanhl`](reference/atanh-atanhf-atanhl.md) | [`catanhf`](reference/catanh-catanhf-catanhl.md) | [`catanh`](reference/catanh-catanhf-catanhl.md) | [`catanhl`](reference/catanh-catanhf-catanhl.md) | -`cos` | [`cosf`](reference/cos-cosf-cosl.md) | [`cos`](reference/cos-cosf-cosl.md) | [`cosl`](reference/cos-cosf-cosl.md) | [`ccosf`](reference/ccos-ccosf-ccosl.md) | [`ccos`](reference/ccos-ccosf-ccosl.md) | [`ccosl`](reference/ccos-ccosf-ccosl.md) | -`cosh` | [`coshf`](reference/cosh-coshf-coshl.md) | [`cosh`](reference/cosh-coshf-coshl.md) | [`coshl`](reference/cosh-coshf-coshl.md) | [`ccoshf`](reference/ccosh-ccoshf-ccoshl.md) | [`ccosh`](reference/ccosh-ccoshf-ccoshl.md) | [`ccoshl`](reference/ccosh-ccoshf-ccoshl.md) | -`exp` | [`expf`](reference/exp-expf.md) | [`exp`](reference/exp-expf.md) | [`expl`](reference/exp-expf.md) | [`cexpf`](reference/cexp-cexpf-cexpl.md) | [`cexp`](reference/cexp-cexpf-cexpl.md) | [`cexpl`](reference/cexp-cexpf-cexpl.md) | -`fabs` | [`fabsf`](reference/fabs-fabsf-fabsl.md) | [`fabs`](reference/fabs-fabsf-fabsl.md) | [`fabsl`](reference/fabs-fabsf-fabsl.md) | [`cabsf`](reference/cabs-cabsf-cabsl.md) | [`cabs`](reference/cabs-cabsf-cabsl.md) | [`cabsl`](reference/cabs-cabsf-cabsl.md) | -`log` | [`logf`](reference/log-logf-log10-log10f.md) | [`log`](reference/log-logf-log10-log10f.md) | [`logl`](reference/log-logf-log10-log10f.md) | [`clogf`](reference/clog-clogf-clogl.md) | [`clog`](reference/clog-clogf-clogl.md) | [`clogl`](reference/clog-clogf-clogl.md) | -`pow` | [`powf`](reference/pow-powf-powl.md) | [`pow`](reference/pow-powf-powl.md) | [`powl`](reference/pow-powf-powl.md) | [`cpowf`](reference/cpow-cpowf-cpowl.md) | [`cpow`](reference/cpow-cpowf-cpowl.md) | [`cpowl`](reference/cpow-cpowf-cpowl.md) | -`sin` | [`sinf`](reference/sin-sinf-sinl.md) | [`sin`](reference/sin-sinf-sinl.md) | [`sinl`](reference/sin-sinf-sinl.md) | [`csinf`](reference/csin-csinf-csinl.md) | [`csin`](reference/csin-csinf-csinl.md) | [`csinl`](reference/csin-csinf-csinl.md) | -`sinh` | [`sinhf`](reference/sinh-sinhf-sinhl.md) | [`sinh`](reference/sinh-sinhf-sinhl.md) | [`sinhl`](reference/sinh-sinhf-sinhl.md) | [`csinhf`](reference/csinh-csinhf-csinhl.md) | [`csinh`](reference/csinh-csinhf-csinhl.md) | [`csinhl`](reference/csinh-csinhf-csinhl.md) | -`sqrt` | [`sqrtf`](reference/sqrt-sqrtf-sqrtl.md) | [`sqrt`](reference/sqrt-sqrtf-sqrtl.md) | [`sqrtl`](reference/sqrt-sqrtf-sqrtl.md) | [`csqrtf`](reference/csqrt-csqrtf-csqrtl.md) | [`csqrt`](reference/csqrt-csqrtf-csqrtl.md) | [`csqrtl`](reference/csqrt-csqrtf-csqrtl.md) | -`tan` | [`tanf`](reference/tan-tanf-tanl.md) | [`tan`](reference/tan-tanf-tanl.md) | [`tanl`](reference/tan-tanf-tanl.md) | [`ctanf`](reference/ctan-ctanf-ctanl.md) | [`ctan`](reference/ctan-ctanf-ctanl.md) | [`ctanl`](reference/ctan-ctanf-ctanl.md) | -`tanh` | [`tanhf`](reference/tanh-tanhf-tanhl.md) | [`tanh`](reference/tanh-tanhf-tanhl.md) | [`tanhl`](reference/tanh-tanhf-tanhl.md) | [`ctanhf`](reference/ctanh-ctanhf-ctanhl.md) | [`ctanh`](reference/ctanh-ctanhf-ctanhl.md) | [`ctanhl`](reference/ctanh-ctanhf-ctanhl.md) | -`atan2` | [`atan2f`](reference/atan-atanf-atanl-atan2-atan2f-atan2l.md) | [`atan2`](reference/atan-atanf-atanl-atan2-atan2f-atan2l.md) | [`atan2l`](reference/atan-atanf-atanl-atan2-atan2f-atan2l.md) | - | - | - | -`cbrt` | [`cbrtf`](reference/cbrt-cbrtf-cbrtl.md) | [`cbrt`](reference/cbrt-cbrtf-cbrtl.md) | [`cbrtl`](reference/cbrt-cbrtf-cbrtl.md) | - | - | - | -`ceil` | [`ceilf`](reference/ceil-ceilf-ceill.md) | [`ceil`](reference/ceil-ceilf-ceill.md) | [`ceill`](reference/ceil-ceilf-ceill.md) | - | - | - | -`copysign` | [`copysignf`](reference/copysign-copysignf-copysignl-copysign-copysignf-copysignl.md) | [`copysign`](reference/copysign-copysignf-copysignl-copysign-copysignf-copysignl.md) | [`copysignl`](reference/copysign-copysignf-copysignl-copysign-copysignf-copysignl.md) | - | - | - | -`erf` | [`erff`](reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | [`erf`](reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | [`erfl`](reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | - | - | - | -`erfc` | [`erfcf`](reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | [`erfc`](reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | [`erfcl`](reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | - | - | - | -`exp2` | [`exp2f`](reference/exp2-exp2f-exp2l.md) | [`exp2`](reference/exp2-exp2f-exp2l.md) | [`exp2l`](reference/exp2-exp2f-exp2l.md) | - | - | - | -`expm1` | [`expm1f`](reference/expm1-expm1f-expm1l.md) | [`expm1`](reference/expm1-expm1f-expm1l.md) | [`expm1l`](reference/expm1-expm1f-expm1l.md) | - | - | - | -`fdim` | [`fdimf`](reference/fdim-fdimf-fdiml.md) | [`fdim`](reference/fdim-fdimf-fdiml.md) | [`fdiml`](reference/fdim-fdimf-fdiml.md) | - | - | - | -`floor` | [`floorf`](reference/floor-floorf-floorl.md) | [`floor`](reference/floor-floorf-floorl.md) | [`floorl`](reference/floor-floorf-floorl.md) | - | - | - | -`fma` | [`fmaf`](reference/fma-fmaf-fmal.md) | [`fma`](reference/fma-fmaf-fmal.md) | [`fmal`](reference/fma-fmaf-fmal.md) | - | - | - | -`fmax` | [`fmaxf`](reference/fmax-fmaxf-fmaxl.md) | [`fmax`](reference/fmax-fmaxf-fmaxl.md) | [`fmaxl`](reference/fmax-fmaxf-fmaxl.md) | - | - | - | -`fmin` | [`fminf`](reference/fmin-fminf-fminl.md) | [`fmin`](reference/fmin-fminf-fminl.md) | [`fminl`](reference/fmin-fminf-fminl.md) | - | - | - | -`fmod` | [`fmodf`](reference/fmod-fmodf.md) | [`fmod`](reference/fmod-fmodf.md) | [`fmodl`](reference/fmod-fmodf.md) | - | - | - | -`frexp` | [`frexpf`](reference/frexp.md) | [`frexp`](reference/frexp.md) | [`frexpl`](reference/frexp.md) | - | - | - | -`hypot` | [`hypotf`](reference/hypot-hypotf-hypotl-hypot-hypotf-hypotl.md) | [`hypot`](reference/hypot-hypotf-hypotl-hypot-hypotf-hypotl.md) | [`hypotl`](reference/hypot-hypotf-hypotl-hypot-hypotf-hypotl.md) | - | - | - | -`ilogb` | [`ilogbf`](reference/ilogb-ilogbf-ilogbl2.md) | [`ilogb`](reference/ilogb-ilogbf-ilogbl2.md) | [`ilogbl`](reference/ilogb-ilogbf-ilogbl2.md) | - | - | - | -`ldexp` | [`ldexpf`](reference/ldexp.md) | [`ldexp`](reference/ldexp.md) | [`ldexpl`](reference/ldexp.md) | - | - | - | -`lgamma` | [`lgammaf`](reference/lgamma-lgammaf-lgammal.md) | [`lgamma`](reference/lgamma-lgammaf-lgammal.md) | [`lgammal`](reference/lgamma-lgammaf-lgammal.md) | - | - | - | -`llrint` | [`llrintf`](reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | [`llrint`](reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | [`llrintl`](reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | - | - | - | -`llround` | [`llroundf`](reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | [`llround`](reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | [`llroundl`](reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | - | - | - | -`log10` | [`log10f`](reference/log-logf-log10-log10f.md) | [`log10`](reference/log-logf-log10-log10f.md) | [`log10l`](reference/log-logf-log10-log10f.md) | - | - | - | -`log1p` | [`log1pf`](reference/log1p-log1pf-log1pl2.md) | [`log1p`](reference/log1p-log1pf-log1pl2.md) | [`log1pl`](reference/log1p-log1pf-log1pl2.md) | - | - | - | -`log2` | [`log2f`](reference/log2-log2f-log2l.md) | [`log2`](reference/log2-log2f-log2l.md) | [`log2l`](reference/log2-log2f-log2l.md) | - | - | - | -`logb` | [`logbf`](reference/logb-logbf-logbl-logb-logbf.md) | [`logb`](reference/logb-logbf-logbl-logb-logbf.md) | [`logbl`](reference/logb-logbf-logbl-logb-logbf.md) | - | - | - | -`lrint` | [`lrintf`](reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | [`lrint`](reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | [`lrintl`](reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | - | - | - | -`lround` | [`lroundf`](reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | [`lround`](reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | [`lroundl`](reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | - | - | - | -`nearbyint` | [`nearbyintf`](reference/nearbyint-nearbyintf-nearbyintl1.md) | [`nearbyint`](reference/nearbyint-nearbyintf-nearbyintl1.md) | [`nearbyintl`](reference/nearbyint-nearbyintf-nearbyintl1.md) | - | - | - | -`nextafter` | [`nextafterf`](reference/nextafter-functions.md) | [`nextafter`](reference/nextafter-functions.md) | [`nextafterl`](reference/nextafter-functions.md) | - | - | - | -`nexttoward` | [`nexttowardf`](reference/nextafter-functions.md) | [`nexttoward`](reference/nextafter-functions.md) | [`nexttowardl`](reference/nextafter-functions.md) | - | - | - | -`remainder` | [`remainderf`](reference/remainder-remainderf-remainderl.md) | [`remainder`](reference/remainder-remainderf-remainderl.md) | [`remainderl`](reference/remainder-remainderf-remainderl.md) | - | - | - | -`remquo` | [`remquof`](reference/remquo-remquof-remquol.md) | [`remquo`](reference/remquo-remquof-remquol.md) | [`remquol`](reference/remquo-remquof-remquol.md) | - | - | - | -`rint` | [`rintf`](reference/rint-rintf-rintl.md) | [`rint`](reference/rint-rintf-rintl.md) | [`rintl`](reference/rint-rintf-rintl.md) | - | - | - | -`round` | [`roundf`](reference/round-roundf-roundl.md) | [`round`](reference/round-roundf-roundl.md) | [`roundl`](reference/round-roundf-roundl.md) | - | - | - | -`scalbln` | [`scalblnf`](reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md) | [`scalbln`](reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md) | [`scalblnl`](reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md) | - | - | - | -`scalbn` | [`scalbnf`](reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md) | [`scalbn`](reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md) | [`scalbnl`](reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md) | - | - | - | -`tgamma` | [`tgammaf`](reference/tgamma-tgammaf-tgammal.md) | [`tgamma`](reference/tgamma-tgammaf-tgammal.md) | [`tgammal`](reference/tgamma-tgammaf-tgammal.md) | - | - | - | -`trunc` | [`truncf`](reference/trunc-truncf-truncl.md) | [`trunc`](reference/trunc-truncf-truncl.md) | [`truncl`](reference/trunc-truncf-truncl.md) | - | - | - | -`carg` | - | - | - | [`cargf`](reference/carg-cargf-cargl.md) | [`carg`](reference/carg-cargf-cargl.md) | [`cargl`](reference/carg-cargf-cargl.md) | -`conj` | - | - | - | [`conjf`](reference/conj-conjf-conjl.md) | [`conj`](reference/conj-conjf-conjl.md) | [`conjl`](reference/conj-conjf-conjl.md) | -`creal` | - | - | - | [`crealf`](reference/creal-crealf-creall.md) | [`creal`](reference/creal-crealf-creall.md) | [`creall`](reference/creal-crealf-creall.md) | -`cimag` | - | - | - | [`cimagf`](reference/cimag-cimagf-cimagl.md) | [`cimag`](reference/cimag-cimagf-cimagl.md) | [`cimagl`](reference/cimag-cimagf-cimagl.md) | -`cproj` | - | - | - | [`cprojf`](reference/cproj-cprojf-cprojl.md) | [`cproj`](reference/cproj-cprojf-cprojl.md) | [`cprojl`](reference/cproj-cprojf-cprojl.md) | +| Macro | Real
`float` | Real
`double` | Real
`long double` | Complex
`float` | Complex
`double` | Complex
`long double` | +|---|---|---|---|---|---|---| +| `acos` | [`acosf`](reference/mbsnbicmp-mbsnbicmp-l.md) | [`acos`](reference/mbsnbicmp-mbsnbicmp-l.md) | [`acosl`](reference/mbsnbicmp-mbsnbicmp-l.md) | [`cacosf`](reference/cacos-cacosf-cacosl.md) | [`cacos`](reference/cacos-cacosf-cacosl.md) | [`cacosl`](reference/cacos-cacosf-cacosl.md) | +| `acosh` | [`acoshf`](reference/acosh-acoshf-acoshl.md) | [`acosh`](reference/acosh-acoshf-acoshl.md) | [`acoshl`](reference/acosh-acoshf-acoshl.md) | [`cacoshf`](reference/cacosh-cacoshf-cacoshl.md) | [`cacosh`](reference/cacosh-cacoshf-cacoshl.md) | [`cacoshl`](reference/cacosh-cacoshf-cacoshl.md) | +| `asin` | [`asinf`](reference/asin-asinf-asinl.md) | [`asin`](reference/asin-asinf-asinl.md) | [`asinl`](reference/asin-asinf-asinl.md) | [`casinf`](reference/casin-casinf-casinl.md) | [`casin`](reference/casin-casinf-casinl.md) | [`casinl`](reference/casin-casinf-casinl.md) | +| `asinh` | [`asinhf`](reference/asin-asinf-asinl.md) | [`asinh`](reference/asin-asinf-asinl.md) | [`asinhl`](reference/asin-asinf-asinl.md) | [`casinhf`](reference/casinh-casinhf-casinhl.md) | [`casinh`](reference/casinh-casinhf-casinhl.md) | [`casinhl`](reference/casinh-casinhf-casinhl.md) | +| `atan` | [`atanf`](reference/atan-atanf-atanl-atan2-atan2f-atan2l.md) | [`atan`](reference/atan-atanf-atanl-atan2-atan2f-atan2l.md) | [`atanl`](reference/atan-atanf-atanl-atan2-atan2f-atan2l.md) | [`catanf`](reference/catan-catanf-catanl.md) | [`catan`](reference/catan-catanf-catanl.md) | [`catanl`](reference/catan-catanf-catanl.md) | +| `atanh` | [`atanhf`](reference/atanh-atanhf-atanhl.md) | [`atanh`](reference/atanh-atanhf-atanhl.md) | [`atanhl`](reference/atanh-atanhf-atanhl.md) | [`catanhf`](reference/catanh-catanhf-catanhl.md) | [`catanh`](reference/catanh-catanhf-catanhl.md) | [`catanhl`](reference/catanh-catanhf-catanhl.md) | +| `cos` | [`cosf`](reference/cos-cosf-cosl.md) | [`cos`](reference/cos-cosf-cosl.md) | [`cosl`](reference/cos-cosf-cosl.md) | [`ccosf`](reference/ccos-ccosf-ccosl.md) | [`ccos`](reference/ccos-ccosf-ccosl.md) | [`ccosl`](reference/ccos-ccosf-ccosl.md) | +| `cosh` | [`coshf`](reference/cosh-coshf-coshl.md) | [`cosh`](reference/cosh-coshf-coshl.md) | [`coshl`](reference/cosh-coshf-coshl.md) | [`ccoshf`](reference/ccosh-ccoshf-ccoshl.md) | [`ccosh`](reference/ccosh-ccoshf-ccoshl.md) | [`ccoshl`](reference/ccosh-ccoshf-ccoshl.md) | +| `exp` | [`expf`](reference/exp-expf.md) | [`exp`](reference/exp-expf.md) | [`expl`](reference/exp-expf.md) | [`cexpf`](reference/cexp-cexpf-cexpl.md) | [`cexp`](reference/cexp-cexpf-cexpl.md) | [`cexpl`](reference/cexp-cexpf-cexpl.md) | +| `fabs` | [`fabsf`](reference/fabs-fabsf-fabsl.md) | [`fabs`](reference/fabs-fabsf-fabsl.md) | [`fabsl`](reference/fabs-fabsf-fabsl.md) | [`cabsf`](reference/cabs-cabsf-cabsl.md) | [`cabs`](reference/cabs-cabsf-cabsl.md) | [`cabsl`](reference/cabs-cabsf-cabsl.md) | +| `log` | [`logf`](reference/log-logf-log10-log10f.md) | [`log`](reference/log-logf-log10-log10f.md) | [`logl`](reference/log-logf-log10-log10f.md) | [`clogf`](reference/clog-clogf-clogl.md) | [`clog`](reference/clog-clogf-clogl.md) | [`clogl`](reference/clog-clogf-clogl.md) | +| `pow` | [`powf`](reference/pow-powf-powl.md) | [`pow`](reference/pow-powf-powl.md) | [`powl`](reference/pow-powf-powl.md) | [`cpowf`](reference/cpow-cpowf-cpowl.md) | [`cpow`](reference/cpow-cpowf-cpowl.md) | [`cpowl`](reference/cpow-cpowf-cpowl.md) | +| `sin` | [`sinf`](reference/sin-sinf-sinl.md) | [`sin`](reference/sin-sinf-sinl.md) | [`sinl`](reference/sin-sinf-sinl.md) | [`csinf`](reference/csin-csinf-csinl.md) | [`csin`](reference/csin-csinf-csinl.md) | [`csinl`](reference/csin-csinf-csinl.md) | +| `sinh` | [`sinhf`](reference/sinh-sinhf-sinhl.md) | [`sinh`](reference/sinh-sinhf-sinhl.md) | [`sinhl`](reference/sinh-sinhf-sinhl.md) | [`csinhf`](reference/csinh-csinhf-csinhl.md) | [`csinh`](reference/csinh-csinhf-csinhl.md) | [`csinhl`](reference/csinh-csinhf-csinhl.md) | +| `sqrt` | [`sqrtf`](reference/sqrt-sqrtf-sqrtl.md) | [`sqrt`](reference/sqrt-sqrtf-sqrtl.md) | [`sqrtl`](reference/sqrt-sqrtf-sqrtl.md) | [`csqrtf`](reference/csqrt-csqrtf-csqrtl.md) | [`csqrt`](reference/csqrt-csqrtf-csqrtl.md) | [`csqrtl`](reference/csqrt-csqrtf-csqrtl.md) | +| `tan` | [`tanf`](reference/tan-tanf-tanl.md) | [`tan`](reference/tan-tanf-tanl.md) | [`tanl`](reference/tan-tanf-tanl.md) | [`ctanf`](reference/ctan-ctanf-ctanl.md) | [`ctan`](reference/ctan-ctanf-ctanl.md) | [`ctanl`](reference/ctan-ctanf-ctanl.md) | +| `tanh` | [`tanhf`](reference/tanh-tanhf-tanhl.md) | [`tanh`](reference/tanh-tanhf-tanhl.md) | [`tanhl`](reference/tanh-tanhf-tanhl.md) | [`ctanhf`](reference/ctanh-ctanhf-ctanhl.md) | [`ctanh`](reference/ctanh-ctanhf-ctanhl.md) | [`ctanhl`](reference/ctanh-ctanhf-ctanhl.md) | +| `atan2` | [`atan2f`](reference/atan-atanf-atanl-atan2-atan2f-atan2l.md) | [`atan2`](reference/atan-atanf-atanl-atan2-atan2f-atan2l.md) | [`atan2l`](reference/atan-atanf-atanl-atan2-atan2f-atan2l.md) | - | - | - | +| `cbrt` | [`cbrtf`](reference/cbrt-cbrtf-cbrtl.md) | [`cbrt`](reference/cbrt-cbrtf-cbrtl.md) | [`cbrtl`](reference/cbrt-cbrtf-cbrtl.md) | - | - | - | +| `ceil` | [`ceilf`](reference/ceil-ceilf-ceill.md) | [`ceil`](reference/ceil-ceilf-ceill.md) | [`ceill`](reference/ceil-ceilf-ceill.md) | - | - | - | +| `copysign` | [`copysignf`](reference/copysign-copysignf-copysignl-copysign-copysignf-copysignl.md) | [`copysign`](reference/copysign-copysignf-copysignl-copysign-copysignf-copysignl.md) | [`copysignl`](reference/copysign-copysignf-copysignl-copysign-copysignf-copysignl.md) | - | - | - | +| `erf` | [`erff`](reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | [`erf`](reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | [`erfl`](reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | - | - | - | +| `erfc` | [`erfcf`](reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | [`erfc`](reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | [`erfcl`](reference/erf-erff-erfl-erfc-erfcf-erfcl.md) | - | - | - | +| `exp2` | [`exp2f`](reference/exp2-exp2f-exp2l.md) | [`exp2`](reference/exp2-exp2f-exp2l.md) | [`exp2l`](reference/exp2-exp2f-exp2l.md) | - | - | - | +| `expm1` | [`expm1f`](reference/expm1-expm1f-expm1l.md) | [`expm1`](reference/expm1-expm1f-expm1l.md) | [`expm1l`](reference/expm1-expm1f-expm1l.md) | - | - | - | +| `fdim` | [`fdimf`](reference/fdim-fdimf-fdiml.md) | [`fdim`](reference/fdim-fdimf-fdiml.md) | [`fdiml`](reference/fdim-fdimf-fdiml.md) | - | - | - | +| `floor` | [`floorf`](reference/floor-floorf-floorl.md) | [`floor`](reference/floor-floorf-floorl.md) | [`floorl`](reference/floor-floorf-floorl.md) | - | - | - | +| `fma` | [`fmaf`](reference/fma-fmaf-fmal.md) | [`fma`](reference/fma-fmaf-fmal.md) | [`fmal`](reference/fma-fmaf-fmal.md) | - | - | - | +| `fmax` | [`fmaxf`](reference/fmax-fmaxf-fmaxl.md) | [`fmax`](reference/fmax-fmaxf-fmaxl.md) | [`fmaxl`](reference/fmax-fmaxf-fmaxl.md) | - | - | - | +| `fmin` | [`fminf`](reference/fmin-fminf-fminl.md) | [`fmin`](reference/fmin-fminf-fminl.md) | [`fminl`](reference/fmin-fminf-fminl.md) | - | - | - | +| `fmod` | [`fmodf`](reference/fmod-fmodf.md) | [`fmod`](reference/fmod-fmodf.md) | [`fmodl`](reference/fmod-fmodf.md) | - | - | - | +| `frexp` | [`frexpf`](reference/frexp.md) | [`frexp`](reference/frexp.md) | [`frexpl`](reference/frexp.md) | - | - | - | +| `hypot` | [`hypotf`](reference/hypot-hypotf-hypotl-hypot-hypotf-hypotl.md) | [`hypot`](reference/hypot-hypotf-hypotl-hypot-hypotf-hypotl.md) | [`hypotl`](reference/hypot-hypotf-hypotl-hypot-hypotf-hypotl.md) | - | - | - | +| `ilogb` | [`ilogbf`](reference/ilogb-ilogbf-ilogbl2.md) | [`ilogb`](reference/ilogb-ilogbf-ilogbl2.md) | [`ilogbl`](reference/ilogb-ilogbf-ilogbl2.md) | - | - | - | +| `ldexp` | [`ldexpf`](reference/ldexp.md) | [`ldexp`](reference/ldexp.md) | [`ldexpl`](reference/ldexp.md) | - | - | - | +| `lgamma` | [`lgammaf`](reference/lgamma-lgammaf-lgammal.md) | [`lgamma`](reference/lgamma-lgammaf-lgammal.md) | [`lgammal`](reference/lgamma-lgammaf-lgammal.md) | - | - | - | +| `llrint` | [`llrintf`](reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | [`llrint`](reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | [`llrintl`](reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | - | - | - | +| `llround` | [`llroundf`](reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | [`llround`](reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | [`llroundl`](reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | - | - | - | +| `log10` | [`log10f`](reference/log-logf-log10-log10f.md) | [`log10`](reference/log-logf-log10-log10f.md) | [`log10l`](reference/log-logf-log10-log10f.md) | - | - | - | +| `log1p` | [`log1pf`](reference/log1p-log1pf-log1pl2.md) | [`log1p`](reference/log1p-log1pf-log1pl2.md) | [`log1pl`](reference/log1p-log1pf-log1pl2.md) | - | - | - | +| `log2` | [`log2f`](reference/log2-log2f-log2l.md) | [`log2`](reference/log2-log2f-log2l.md) | [`log2l`](reference/log2-log2f-log2l.md) | - | - | - | +| `logb` | [`logbf`](reference/logb-logbf-logbl-logb-logbf.md) | [`logb`](reference/logb-logbf-logbl-logb-logbf.md) | [`logbl`](reference/logb-logbf-logbl-logb-logbf.md) | - | - | - | +| `lrint` | [`lrintf`](reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | [`lrint`](reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | [`lrintl`](reference/lrint-lrintf-lrintl-llrint-llrintf-llrintl.md) | - | - | - | +| `lround` | [`lroundf`](reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | [`lround`](reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | [`lroundl`](reference/lround-lroundf-lroundl-llround-llroundf-llroundl.md) | - | - | - | +| `nearbyint` | [`nearbyintf`](reference/nearbyint-nearbyintf-nearbyintl1.md) | [`nearbyint`](reference/nearbyint-nearbyintf-nearbyintl1.md) | [`nearbyintl`](reference/nearbyint-nearbyintf-nearbyintl1.md) | - | - | - | +| `nextafter` | [`nextafterf`](reference/nextafter-functions.md) | [`nextafter`](reference/nextafter-functions.md) | [`nextafterl`](reference/nextafter-functions.md) | - | - | - | +| `nexttoward` | [`nexttowardf`](reference/nextafter-functions.md) | [`nexttoward`](reference/nextafter-functions.md) | [`nexttowardl`](reference/nextafter-functions.md) | - | - | - | +| `remainder` | [`remainderf`](reference/remainder-remainderf-remainderl.md) | [`remainder`](reference/remainder-remainderf-remainderl.md) | [`remainderl`](reference/remainder-remainderf-remainderl.md) | - | - | - | +| `remquo` | [`remquof`](reference/remquo-remquof-remquol.md) | [`remquo`](reference/remquo-remquof-remquol.md) | [`remquol`](reference/remquo-remquof-remquol.md) | - | - | - | +| `rint` | [`rintf`](reference/rint-rintf-rintl.md) | [`rint`](reference/rint-rintf-rintl.md) | [`rintl`](reference/rint-rintf-rintl.md) | - | - | - | +| `round` | [`roundf`](reference/round-roundf-roundl.md) | [`round`](reference/round-roundf-roundl.md) | [`roundl`](reference/round-roundf-roundl.md) | - | - | - | +| `scalbln` | [`scalblnf`](reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md) | [`scalbln`](reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md) | [`scalblnl`](reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md) | - | - | - | +| `scalbn` | [`scalbnf`](reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md) | [`scalbn`](reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md) | [`scalbnl`](reference/scalbn-scalbnf-scalbnl-scalbln-scalblnf-scalblnl.md) | - | - | - | +| `tgamma` | [`tgammaf`](reference/tgamma-tgammaf-tgammal.md) | [`tgamma`](reference/tgamma-tgammaf-tgammal.md) | [`tgammal`](reference/tgamma-tgammaf-tgammal.md) | - | - | - | +| `trunc` | [`truncf`](reference/trunc-truncf-truncl.md) | [`trunc`](reference/trunc-truncf-truncl.md) | [`truncl`](reference/trunc-truncf-truncl.md) | - | - | - | +| `carg` | - | - | - | [`cargf`](reference/carg-cargf-cargl.md) | [`carg`](reference/carg-cargf-cargl.md) | [`cargl`](reference/carg-cargf-cargl.md) | +| `conj` | - | - | - | [`conjf`](reference/conj-conjf-conjl.md) | [`conj`](reference/conj-conjf-conjl.md) | [`conjl`](reference/conj-conjf-conjl.md) | +| `creal` | - | - | - | [`crealf`](reference/creal-crealf-creall.md) | [`creal`](reference/creal-crealf-creall.md) | [`creall`](reference/creal-crealf-creall.md) | +| `cimag` | - | - | - | [`cimagf`](reference/cimag-cimagf-cimagl.md) | [`cimag`](reference/cimag-cimagf-cimagl.md) | [`cimagl`](reference/cimag-cimagf-cimagl.md) | +| `cproj` | - | - | - | [`cprojf`](reference/cproj-cprojf-cprojl.md) | [`cproj`](reference/cproj-cprojf-cprojl.md) | [`cprojl`](reference/cproj-cprojf-cprojl.md) | ## Requirements diff --git a/docs/c-runtime-library/time-management.md b/docs/c-runtime-library/time-management.md index 6b45a14c158..784c4b009ac 100644 --- a/docs/c-runtime-library/time-management.md +++ b/docs/c-runtime-library/time-management.md @@ -12,24 +12,24 @@ The **`_ftime`** and **`localtime`** routines use the **`TZ`** environment varia ### Time routines -|Function|Use| -|--------------|---------| -|[`asctime`, `_wasctime`](./reference/asctime-wasctime.md), [`asctime_s`, `_wasctime_s`](./reference/asctime-s-wasctime-s.md)|Convert time from type **`struct tm`** to character string. The versions of these functions with the **`_s`** suffix are more secure.| -|[`clock`](./reference/clock.md)|Return elapsed wall-clock time for process.| -|[`ctime`, `_ctime32`, `_ctime64`, `_wctime`, `_wctime32`, `_wctime64`](./reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md), [`_ctime_s`, `_ctime32_s`, `_ctime64_s`, `_wctime_s`, `_wctime32_s`, `_wctime64_s`](./reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md)|Convert time from type **`time_t`**, **`__time32_t`** or **`__time64_t`** to character string. The versions of these functions with the **`_s`** suffix are more secure.| -|[`difftime`, `_difftime32`, `_difftime64`](./reference/difftime-difftime32-difftime64.md)|Compute difference between two times.| -|[`_ftime`, `_ftime32`, `_ftime64`](./reference/ftime-ftime32-ftime64.md),[`_ftime_s`, `_ftime32_s`, _ftime64_s](./reference/ftime-s-ftime32-s-ftime64-s.md)|Store current system time in variable of type **`struct _timeb`** or type **`struct __timeb64`** The versions of these functions with the **`_s`** suffix are more secure.| -|[`_futime`, `_futime32`, `_futime64`](./reference/futime-futime32-futime64.md)|Set modification time on open file| -|[`gmtime`, `_gmtime32`, `_gmtime64`](./reference/gmtime-gmtime32-gmtime64.md), [`gmtime_s`, `_gmtime32_s`, `_gmtime64_s`](./reference/gmtime-s-gmtime32-s-gmtime64-s.md)|Convert time from type **`time_t`** to **`struct tm`** or from type **`__time64_t`** to **`struct tm`**. The versions of these functions with the **`_s`** suffix are more secure.| -|[`localtime`, `_localtime32`, `_localtime64`](./reference/localtime-localtime32-localtime64.md), [`localtime_s`, `_localtime32_s`, `_localtime64_s`](./reference/localtime-s-localtime32-s-localtime64-s.md)|Convert time from type **`time_t`** to **`struct tm`** or from type **`__time64_t`** to **`struct tm`** with local correction. The versions of these functions with the **`_s`** suffix are more secure.| -|[`_mkgmtime`, `_mkgmtime32`, `_mkgmtime64`](./reference/mkgmtime-mkgmtime32-mkgmtime64.md)|Convert time to calendar value in Greenwich Mean Time.| -|[`mktime`, `_mktime32`, `_mktime64`](./reference/mktime-mktime32-mktime64.md)|Convert time to calendar value.| -|[`_strdate`, `_wstrdate`](./reference/strdate-wstrdate.md), [`_strdate_s`, `_wstrdate_s`](./reference/strdate-s-wstrdate-s.md)|Return current system date as string. The versions of these functions with the **`_s`** suffix are more secure.| -|[`strftime`, `wcsftime`, `_strftime_l`, `_wcsftime_l`](./reference/strftime-wcsftime-strftime-l-wcsftime-l.md)|Format date-and-time string for international use.| -|[`_strtime`, `_wstrtime`](./reference/strtime-wstrtime.md), [`_strtime_s`, `_wstrtime_s`](./reference/strtime-s-wstrtime-s.md)|Return current system time as string. The versions of these functions with the **`_s`** suffix are more secure.| -|[`time`, `_time32`, `_time64`](./reference/time-time32-time64.md)|Get current system time as type **`time_t`**, **`__time32_t`** or as type **`__time64_t`**.| -|[`_tzset`](./reference/tzset.md)|Set external time variables from environment time variable **`TZ`**.| -|[`_utime`, `_utime32`, `_utime64`, `_wutime`, `_wutime32`, `_wutime64`](./reference/utime-utime32-utime64-wutime-wutime32-wutime64.md)|Set modification time for specified file using either current time or time value stored in structure.| +| Function | Use | +|---|---| +| [`asctime`, `_wasctime`](./reference/asctime-wasctime.md), [`asctime_s`, `_wasctime_s`](./reference/asctime-s-wasctime-s.md) | Convert time from type **`struct tm`** to character string. The versions of these functions with the **`_s`** suffix are more secure. | +| [`clock`](./reference/clock.md) | Return elapsed wall-clock time for process. | +| [`ctime`, `_ctime32`, `_ctime64`, `_wctime`, `_wctime32`, `_wctime64`](./reference/ctime-ctime32-ctime64-wctime-wctime32-wctime64.md), [`_ctime_s`, `_ctime32_s`, `_ctime64_s`, `_wctime_s`, `_wctime32_s`, `_wctime64_s`](./reference/ctime-s-ctime32-s-ctime64-s-wctime-s-wctime32-s-wctime64-s.md) | Convert time from type **`time_t`**, **`__time32_t`** or **`__time64_t`** to character string. The versions of these functions with the **`_s`** suffix are more secure. | +| [`difftime`, `_difftime32`, `_difftime64`](./reference/difftime-difftime32-difftime64.md) | Compute difference between two times. | +| [`_ftime`, `_ftime32`, `_ftime64`](./reference/ftime-ftime32-ftime64.md),[`_ftime_s`, `_ftime32_s`, _ftime64_s](./reference/ftime-s-ftime32-s-ftime64-s.md) | Store current system time in variable of type **`struct _timeb`** or type **`struct __timeb64`** The versions of these functions with the **`_s`** suffix are more secure. | +| [`_futime`, `_futime32`, `_futime64`](./reference/futime-futime32-futime64.md) | Set modification time on open file | +| [`gmtime`, `_gmtime32`, `_gmtime64`](./reference/gmtime-gmtime32-gmtime64.md), [`gmtime_s`, `_gmtime32_s`, `_gmtime64_s`](./reference/gmtime-s-gmtime32-s-gmtime64-s.md) | Convert time from type **`time_t`** to **`struct tm`** or from type **`__time64_t`** to **`struct tm`**. The versions of these functions with the **`_s`** suffix are more secure. | +| [`localtime`, `_localtime32`, `_localtime64`](./reference/localtime-localtime32-localtime64.md), [`localtime_s`, `_localtime32_s`, `_localtime64_s`](./reference/localtime-s-localtime32-s-localtime64-s.md) | Convert time from type **`time_t`** to **`struct tm`** or from type **`__time64_t`** to **`struct tm`** with local correction. The versions of these functions with the **`_s`** suffix are more secure. | +| [`_mkgmtime`, `_mkgmtime32`, `_mkgmtime64`](./reference/mkgmtime-mkgmtime32-mkgmtime64.md) | Convert time to calendar value in Greenwich Mean Time. | +| [`mktime`, `_mktime32`, `_mktime64`](./reference/mktime-mktime32-mktime64.md) | Convert time to calendar value. | +| [`_strdate`, `_wstrdate`](./reference/strdate-wstrdate.md), [`_strdate_s`, `_wstrdate_s`](./reference/strdate-s-wstrdate-s.md) | Return current system date as string. The versions of these functions with the **`_s`** suffix are more secure. | +| [`strftime`, `wcsftime`, `_strftime_l`, `_wcsftime_l`](./reference/strftime-wcsftime-strftime-l-wcsftime-l.md) | Format date-and-time string for international use. | +| [`_strtime`, `_wstrtime`](./reference/strtime-wstrtime.md), [`_strtime_s`, `_wstrtime_s`](./reference/strtime-s-wstrtime-s.md) | Return current system time as string. The versions of these functions with the **`_s`** suffix are more secure. | +| [`time`, `_time32`, `_time64`](./reference/time-time32-time64.md) | Get current system time as type **`time_t`**, **`__time32_t`** or as type **`__time64_t`**. | +| [`_tzset`](./reference/tzset.md) | Set external time variables from environment time variable **`TZ`**. | +| [`_utime`, `_utime32`, `_utime64`, `_wutime`, `_wutime32`, `_wutime64`](./reference/utime-utime32-utime64-wutime-wutime32-wutime64.md) | Set modification time for specified file using either current time or time value stored in structure. | > [!NOTE] > In all versions of Microsoft C/C++ except Microsoft C/C++ version 7.0, and in all versions of Visual C++, the time function returns the current time as the number of seconds elapsed since midnight on January 1, 1970. In Microsoft C/C++ version 7.0, **`time`** returned the current time as the number of seconds elapsed since midnight on December 31, 1899. diff --git a/docs/c-runtime-library/tmp-max-l-tmpnam.md b/docs/c-runtime-library/tmp-max-l-tmpnam.md index 5ef33de1682..53fda9f1b3c 100644 --- a/docs/c-runtime-library/tmp-max-l-tmpnam.md +++ b/docs/c-runtime-library/tmp-max-l-tmpnam.md @@ -10,7 +10,7 @@ ms.assetid: ab19fd0c-b5b7-49f7-b23d-da9dfbcf0c1f ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/to-functions.md b/docs/c-runtime-library/to-functions.md index 585f230a6e7..6aaf88b7696 100644 --- a/docs/c-runtime-library/to-functions.md +++ b/docs/c-runtime-library/to-functions.md @@ -21,15 +21,15 @@ Each of the **`to`** functions and its associated macro, if any, converts a sing The **`to`** functions and macro conversions are as follows. -|Routine|Macro|Description| -|-------------|-----------|-----------------| -|`__toascii`|`__toascii`|Converts `c` to ASCII character| -|`tolower`|`tolower`|Converts `c` to lowercase if appropriate| -|`_tolower`|`_tolower`|Converts `c` to lowercase| -|`towlower`|None|Converts `c` to corresponding wide-character lowercase letter| -|`toupper`|`toupper`|Converts `c` to uppercase if appropriate| -|`_toupper`|`_toupper`|Converts `c` to uppercase| -|`towupper`|None|Converts c to corresponding wide-character uppercase letter| +| Routine | Macro | Description | +|---|---|---| +| `__toascii` | `__toascii` | Converts `c` to ASCII character | +| `tolower` | `tolower` | Converts `c` to lowercase if appropriate | +| `_tolower` | `_tolower` | Converts `c` to lowercase | +| `towlower` | None | Converts `c` to corresponding wide-character lowercase letter | +| `toupper` | `toupper` | Converts `c` to uppercase if appropriate | +| `_toupper` | `_toupper` | Converts `c` to uppercase | +| `towupper` | None | Converts c to corresponding wide-character uppercase letter | To use the function versions of the **`to`** routines that are also defined as macros, either remove the macro definitions with `#undef` directives or don't include CTYPE.H. If you use the /Za compiler option, the compiler uses the function version of `toupper` or `tolower`. Declarations of the `toupper` and `tolower` functions are in STDLIB.H. diff --git a/docs/c-runtime-library/translation-mode-constants.md b/docs/c-runtime-library/translation-mode-constants.md index 8c1b0fb80c8..a9059f68ccf 100644 --- a/docs/c-runtime-library/translation-mode-constants.md +++ b/docs/c-runtime-library/translation-mode-constants.md @@ -10,7 +10,7 @@ ms.assetid: a5993bf4-7e7a-47f9-83c3-e46332b85579 ## Syntax -``` +```C #include ``` @@ -20,11 +20,11 @@ The `_O_BINARY` and `_O_TEXT` manifest constants determine the translation mode The allowed values are: -|Value|Description| -|-|-| -`_O_TEXT` | Opens file in text (translated) mode. Carriage return-line feed (CR-LF) combinations are translated into a single line feed (LF) on input. Line feed characters are translated into CR-LF combinations on output. Also, CTRL+Z is interpreted as an end-of-file character on input. In files opened for reading, and for reading and writing, `fopen` checks for CTRL+Z at the end of the file and removes it, if possible. It's removed because using the `fseek` and `ftell` functions to move within a file ending with CTRL+Z may cause `fseek` to behave improperly near the end of the file. -`_O_BINARY` | Opens file in binary (untranslated) mode. The above translations are suppressed. -`_O_RAW` | Same as `_O_BINARY`. Supported for C 2.0 compatibility. +| Value | Description | +|---|---| +| `_O_TEXT` | Opens file in text (translated) mode. Carriage return-line feed (CR-LF) combinations are translated into a single line feed (LF) on input. Line feed characters are translated into CR-LF combinations on output. Also, CTRL+Z is interpreted as an end-of-file character on input. In files opened for reading, and for reading and writing, `fopen` checks for CTRL+Z at the end of the file and removes it, if possible. It's removed because using the `fseek` and `ftell` functions to move within a file ending with CTRL+Z may cause `fseek` to behave improperly near the end of the file. | +| `_O_BINARY` | Opens file in binary (untranslated) mode. The above translations are suppressed. | +| `_O_RAW` | Same as `_O_BINARY`. Supported for C 2.0 compatibility. | For more information, see [Text and binary mode file I/O](./text-and-binary-mode-file-i-o.md) and [File translation constants](./file-translation-constants.md). diff --git a/docs/c-runtime-library/truncate.md b/docs/c-runtime-library/truncate.md index 7f1e0d211d8..72c947882ce 100644 --- a/docs/c-runtime-library/truncate.md +++ b/docs/c-runtime-library/truncate.md @@ -11,7 +11,7 @@ Specifies string truncation behavior. ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/type-checking-crt.md b/docs/c-runtime-library/type-checking-crt.md index 79014037914..4652c3c0c2c 100644 --- a/docs/c-runtime-library/type-checking-crt.md +++ b/docs/c-runtime-library/type-checking-crt.md @@ -10,15 +10,15 @@ ms.assetid: 1ba7590b-d1c0-4636-b6a0-e231395abdad The compiler performs limited type checking on functions that can take a variable number of arguments, as follows: -|Function call|Type-checked arguments| -|-------------------|-----------------------------| -|`_cprintf_s`, `_cscanf_s`, `printf_s`, `scanf_s`|First argument (format string)| -|`fprintf_s`, `fscanf_s`, `sprintf_s`, `sscanf_s`|First two arguments (file or buffer and format string)| -|`_snprintf_s`|First three arguments (file or buffer, count, and format string)| -|`_open`|First two arguments (path and `_open` flag)| -|`_sopen_s`|First three arguments (path, `_open` flag, and sharing mode)| -|`_execl`, `_execle`, `_execlp`, `_execlpe`|First two arguments (path and first argument pointer)| -|`_spawnl`, `_spawnle`, `_spawnlp`, `_spawnlpe`|First three arguments (mode flag, path, and first argument pointer)| +| Function call | Type-checked arguments | +|---|---| +| `_cprintf_s`, `_cscanf_s`, `printf_s`, `scanf_s` | First argument (format string) | +| `fprintf_s`, `fscanf_s`, `sprintf_s`, `sscanf_s` | First two arguments (file or buffer and format string) | +| `_snprintf_s` | First three arguments (file or buffer, count, and format string) | +| `_open` | First two arguments (path and `_open` flag) | +| `_sopen_s` | First three arguments (path, `_open` flag, and sharing mode) | +| `_execl`, `_execle`, `_execlp`, `_execlpe` | First two arguments (path and first argument pointer) | +| `_spawnl`, `_spawnle`, `_spawnlp`, `_spawnlpe` | First three arguments (mode flag, path, and first argument pointer) | The compiler performs the same limited type checking on the wide-character counterparts of these functions. diff --git a/docs/c-runtime-library/tzname-max.md b/docs/c-runtime-library/tzname-max.md index f0baf0a8978..f756ca17a64 100644 --- a/docs/c-runtime-library/tzname-max.md +++ b/docs/c-runtime-library/tzname-max.md @@ -12,7 +12,7 @@ ms.assetid: e2286cb8-751d-4557-9650-5c4b98a8f7be ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/using-generic-text-mappings.md b/docs/c-runtime-library/using-generic-text-mappings.md index 7a23dd30f25..357e8f4a54d 100644 --- a/docs/c-runtime-library/using-generic-text-mappings.md +++ b/docs/c-runtime-library/using-generic-text-mappings.md @@ -15,11 +15,11 @@ To simplify code development for various international markets, the Microsoft ru ### Preprocessor directives for generic-text mappings -|#define|Compiled version|Example| -|--------------|----------------------|-------------| -|`_UNICODE`|Unicode (wide-character)|`_tcsrev` maps to `_wcsrev`| -|`_MBCS`|Multibyte-character|`_tcsrev` maps to `_mbsrev`| -|None (the default: both `_UNICODE` and `_MBCS` not defined)|SBCS (ASCII)|`_tcsrev` maps to `strrev`| +| `#define` | Compiled version | Example | +|---|---|---| +| `_UNICODE` | Unicode (wide-character) | `_tcsrev` maps to `_wcsrev` | +| `_MBCS` | Multibyte-character | `_tcsrev` maps to `_mbsrev` | +| None (the default: both `_UNICODE` and `_MBCS` not defined) | SBCS (ASCII) | `_tcsrev` maps to `strrev` | For example, the generic-text function `_tcsrev`, defined in TCHAR.H, maps to `mbsrev` if `MBCS` has been defined in your program, or to `_wcsrev` if `_UNICODE` has been defined. Otherwise `_tcsrev` maps to `strrev`. @@ -27,41 +27,41 @@ The generic-text data type `_TCHAR`, also defined in TCHAR.H, maps to type **`ch ### Generic-Text Data Type Mappings -|Generic-text data type name|SBCS (_UNICODE, _MBCS not defined)|_MBCS defined|_UNICODE defined| -|----------------------------------|--------------------------------------------|--------------------|-----------------------| -|`_TCHAR`|**`char`**|**`char`**|**`wchar_t`**| -|`_TINT`|**`int`**|**`int`**|`wint_t`| -|`_TSCHAR`|**`signed char`**|**`signed char`**|**`wchar_t`**| -|`_TUCHAR`|**`unsigned char`**|**`unsigned char`**|**`wchar_t`**| -|`_TXCHAR`|**`char`**|**`unsigned char`**|**`wchar_t`**| -|`_T` or `_TEXT`|No effect (removed by preprocessor)|No effect (removed by preprocessor)|`L` (converts following character or string to its Unicode counterpart)| +| Generic-text data type name | SBCS (_UNICODE, _MBCS not defined) | _MBCS defined | _UNICODE defined | +|---|---|---|---| +| `_TCHAR` | **`char`** | **`char`** | **`wchar_t`** | +| `_TINT` | **`int`** | **`int`** | `wint_t` | +| `_TSCHAR` | **`signed char`** | **`signed char`** | **`wchar_t`** | +| `_TUCHAR` | **`unsigned char`** | **`unsigned char`** | **`wchar_t`** | +| `_TXCHAR` | **`char`** | **`unsigned char`** | **`wchar_t`** | +| `_T` or `_TEXT` | No effect (removed by preprocessor) | No effect (removed by preprocessor) | `L` (converts following character or string to its Unicode counterpart) | For a complete list of generic-text mappings of routines, variables, and other objects, see [Generic-text mappings](./generic-text-mappings.md). The following code fragments illustrate the use of `_TCHAR` and `_tcsrev` for mapping to the MBCS, Unicode, and SBCS models. -``` +```C _TCHAR *RetVal, *szString; RetVal = _tcsrev(szString); ``` If `MBCS` has been defined, the preprocessor maps the preceding fragment to the following code: -``` +```C char *RetVal, *szString; RetVal = _mbsrev(szString); ``` If `_UNICODE` has been defined, the preprocessor maps the same fragment to the following code: -``` +```C wchar_t *RetVal, *szString; RetVal = _wcsrev(szString); ``` If both `_MBCS` and `_UNICODE` haven't been defined, the preprocessor maps the fragment to single-byte ASCII code, as follows: -``` +```C char *RetVal, *szString; RetVal = strrev(szString); ``` diff --git a/docs/c-runtime-library/vprintf-functions.md b/docs/c-runtime-library/vprintf-functions.md index 5fec57e7c73..dc0fa7b150e 100644 --- a/docs/c-runtime-library/vprintf-functions.md +++ b/docs/c-runtime-library/vprintf-functions.md @@ -32,32 +32,32 @@ The `vprintf` functions are similar to their counterpart functions as listed in These functions format data for output to destinations as follows. -|Function|Counterpart function|Output destination|Parameter Validation|Positional Parameter Support| -|--------------|--------------------------|------------------------|--------------------------|----------------------------------| -|`_vcprintf`|[`_cprintf`](./reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md)|console|Check for null.|no| -|`_vcwprintf`|[`_cwprintf`](./reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md)|console|Check for null.|no| -|`vfprintf`|[`fprintf`](./reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md)|*`stream`*|Check for null.|no| -|`vfprintf_p`|[`fprintf_p`](./reference/fprintf-p-fprintf-p-l-fwprintf-p-fwprintf-p-l.md)|*`stream`*|Check for null and valid format.|yes| -|`vfprintf_s`|[`fprintf_s`](./reference/fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md)|*`stream`*|Check for null and valid format.|no| -|`vfwprintf`|[`fwprintf`](./reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md)|*`stream`*|Check for null.|no| -|`vfwprintf_p`|[`fwprintf_p`](./reference/fprintf-p-fprintf-p-l-fwprintf-p-fwprintf-p-l.md)|*`stream`*|Check for null and valid format.|yes| -|`vfwprintf_s`|[`fwprintf_s`](./reference/fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md)|*`stream`*|Check for null and valid format.|no| -|`vprintf`|[`printf`](./reference/printf-printf-l-wprintf-wprintf-l.md)|`stdout`|Check for null.|no| -|`vprintf_p`|[`printf_p`](./reference/printf-p-printf-p-l-wprintf-p-wprintf-p-l.md)|`stdout`|Check for null and valid format.|yes| -|`vprintf_s`|[`printf_s`](./reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md)|`stdout`|Check for null and valid format.|no| -|`vwprintf`|[`wprintf`](./reference/printf-printf-l-wprintf-wprintf-l.md)|`stdout`|Check for null.|no| -|`vwprintf_p`|[`wprintf_p`](./reference/printf-p-printf-p-l-wprintf-p-wprintf-p-l.md)|`stdout`|Check for null and valid format.|yes| -|`vwprintf_s`|[`wprintf_s`](./reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md)|`stdout`|Check for null and valid format.|no| -|`vsprintf`|[`sprintf`](./reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md)|memory pointed to by *`buffer`*|Check for null.|no| -|`vsprintf_p`|[`sprintf_p`](./reference/sprintf-p-sprintf-p-l-swprintf-p-swprintf-p-l.md)|memory pointed to by *`buffer`*|Check for null and valid format.|yes| -|`vsprintf_s`|[`sprintf_s`](./reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md)|memory pointed to by *`buffer`*|Check for null and valid format.|no| -|`vswprintf`|[`swprintf`](./reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md)|memory pointed to by *`buffer`*|Check for null.|no| -|`vswprintf_p`|[`swprintf_p`](./reference/sprintf-p-sprintf-p-l-swprintf-p-swprintf-p-l.md)|memory pointed to by *`buffer`*|Check for null and valid format.|yes| -|`vswprintf_s`|[`swprintf_s`](./reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md)|memory pointed to by *`buffer`*|Check for null and valid format.|no| -|`_vscprintf`|[`_vscprintf`](./reference/vscprintf-vscprintf-l-vscwprintf-vscwprintf-l.md)|memory pointed to by *`buffer`*|Check for null.|no| -|`_vscwprintf`|[`_vscwprintf`](./reference/vscprintf-vscprintf-l-vscwprintf-vscwprintf-l.md)|memory pointed to by *`buffer`*|Check for null.|no| -|`_vsnprintf`|[`_snprintf`](./reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md)|memory pointed to by *`buffer`*|Check for null.|no| -|`_vsnwprintf`|[`_snwprintf`](./reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md)|memory pointed to by *`buffer`*|Check for null.|no| +| Function | Counterpart function | Output destination | Parameter Validation | Positional Parameter Support | +|---|---|---|---|---| +| `_vcprintf` | [`_cprintf`](./reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md) | console | Check for null. | no | +| `_vcwprintf` | [`_cwprintf`](./reference/cprintf-cprintf-l-cwprintf-cwprintf-l.md) | console | Check for null. | no | +| `vfprintf` | [`fprintf`](./reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md) | *`stream`* | Check for null. | no | +| `vfprintf_p` | [`fprintf_p`](./reference/fprintf-p-fprintf-p-l-fwprintf-p-fwprintf-p-l.md) | *`stream`* | Check for null and valid format. | yes | +| `vfprintf_s` | [`fprintf_s`](./reference/fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md) | *`stream`* | Check for null and valid format. | no | +| `vfwprintf` | [`fwprintf`](./reference/fprintf-fprintf-l-fwprintf-fwprintf-l.md) | *`stream`* | Check for null. | no | +| `vfwprintf_p` | [`fwprintf_p`](./reference/fprintf-p-fprintf-p-l-fwprintf-p-fwprintf-p-l.md) | *`stream`* | Check for null and valid format. | yes | +| `vfwprintf_s` | [`fwprintf_s`](./reference/fprintf-s-fprintf-s-l-fwprintf-s-fwprintf-s-l.md) | *`stream`* | Check for null and valid format. | no | +| `vprintf` | [`printf`](./reference/printf-printf-l-wprintf-wprintf-l.md) | `stdout` | Check for null. | no | +| `vprintf_p` | [`printf_p`](./reference/printf-p-printf-p-l-wprintf-p-wprintf-p-l.md) | `stdout` | Check for null and valid format. | yes | +| `vprintf_s` | [`printf_s`](./reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md) | `stdout` | Check for null and valid format. | no | +| `vwprintf` | [`wprintf`](./reference/printf-printf-l-wprintf-wprintf-l.md) | `stdout` | Check for null. | no | +| `vwprintf_p` | [`wprintf_p`](./reference/printf-p-printf-p-l-wprintf-p-wprintf-p-l.md) | `stdout` | Check for null and valid format. | yes | +| `vwprintf_s` | [`wprintf_s`](./reference/printf-s-printf-s-l-wprintf-s-wprintf-s-l.md) | `stdout` | Check for null and valid format. | no | +| `vsprintf` | [`sprintf`](./reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md) | memory pointed to by *`buffer`* | Check for null. | no | +| `vsprintf_p` | [`sprintf_p`](./reference/sprintf-p-sprintf-p-l-swprintf-p-swprintf-p-l.md) | memory pointed to by *`buffer`* | Check for null and valid format. | yes | +| `vsprintf_s` | [`sprintf_s`](./reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md) | memory pointed to by *`buffer`* | Check for null and valid format. | no | +| `vswprintf` | [`swprintf`](./reference/sprintf-sprintf-l-swprintf-swprintf-l-swprintf-l.md) | memory pointed to by *`buffer`* | Check for null. | no | +| `vswprintf_p` | [`swprintf_p`](./reference/sprintf-p-sprintf-p-l-swprintf-p-swprintf-p-l.md) | memory pointed to by *`buffer`* | Check for null and valid format. | yes | +| `vswprintf_s` | [`swprintf_s`](./reference/sprintf-s-sprintf-s-l-swprintf-s-swprintf-s-l.md) | memory pointed to by *`buffer`* | Check for null and valid format. | no | +| `_vscprintf` | [`_vscprintf`](./reference/vscprintf-vscprintf-l-vscwprintf-vscwprintf-l.md) | memory pointed to by *`buffer`* | Check for null. | no | +| `_vscwprintf` | [`_vscwprintf`](./reference/vscprintf-vscprintf-l-vscwprintf-vscwprintf-l.md) | memory pointed to by *`buffer`* | Check for null. | no | +| `_vsnprintf` | [`_snprintf`](./reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md) | memory pointed to by *`buffer`* | Check for null. | no | +| `_vsnwprintf` | [`_snwprintf`](./reference/snprintf-snprintf-snprintf-l-snwprintf-snwprintf-l.md) | memory pointed to by *`buffer`* | Check for null. | no | The `argptr` argument has type `va_list`, which is defined in VARARGS.H and STDARG.H. The `argptr` variable must be initialized by **va_start,** and may be reinitialized by subsequent `va_arg` calls; `argptr` then points to the beginning of a list of arguments that are converted and transmitted for output according to the corresponding specifications in the *`format`* argument. *`format`* has the same form and function as the *`format`* argument for [`printf`](./reference/printf-printf-l-wprintf-wprintf-l.md). None of these functions invoke `va_end`. For a more complete description of each `vprintf` function, see the description of its counterpart function as listed in the preceding table. diff --git a/docs/c-runtime-library/wait-child-wait-grandchild.md b/docs/c-runtime-library/wait-child-wait-grandchild.md index 91cdb94a1e5..4ed46ab60f1 100644 --- a/docs/c-runtime-library/wait-child-wait-grandchild.md +++ b/docs/c-runtime-library/wait-child-wait-grandchild.md @@ -10,7 +10,7 @@ ms.assetid: 7acd96fa-d118-4339-bb00-e5afaf286945 ## Syntax -``` +```C #include ``` @@ -18,10 +18,10 @@ ms.assetid: 7acd96fa-d118-4339-bb00-e5afaf286945 The `_cwait` function can be used by any process to wait for any other process (if the process ID is known). The action argument can be one of the following values: -|Constant|Meaning| -|--------------|-------------| -|`_WAIT_CHILD`|Calling process waits until specified new process terminates.| -|`_WAIT_GRANDCHILD`|Calling process waits until specified new process, and all processes created by that new process, terminate.| +| Constant | Meaning | +|---|---| +| `_WAIT_CHILD` | Calling process waits until specified new process terminates. | +| `_WAIT_GRANDCHILD` | Calling process waits until specified new process, and all processes created by that new process, terminate. | ## See also diff --git a/docs/c-runtime-library/wchar-max.md b/docs/c-runtime-library/wchar-max.md index c91b4ddc351..b38df5c1f56 100644 --- a/docs/c-runtime-library/wchar-max.md +++ b/docs/c-runtime-library/wchar-max.md @@ -12,7 +12,7 @@ Maximum value for type **`wchar_t`**. ## Syntax -``` +```C #include ``` diff --git a/docs/c-runtime-library/wchar-min.md b/docs/c-runtime-library/wchar-min.md index 9bc37e67cbb..b003e745031 100644 --- a/docs/c-runtime-library/wchar-min.md +++ b/docs/c-runtime-library/wchar-min.md @@ -12,7 +12,7 @@ Minimum value for type **`wchar_t`**. ## Syntax -``` +```C #include ``` diff --git a/docs/standard-library/ranges.md b/docs/standard-library/ranges.md index 4441359536f..eac9034cbd6 100644 --- a/docs/standard-library/ranges.md +++ b/docs/standard-library/ranges.md @@ -1,7 +1,7 @@ --- title: "" description: "Overview of the Standard Template Library (STL) ranges library" -ms.date: 09/26/2022 +ms.date: 10/25/2022 f1_keywords: [""] helpviewer_keywords: ["ranges"] --- @@ -41,14 +41,14 @@ Besides being easier to read, it avoids the memory allocation required for the ` In the code above, each element that is divisible by three is combined with an operation to square that element. The '`|`' symbol chains the operations together, and is read left to right. -The result, `output`, is itself a type of range called a *view*. +The result, `output`, is itself a kind of range called a *view*. > [!NOTE] > The ranges examples require the [`/std:c++latest`](../build/reference/std-specify-language-standard-version.md) compiler option. Because post-release updates to `` in the C++20 Standard are a work in progress, the features that require `std::views` aren't enabled yet under **`/std:c++20`**. ## Views -A *view* is a lightweight range. View operations such as default construction, move construction/assignment, copy construction/assignment (if present), destruction, begin and end, all happen in constant time regardless of the number of elements in the view. Changing an element in a view doesn't change the corresponding element in the range used to create the view. +A *view* is a lightweight range. View operations such as default construction, move construction/assignment, copy construction/assignment (if present), destruction, begin and end, all happen in constant time regardless of the number of elements in the view. Views are created by range adaptors, which are discussed in the following section. For more information about the classes that implement various views, see [View classes](view-classes.md).