Skip to content

Commit 080e33c

Browse files
author
Colin Robertson
committed
Fix every CRT Hn heading
1 parent 8b64997 commit 080e33c

676 files changed

Lines changed: 15367 additions & 12589 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/access-s-waccess-s.md

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1-
---
2-
title: "_access_s, _waccess_s | Microsoft Docs"
3-
ms.custom: ""
4-
ms.date: "11/04/2016"
5-
ms.reviewer: ""
6-
ms.suite: ""
7-
ms.technology: ["cpp-standard-libraries"]
8-
ms.tgt_pltfrm: ""
9-
ms.topic: "reference"
10-
apiname: ["_access_s", "_waccess_s"]
11-
apilocation: ["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-filesystem-l1-1-0.dll"]
12-
apitype: "DLLExport"
13-
f1_keywords: ["waccess_s", "access_s", "_waccess_s", "_access_s"]
14-
dev_langs: ["C++"]
15-
helpviewer_keywords: ["access_s function", "taccess_s function", "_taccess_s function", "waccess_s function", "_access_s function", "_waccess_s function"]
16-
ms.assetid: fb3004fc-dcd3-4569-8b27-d817546e947e
17-
caps.latest.revision: 28
18-
author: "corob-msft"
19-
ms.author: "corob"
20-
manager: "ghogen"
21-
ms.workload: ["cplusplus"]
1+
---
2+
title: "_access_s, _waccess_s | Microsoft Docs"
3+
ms.custom: ""
4+
ms.date: "11/04/2016"
5+
ms.reviewer: ""
6+
ms.suite: ""
7+
ms.technology: ["cpp-standard-libraries"]
8+
ms.tgt_pltfrm: ""
9+
ms.topic: "reference"
10+
apiname: ["_access_s", "_waccess_s"]
11+
apilocation: ["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-filesystem-l1-1-0.dll"]
12+
apitype: "DLLExport"
13+
f1_keywords: ["waccess_s", "access_s", "_waccess_s", "_access_s"]
14+
dev_langs: ["C++"]
15+
helpviewer_keywords: ["access_s function", "taccess_s function", "_taccess_s function", "waccess_s function", "_access_s function", "_waccess_s function"]
16+
ms.assetid: fb3004fc-dcd3-4569-8b27-d817546e947e
17+
caps.latest.revision: 28
18+
author: "corob-msft"
19+
ms.author: "corob"
20+
manager: "ghogen"
21+
ms.workload: ["cplusplus"]
2222
---
2323
# _access_s, _waccess_s
24+
2425
Determines file read/write permissions. This is a version of [_access, _waccess](../../c-runtime-library/reference/access-waccess.md) with security enhancements as described in [Security Features in the CRT](../../c-runtime-library/security-features-in-the-crt.md).
2526

