Skip to content

Commit 707dde8

Browse files
author
Colin Robertson
committed
Format manifest constants
1 parent 5bc45a8 commit 707dde8

305 files changed

Lines changed: 579 additions & 578 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,27 +33,27 @@ void abort( void );
3333
3434
## Return Value
3535
36-
`abort` does not return control to the calling process. By default, it checks for an abort signal handler and raises `SIGABRT` if one is set. Then `abort` terminates the current process and returns an exit code to the parent process.
36+
**abort** does not return control to the calling process. By default, it checks for an abort signal handler and raises **SIGABRT** if one is set. Then **abort** terminates the current process and returns an exit code to the parent process.
3737
3838
## Remarks
3939
4040
**Microsoft Specific**
4141
42-
By default, when an app is built with the debug runtime library, the `abort` routine displays an error message before `SIGABRT` is raised. For console apps running in console mode, the message is sent to `STDERR`. Windows desktop apps and console apps running in windowed mode display the message in a message box. To suppress the message, use [_set_abort_behavior](set-abort-behavior.md) to clear the `_WRITE_ABORT_MSG` flag. The message displayed depends on the version of the runtime environment used. For applications built by using the most recent versions of Visual C++, the message resembles this:
42+
By default, when an app is built with the debug runtime library, the **abort** routine displays an error message before **SIGABRT** is raised. For console apps running in console mode, the message is sent to **STDERR**. Windows desktop apps and console apps running in windowed mode display the message in a message box. To suppress the message, use [_set_abort_behavior](set-abort-behavior.md) to clear the **_WRITE_ABORT_MSG** flag. The message displayed depends on the version of the runtime environment used. For applications built by using the most recent versions of Visual C++, the message resembles this:
4343
4444
> R6010 - abort() has been called
4545
4646
In previous versions of the C runtime library, this message was displayed:
4747
4848
> This application has requested the Runtime to terminate it in an unusual way. Please contact the application's support team for more information.
4949
50-
When the program is compiled in debug mode, the message box displays options to **Abort**, **Retry**, or **Ignore**. If the user chooses **Abort**, the program terminates immediately and returns an exit code of 3. If the user chooses **Retry**, a debugger is invoked for just-in-time debugging, if available. If the user chooses **Ignore**, `abort` continues normal processing.
50+
When the program is compiled in debug mode, the message box displays options to **Abort**, **Retry**, or **Ignore**. If the user chooses **Abort**, the program terminates immediately and returns an exit code of 3. If the user chooses **Retry**, a debugger is invoked for just-in-time debugging, if available. If the user chooses **Ignore**, **abort** continues normal processing.
5151
52-
In both retail and debug builds, `abort` then checks whether an abort signal handler is set. If a non-default signal handler is set, `abort` calls `raise(SIGABRT)`. Use the [signal](signal.md) function to associate an abort signal handler function with the `SIGABRT` signal. You can perform custom actions—for example, clean up resources or log information—and terminate the app with your own error code in the handler function. If no custom signal handler is defined, `abort` does not raise the `SIGABRT` signal.
52+
In both retail and debug builds, **abort** then checks whether an abort signal handler is set. If a non-default signal handler is set, **abort** calls `raise(SIGABRT)`. Use the [signal](signal.md) function to associate an abort signal handler function with the **SIGABRT** signal. You can perform custom actions—for example, clean up resources or log information—and terminate the app with your own error code in the handler function. If no custom signal handler is defined, **abort** does not raise the **SIGABRT** signal.
5353
54-
By default, in non-debug builds of desktop or console apps, `abort` then invokes the Windows Error Reporting Service mechanism (formerly known as Dr. Watson) to report failures to Microsoft. This behavior can be enabled or disabled by calling `_set_abort_behavior` and setting or masking the `_CALL_REPORTFAULT` flag. When the flag is set, Windows displays a message box that has text something like "A problem caused the program to stop working correctly." The user can choose to invoke a debugger with a **Debug** button, or choose the **Close program** button to terminate the app with an error code that's defined by the operating system.
54+
By default, in non-debug builds of desktop or console apps, **abort** then invokes the Windows Error Reporting Service mechanism (formerly known as Dr. Watson) to report failures to Microsoft. This behavior can be enabled or disabled by calling `_set_abort_behavior` and setting or masking the **_CALL_REPORTFAULT** flag. When the flag is set, Windows displays a message box that has text something like "A problem caused the program to stop working correctly." The user can choose to invoke a debugger with a **Debug** button, or choose the **Close program** button to terminate the app with an error code that's defined by the operating system.
5555
56-
If the Windows error reporting handler is not invoked, then `abort` calls [_exit](exit-exit-exit.md) to terminate the process with exit code 3 and returns control to the parent process or the operating system. `_exit` does not flush stream buffers or do `atexit`/`_onexit` processing.
56+
If the Windows error reporting handler is not invoked, then **abort** calls [_exit](exit-exit-exit.md) to terminate the process with exit code 3 and returns control to the parent process or the operating system. `_exit` does not flush stream buffers or do `atexit`/`_onexit` processing.
5757
5858
For more information about CRT debugging, see [CRT Debugging Techniques](/visualstudio/debugger/crt-debugging-techniques).
5959
@@ -63,7 +63,7 @@ For more information about CRT debugging, see [CRT Debugging Techniques](/visual
6363
6464
|Routine|Required header|
6565
|-------------|---------------------|
66-
|`abort`|\<process.h> or \<stdlib.h>|
66+
|**abort**|\<process.h> or \<stdlib.h>|
6767
6868
## Example
6969

docs/c-runtime-library/reference/access-crt.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,5 @@ manager: "ghogen"
2121
ms.workload: ["cplusplus"]
2222
---
2323
# access (CRT)
24+
2425
This POSIX function is deprecated. Use the ISO C++ conformant [_access](access-waccess.md) or security-enhanced [_access_s](access-s-waccess-s.md) instead.

docs/c-runtime-library/reference/access-s-waccess-s.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,19 @@ Permission setting.
4747

4848
## Return Value
4949

50-
Each function returns 0 if the file has the given mode. The function returns an error code if the named file does not exist or is not 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.
50+
Each function returns 0 if the file has the given mode. The function returns an error code if the named file does not exist or is not 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.
5151

5252
|errno value|Condition|
5353
|-|-|
54-
`EACCES`|Access denied. The file's permission setting does not allow specified access.
55-
`ENOENT`|File name or path not found.
56-
`EINVAL`|Invalid parameter.
54+
**EACCES**|Access denied. The file's permission setting does not allow specified access.
55+
**ENOENT**|File name or path not found.
56+
**EINVAL**|Invalid parameter.
5757

5858
For more information, see [errno, _doserrno, _sys_errlist, and _sys_nerr](../../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md).
5959

6060
## Remarks
6161

62-
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 [!INCLUDE[Win2kFamily](../../c-runtime-library/includes/win2kfamily_md.md)] and later operating systems, all directories have read and write access.
62+
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 [!INCLUDE[Win2kFamily](../../c-runtime-library/includes/win2kfamily_md.md)] and later operating systems, all directories have read and write access.
6363

6464
|mode value|Checks file for|
6565
|----------------|---------------------|
@@ -68,28 +68,28 @@ When used with files, the `_access_s` function determines whether the specified
6868
|04|Read permission.|
6969
|06|Read and write permission.|
7070

71-
Permission to read or write the file is not 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.
71+
Permission to read or write the file is not 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.
7272

73-
`_waccess_s` is a wide-character version of `_access_s`, where the *path* argument to `_waccess_s` is a wide-character string. Otherwise, `_waccess_s` and `_access_s` behave identically.
73+
**_waccess_s** is a wide-character version of **_access_s**, where the *path* argument to **_waccess_s** is a wide-character string. Otherwise, **_waccess_s** and **_access_s** behave identically.
7474

75-
These functions validate their parameters. If *path* is `NULL` or *mode* does not specify a valid mode, the invalid parameter handler is invoked, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, these functions set `errno` to `EINVAL` and return `EINVAL`.
75+
These functions validate their parameters. If *path* is **NULL** or *mode* does not specify a valid mode, the invalid parameter handler is invoked, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, these functions set **errno** to **EINVAL** and return **EINVAL**.
7676

7777
### Generic-Text Routine Mappings
7878

7979
|Tchar.h routine|_UNICODE and _MBCS not defined|_MBCS defined|_UNICODE defined|
8080
|---------------------|--------------------------------------|--------------------|-----------------------|
81-
|`_taccess_s`|`_access_s`|`_access_s`|`_waccess_s`|
81+
|**_taccess_s**|**_access_s**|**_access_s**|**_waccess_s**|
8282

8383
## Requirements
8484

8585
|Routine|Required header|Optional header|
8686
|-------------|---------------------|---------------------|
87-
|`_access_s`|\<io.h>|\<errno.h>|
88-
|`_waccess_s`|\<wchar.h> or \<io.h>|\<errno.h>|
87+
|**_access_s**|\<io.h>|\<errno.h>|
88+
|**_waccess_s**|\<wchar.h> or \<io.h>|\<errno.h>|
8989

9090
## Example
9191

92-
This example uses `_access_s` to check the file named crt_access_s.c to see whether it exists and whether writing is allowed.
92+
This example uses **_access_s** to check the file named crt_access_s.c to see whether it exists and whether writing is allowed.
9393

9494
```C
9595
// crt_access_s.c

docs/c-runtime-library/reference/access-waccess.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,19 @@ Read/write attribute.
4747

4848
## Return Value
4949

50-
Each function returns 0 if the file has the given mode. The function returns -1 if the named file does not exist or does not have the given mode; in this case, `errno` is set as shown in the following table.
50+
Each function returns 0 if the file has the given mode. The function returns -1 if the named file does not exist or does not have the given mode; in this case, **errno** is set as shown in the following table.
5151

5252
|||
5353
|-|-|
54-
`EACCES`|Access denied: the file's permission setting does not allow specified access.
55-
`ENOENT`|File name or path not found.
56-
`EINVAL`|Invalid parameter.
54+
**EACCES**|Access denied: the file's permission setting does not allow specified access.
55+
**ENOENT**|File name or path not found.
56+
**EINVAL**|Invalid parameter.
5757

5858
For more information about these and other return codes, see [_doserrno, errno, _sys_errlist, and _sys_nerr](../../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md).
5959

6060
## Remarks
6161

62-
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 [!INCLUDE[Win2kFamily](../../c-runtime-library/includes/win2kfamily_md.md)] and later operating systems, all directories have read and write access.
62+
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 [!INCLUDE[Win2kFamily](../../c-runtime-library/includes/win2kfamily_md.md)] and later operating systems, all directories have read and write access.
6363

6464
|*mode* value|Checks file for|
6565
|------------------|---------------------|
@@ -70,26 +70,26 @@ When used with files, the `_access` function determines whether the specified fi
7070

7171
This function only checks whether the file and directory are read-only or not, it does not check the filesystem security settings. For that you need an access token. For more information on filesystem security, see [Access Tokens](http://msdn.microsoft.com/library/windows/desktop/aa374909). An ATL class exists to provide this functionality; see [CAccessToken Class](../../atl/reference/caccesstoken-class.md).
7272

73-
`_waccess` is a wide-character version of `_access`; the *path* argument to `_waccess` is a wide-character string. `_waccess` and `_access` behave identically otherwise.
73+
**_waccess** is a wide-character version of **_access**; the *path* argument to **_waccess** is a wide-character string. **_waccess** and **_access** behave identically otherwise.
7474

75-
This function validates its parameters. If *path* is `NULL` or *mode* does not specify a valid mode, the invalid parameter handler is invoked, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, the function sets `errno` to `EINVAL` and returns -1.
75+
This function validates its parameters. If *path* is **NULL** or *mode* does not specify a valid mode, the invalid parameter handler is invoked, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, the function sets **errno** to **EINVAL** and returns -1.
7676

7777
### Generic-Text Routine Mappings
7878

7979
|Tchar.h routine|_UNICODE and _MBCS not defined|_MBCS defined|_UNICODE defined|
8080
|---------------------|--------------------------------------|--------------------|-----------------------|
81-
|`_taccess`|`_access`|`_access`|`_waccess`|
81+
|**_taccess**|**_access**|**_access**|**_waccess**|
8282

8383
## Requirements
8484

8585
|Routine|Required header|Optional headers|
8686
|-------------|---------------------|----------------------|
87-
|`_access`|\<io.h>|\<errno.h>|
88-
|`_waccess`|\<wchar.h> or \<io.h>|\<errno.h>|
87+
|**_access**|\<io.h>|\<errno.h>|
88+
|**_waccess**|\<wchar.h> or \<io.h>|\<errno.h>|
8989

9090
## Example
9191

92-
The following example uses `_access` to check the file named crt_ACCESS.C to see whether it exists and whether writing is allowed.
92+
The following example uses **_access** to check the file named crt_ACCESS.C to see whether it exists and whether writing is allowed.
9393

9494
```C
9595
// crt_access.c

docs/c-runtime-library/reference/aligned-free-dbg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The `_aligned_free_dbg` function is a debug version of the [_aligned_free](align
4343

4444
`_aligned_free_dbg` performs a validity check on all specified files and block locations before performing the free operation. The application is not expected to provide this information. When a memory block is freed, the debug heap manager automatically checks the integrity of the buffers on either side of the user portion and issues an error report if overwriting has occurred. If the `_CRTDBG_DELAY_FREE_MEM_DF` bit field of the [_crtDbgFlag](../../c-runtime-library/crtdbgflag.md) flag is set, the freed block is filled with the value 0xDD, assigned the `_FREE_BLOCK` block type, and kept in the heap's linked list of memory blocks.
4545

46-
If an error occurs in freeing the memory, `errno` is set with information from the operating system on the nature of the failure. For more information, see [errno, _doserrno, _sys_errlist, and _sys_nerr](../../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md).
46+
If an error occurs in freeing the memory, **errno** is set with information from the operating system on the nature of the failure. For more information, see [errno, _doserrno, _sys_errlist, and _sys_nerr](../../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md).
4747

4848
For information about how memory blocks are allocated, initialized, and managed in the debug version of the base heap, see [CRT Debug Heap Details](/visualstudio/debugger/crt-debug-heap-details). For information about the allocation block types and how they are used, see [Types of blocks on the debug heap](/visualstudio/debugger/crt-debug-heap-details). For information about the differences between calling a standard heap function and its debug version in a debug build of an application, see [Debug Versions of Heap Allocation Functions](/visualstudio/debugger/debug-versions-of-heap-allocation-functions).
4949

docs/c-runtime-library/reference/aligned-free.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ A pointer to the memory block that was returned to the `_aligned_malloc` or `_al
4141

4242
`_aligned_free` is marked `__declspec(noalias)`, meaning that the function is guaranteed not to modify global variables. For more information, see [noalias](../../cpp/noalias.md).
4343

44-
This function does not validate its parameter, unlike the other _aligned CRT functions. If *memblock* is a `NULL` pointer, this function simply performs no actions. It does not change `errno` and it does not invoke the invalid parameter handler. If an error occurs in the function due to not using _aligned functions previously to allocate the block of memory or a misalignment of memory occurs due to some unforeseen calamity, the function generates a debug report from the [_RPT, _RPTF, _RPTW, _RPTFW Macros](rpt-rptf-rptw-rptfw-macros.md).
44+
This function does not validate its parameter, unlike the other _aligned CRT functions. If *memblock* is a `NULL` pointer, this function simply performs no actions. It does not change **errno** and it does not invoke the invalid parameter handler. If an error occurs in the function due to not using _aligned functions previously to allocate the block of memory or a misalignment of memory occurs due to some unforeseen calamity, the function generates a debug report from the [_RPT, _RPTF, _RPTW, _RPTFW Macros](rpt-rptf-rptw-rptfw-macros.md).
4545

4646
## Requirements
4747

0 commit comments

Comments
 (0)