2627
## Syntax
@@ -36,15 +37,17 @@ errno_t _waccess_s(
3637
);
3738
```
3839

39-
#### Parameters
40-
`path`
40+
### Parameters
41+
42+
`path`
4143
File or directory path.
4244

4345
`mode`
4446
Permission setting.
4547

4648
## Return Value
47-
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.
49+
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.
4851

4952
`EACCES`
5053
Access denied. The file's permission setting does not allow specified access.
@@ -58,7 +61,8 @@ errno_t _waccess_s(
5861
For more information, see [errno, _doserrno, _sys_errlist, and _sys_nerr](../../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md).
5962

6063
## Remarks
61-
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.
64+
65+
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.
6266

6367
|mode value|Checks file for|
6468
|----------------|---------------------|
@@ -87,7 +91,8 @@ errno_t _waccess_s(
8791
|`_waccess_s`|\<wchar.h> or \<io.h>|\<errno.h>|
8892

8993
## Example
90-
This example uses `_access_s` to check the file named crt_access_s.c to see whether it exists and whether writing is allowed.
94+
95+
This example uses `_access_s` to check the file named crt_access_s.c to see whether it exists and whether writing is allowed.
9196

9297
```
9398
// crt_access_s.c
@@ -130,7 +135,8 @@ File crt_access_s.c does not have write permission.
130135
```
131136

132137
## See Also
133-
[File Handling](../../c-runtime-library/file-handling.md)
138+
139+
[File Handling](../../c-runtime-library/file-handling.md)
134140
[_access, _waccess](../../c-runtime-library/reference/access-waccess.md)
135141
[_chmod, _wchmod](../../c-runtime-library/reference/chmod-wchmod.md)
136142
[_fstat, _fstat32, _fstat64, _fstati64, _fstat32i64, _fstat64i32](../../c-runtime-library/reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md)

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

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1-
---
2-
title: "_access, _waccess | Microsoft Docs"
3-
ms.custom: ""
4-
ms.date: "11/04/2016"
5-
ms.reviewer: ""
6-
ms.suite: ""
7-
ms.technology: ["cpp-standard-libraries"]
8-
ms.tgt_pltfrm: ""
9-
ms.topic: "reference"
10-
apiname: ["_access", "_waccess"]
11-
apilocation: ["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-filesystem-l1-1-0.dll"]
12-
apitype: "DLLExport"
13-
f1_keywords: ["_waccess", "_access", "taccess", "waccess", "_taccess"]
14-
dev_langs: ["C++"]
15-
helpviewer_keywords: ["access function", "_taccess function", "waccess function", "_access function", "_waccess function", "taccess function"]
16-
ms.assetid: ba34f745-85c3-49e5-a7d4-3590bd249dd3
17-
caps.latest.revision: 27
18-
author: "corob-msft"
19-
ms.author: "corob"
20-
manager: "ghogen"
21-
ms.workload: ["cplusplus"]
1+
---
2+
title: "_access, _waccess | Microsoft Docs"
3+
ms.custom: ""
4+
ms.date: "11/04/2016"
5+
ms.reviewer: ""
6+
ms.suite: ""
7+
ms.technology: ["cpp-standard-libraries"]
8+
ms.tgt_pltfrm: ""
9+
ms.topic: "reference"
10+
apiname: ["_access", "_waccess"]
11+
apilocation: ["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-filesystem-l1-1-0.dll"]
12+
apitype: "DLLExport"
13+
f1_keywords: ["_waccess", "_access", "taccess", "waccess", "_taccess"]
14+
dev_langs: ["C++"]
15+
helpviewer_keywords: ["access function", "_taccess function", "waccess function", "_access function", "_waccess function", "taccess function"]
16+
ms.assetid: ba34f745-85c3-49e5-a7d4-3590bd249dd3
17+
caps.latest.revision: 27
18+
author: "corob-msft"
19+
ms.author: "corob"
20+
manager: "ghogen"
21+
ms.workload: ["cplusplus"]
2222
---
2323
# _access, _waccess
24+
2425
Determines if a file is read-only or not. More secure versions are available; see [_access_s, _waccess_s](../../c-runtime-library/reference/access-s-waccess-s.md).
2526

2627
## Syntax
@@ -36,15 +37,17 @@ int _waccess(
3637
);
3738
```
3839

39-
#### Parameters
40-
`path`
40+
### Parameters
41+
42+
`path`
4143
File or directory path.
4244

4345
`mode`
4446
Read/write attribute.
4547

4648
## Return Value
47-
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.
49+
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.
4851

4952
`EACCES`
5053
Access denied: the file's permission setting does not allow specified access.
@@ -58,7 +61,8 @@ int _waccess(
5861
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).
5962

6063
## Remarks
61-
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.
64+
65+
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.
6266

6367
|`mode` value|Checks file for|
6468
|------------------|---------------------|
@@ -87,7 +91,8 @@ int _waccess(
8791
|`_waccess`|\<wchar.h> or \<io.h>|\<errno.h>|
8892

8993
## Example
90-
The following example uses `_access` to check the file named crt_ACCESS.C to see whether it exists and whether writing is allowed.
94+
95+
The following example uses `_access` to check the file named crt_ACCESS.C to see whether it exists and whether writing is allowed.
9196

9297
```
9398
// crt_access.c
@@ -120,7 +125,8 @@ File crt_ACCESS.C does not have write permission.
120125
```
121126

122127
## See Also
123-
[File Handling](../../c-runtime-library/file-handling.md)
128+
129+
[File Handling](../../c-runtime-library/file-handling.md)
124130
[_chmod, _wchmod](../../c-runtime-library/reference/chmod-wchmod.md)
125131
[_fstat, _fstat32, _fstat64, _fstati64, _fstat32i64, _fstat64i32](../../c-runtime-library/reference/fstat-fstat32-fstat64-fstati64-fstat32i64-fstat64i32.md)
126132
[_open, _wopen](../../c-runtime-library/reference/open-wopen.md)
Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1-
---
2-
title: "_aligned_free_dbg | Microsoft Docs"
3-
ms.custom: ""
4-
ms.date: "11/04/2016"
5-
ms.reviewer: ""
6-
ms.suite: ""
7-
ms.technology: ["cpp-standard-libraries"]
8-
ms.tgt_pltfrm: ""
9-
ms.topic: "reference"
10-
apiname: ["_aligned_free_dbg"]
11-
apilocation: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll"]
12-
apitype: "DLLExport"
13-
f1_keywords: ["_aligned_free_dbg", "aligned_free_dbg"]
14-
dev_langs: ["C++"]
15-
helpviewer_keywords: ["_aligned_free_dbg function", "aligned_free_dbg function"]
16-
ms.assetid: eb0cb3c8-0992-4db8-bac3-65f1b8311ca6
17-
caps.latest.revision: 8
18-
author: "corob-msft"
19-
ms.author: "corob"
20-
manager: "ghogen"
21-
ms.workload: ["cplusplus"]
1+
---
2+
title: "_aligned_free_dbg | Microsoft Docs"
3+
ms.custom: ""
4+
ms.date: "11/04/2016"
5+
ms.reviewer: ""
6+
ms.suite: ""
7+
ms.technology: ["cpp-standard-libraries"]
8+
ms.tgt_pltfrm: ""
9+
ms.topic: "reference"
10+
apiname: ["_aligned_free_dbg"]
11+
apilocation: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll"]
12+
apitype: "DLLExport"
13+
f1_keywords: ["_aligned_free_dbg", "aligned_free_dbg"]
14+
dev_langs: ["C++"]
15+
helpviewer_keywords: ["_aligned_free_dbg function", "aligned_free_dbg function"]
16+
ms.assetid: eb0cb3c8-0992-4db8-bac3-65f1b8311ca6
17+
caps.latest.revision: 8
18+
author: "corob-msft"
19+
ms.author: "corob"
20+
manager: "ghogen"
21+
ms.workload: ["cplusplus"]
2222
---
2323
# _aligned_free_dbg
24+
2425
Frees a block of memory that was allocated with [_aligned_malloc](../../c-runtime-library/reference/aligned-malloc.md) or [_aligned_offset_malloc](../../c-runtime-library/reference/aligned-offset-malloc.md) (debug only).
2526

2627
## Syntax
@@ -31,12 +32,14 @@ void _aligned_free_dbg(
3132
);
3233
```
3334

34-
#### Parameters
35-
`memblock`
35+
### Parameters
36+
37+
`memblock`
3638
A pointer to the memory block that was returned to the `_aligned_malloc` or `_aligned_offset_malloc` function.
3739

3840
## Remarks
39-
The `_aligned_free_dbg` function is a debug version of the [_aligned_free](../../c-runtime-library/reference/aligned-free.md) function. When [_DEBUG](../../c-runtime-library/debug.md) is not defined, each call to `_aligned_free_dbg` is reduced to a call to `_aligned_free`. Both `_aligned_free` and `_aligned_free_dbg` free a memory block in the base heap, but `_aligned_free_dbg` accommodates a debugging feature: the ability to keep freed blocks in the heap's linked list to simulate low memory conditions.
41+
42+
The `_aligned_free_dbg` function is a debug version of the [_aligned_free](../../c-runtime-library/reference/aligned-free.md) function. When [_DEBUG](../../c-runtime-library/debug.md) is not defined, each call to `_aligned_free_dbg` is reduced to a call to `_aligned_free`. Both `_aligned_free` and `_aligned_free_dbg` free a memory block in the base heap, but `_aligned_free_dbg` accommodates a debugging feature: the ability to keep freed blocks in the heap's linked list to simulate low memory conditions.
4043

4144
`_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.
4245

@@ -53,4 +56,5 @@ void _aligned_free_dbg(
5356
For more compatibility information, see [Compatibility](../../c-runtime-library/compatibility.md) in the Introduction.
5457

5558
## See Also
56-
[Debug Routines](../../c-runtime-library/debug-routines.md)
59+
60+
[Debug Routines](../../c-runtime-library/debug-routines.md)
Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
1-
---
2-
title: "_aligned_free | Microsoft Docs"
3-
ms.custom: ""
4-
ms.date: "11/04/2016"
5-
ms.reviewer: ""
6-
ms.suite: ""
7-
ms.technology: ["cpp-standard-libraries"]
8-
ms.tgt_pltfrm: ""
9-
ms.topic: "reference"
10-
apiname: ["_aligned_free"]
11-
apilocation: ["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-heap-l1-1-0.dll"]
12-
apitype: "DLLExport"
13-
f1_keywords: ["aligned_free", "_aligned_free"]
14-
dev_langs: ["C++"]
15-
helpviewer_keywords: ["_aligned_free function", "aligned_free function"]
16-
ms.assetid: ed1ce952-cdfc-4682-85cc-f75d4101603d
17-
caps.latest.revision: 16
18-
author: "corob-msft"
19-
ms.author: "corob"
20-
manager: "ghogen"
21-
ms.workload: ["cplusplus"]
1+
---
2+
title: "_aligned_free | Microsoft Docs"
3+
ms.custom: ""
4+
ms.date: "11/04/2016"
5+
ms.reviewer: ""
6+
ms.suite: ""
7+
ms.technology: ["cpp-standard-libraries"]
8+
ms.tgt_pltfrm: ""
9+
ms.topic: "reference"
10+
apiname: ["_aligned_free"]
11+
apilocation: ["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-heap-l1-1-0.dll"]
12+
apitype: "DLLExport"
13+
f1_keywords: ["aligned_free", "_aligned_free"]
14+
dev_langs: ["C++"]
15+
helpviewer_keywords: ["_aligned_free function", "aligned_free function"]
16+
ms.assetid: ed1ce952-cdfc-4682-85cc-f75d4101603d
17+
caps.latest.revision: 16
18+
author: "corob-msft"
19+
ms.author: "corob"
20+
manager: "ghogen"
21+
ms.workload: ["cplusplus"]
2222
---
2323
# _aligned_free
24+
2425
Frees a block of memory that was allocated with [_aligned_malloc](../../c-runtime-library/reference/aligned-malloc.md) or [_aligned_offset_malloc](../../c-runtime-library/reference/aligned-offset-malloc.md).
2526

2627
## Syntax
@@ -31,12 +32,14 @@ void _aligned_free (
3132
);
3233
```
3334

34-
#### Parameters
35-
`memblock`
35+
### Parameters
36+
37+
`memblock`
3638
A pointer to the memory block that was returned to the `_aligned_malloc` or `_aligned_offset_malloc` function.
3739

3840
## Remarks
39-
`_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).
41+
42+
`_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).
4043

4144
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](../../c-runtime-library/reference/rpt-rptf-rptw-rptfw-macros.md).
4245

@@ -47,7 +50,9 @@ void _aligned_free (
4750
|`_aligned_free`|\<malloc.h>|
4851

4952
## Example
50-
For more information, see [_aligned_malloc](../../c-runtime-library/reference/aligned-malloc.md).
53+
54+
For more information, see [_aligned_malloc](../../c-runtime-library/reference/aligned-malloc.md).
5155

5256
## See Also
53-
[Data Alignment](../../c-runtime-library/data-alignment.md)
57+
58+
[Data Alignment](../../c-runtime-library/data-alignment.md)

0 commit comments

Comments
 (0)