Skip to content

Commit c88bcb8

Browse files
Barry GoldenBarry Golden
authored andcommitted
Merged PR 18247: Issue 1216
Removed incorrect text in Remarks section.
1 parent fd4993d commit c88bcb8

File tree

1 file changed

+16
-53
lines changed

1 file changed

+16
-53
lines changed

wdk-ddi-src/content/ntddk/ns-ntddk-_file_disposition_information_ex.md

Lines changed: 16 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: _FILE_DISPOSITION_INFORMATION_EX (ntddk.h)
44
description: The FILE_DISPOSITION_INFORMATION_EX structure is used as an argument to the ZwSetInformationFile routine and indicates how the operating system should delete a file.
55
old-location: ifsk\file_disposition_information_ex.htm
66
tech.root: ifsk
7-
ms.date: 04/16/2018
7+
ms.date: 12/07/2021
88
keywords: ["FILE_DISPOSITION_INFORMATION_EX structure"]
99
ms.keywords: "*PFILE_DISPOSITION_INFORMATION_EX, FILE_DISPOSITION_INFORMATION_EX, FILE_DISPOSITION_INFORMATION_EX structure [Installable File System Drivers], PFILE_DISPOSITION_INFORMATION_EX, PFILE_DISPOSITION_INFORMATION_EX structure pointer [Installable File System Drivers], _FILE_DISPOSITION_INFORMATION_EX, ifsk.file_disposition_information_ex, ntddk/FILE_DISPOSITION_INFORMATION_EX, ntddk/PFILE_DISPOSITION_INFORMATION_EX"
1010
req.header: ntddk.h
@@ -48,74 +48,37 @@ api_name:
4848

4949
# _FILE_DISPOSITION_INFORMATION_EX structure
5050

51-
5251
## -description
5352

54-
The <b>FILE_DISPOSITION_INFORMATION_EX</b> structure is used as an argument to the <a href="/windows-hardware/drivers/ddi/wdm/nf-wdm-zwsetinformationfile">ZwSetInformationFile</a> routine and indicates how the operating system should delete a file.
53+
The **FILE_DISPOSITION_INFORMATION_EX** structure is used as an argument to the [ZwSetInformationFile](/windows-hardware/drivers/ddi/wdm/nf-wdm-zwsetinformationfile) routine and indicates how the operating system should delete a file.
5554

5655
## -struct-fields
5756

5857
### -field Flags
5958

60-
Specifies what action(s) the system should take with a specific file while deleting.
59+
Specifies what actions the system should take with a specific file while deleting.
6160

62-
<table>
63-
<tr>
64-
<th>Flag Name</th>
65-
<th>
66-
Value</th>
67-
<th>Meaning</th>
68-
</tr>
69-
<tr>
70-
<td>FILE_DISPOSITION_DO_NOT_DELETE</td>
71-
<td>
72-
0x00000000
73-
</td>
74-
<td>Specifies the system should not delete a file.</td>
75-
</tr>
76-
<tr>
77-
<td>FILE_DISPOSITION_DELETE</td>
78-
<td>0x00000001</td>
79-
<td>Specifies the system should delete a file.</td>
80-
</tr>
81-
<tr>
82-
<td>FILE_DISPOSITION_POSIX_SEMANTICS</td>
83-
<td>0x00000002</td>
84-
<td>Specifies the system should perform a POSIX-style delete. See more info in Remarks.</td>
85-
</tr>
86-
<tr>
87-
<td>FILE_DISPOSITION_FORCE_IMAGE_SECTION_CHECK</td>
88-
<td>0x00000004</td>
89-
<td>Specifies the system should force an image section check. </td>
90-
</tr>
91-
<tr>
92-
<td>FILE_DISPOSITION_ON_CLOSE </td>
93-
<td>0x00000008</td>
94-
<td>Specifies if the system sets or clears the on-close state.</td>
95-
</tr>
96-
<tr>
97-
<td>FILE_DISPOSITION_IGNORE_READONLY_ATTRIBUTE</td>
98-
<td>0x00000010</td>
99-
<td>Allows read-only files to be deleted. See more info in Remarks.</td>
100-
</tr>
101-
</table>
61+
| Flag Name | Value | Meaning |
62+
|--|--|--|
63+
| FILE_DISPOSITION_DO_NOT_DELETE | 0x00000000 | Specifies the system should not delete a file. |
64+
| FILE_DISPOSITION_DELETE | 0x00000001 | Specifies the system should delete a file. |
65+
| FILE_DISPOSITION_POSIX_SEMANTICS | 0x00000002 | Specifies the system should perform a POSIX-style delete. See more info in Remarks. |
66+
| FILE_DISPOSITION_FORCE_IMAGE_SECTION_CHECK | 0x00000004 | Specifies the system should force an image section check. |
67+
| FILE_DISPOSITION_ON_CLOSE | 0x00000008 | Specifies if the system sets or clears the on-close state. |
68+
| FILE_DISPOSITION_IGNORE_READONLY_ATTRIBUTE | 0x00000010 | Allows read-only files to be deleted. For more information, see the Remarks section below. |
10269

10370
## -remarks
10471

105-
The caller must have DELETE access to a given file to call ZwSetInformationFile with <b>FILE_DISPOSITION_DELETE</b>.
106-
72+
The caller must have DELETE access to a given file to call ZwSetInformationFile with **FILE_DISPOSITION_DELETE**.
10773

108-
When <b>FILE_DISPOSITION_POSIX_SEMANTICS</b> is not set, a file marked for deletion is not actually deleted until all open handles for the file have been closed and the link count for the file is zero. When <b>FILE_DISPOSITION_POSIX_SEMANTICS</b> is set, the link is removed from the visible namespace as soon as the POSIX delete handle has been closed, but the files data streams remain accessible by other existing handles until the last handle has been closed. That is, applications that already had the file open can still use their handle to read/write even though the name they used to open it is gone and the file's link count may have reached zero.
74+
When **FILE_DISPOSITION_POSIX_SEMANTICS** is not set, a file marked for deletion is not actually deleted until all open handles for the file have been closed and the link count for the file is zero. When **FILE_DISPOSITION_POSIX_SEMANTICS** is set, the link is removed from the visible namespace as soon as the POSIX delete handle has been closed, but the file's data streams remain accessible by other existing handles until the last handle has been closed. That is, applications that already had the file open can still use their handle to read/write even though the name they used to open it is gone and the file's link count may have reached zero.
10975

11076
If the file is being deleted at user request, using POSIX semantics allows the system to delete the file as requested, but also allows any process with an open handle to continue to access the file's data as long as the handle is open.
11177

112-
A return value of STATUS_CANNOT_DELETE indicates that either the file is read-only, or there's an existing mapped view to the file. Specifying <b>FILE_DISPOSITION_IGNORE_READONLY_ATTRIBUTE</b> avoids this return value due to the file being read-only, provided the caller has FILE_WRITE_ATTRIBUTES access to the file (the access that would be required to clear the read-only attribute).
78+
A return value of STATUS_CANNOT_DELETE indicates that either the file is read-only, or there is an existing mapped view to the file.
11379

11480
## -see-also
11581

116-
<a href="/windows-hardware/drivers/ddi/wdm/nf-wdm-zwclose">ZwClose</a>
117-
118-
119-
120-
<a href="/windows-hardware/drivers/ddi/wdm/nf-wdm-zwsetinformationfile">ZwSetInformationFile</a>
82+
[ZwClose](/windows-hardware/drivers/ddi/wdm/nf-wdm-zwclose)
12183

84+
[ZwSetInformationFile](/windows-hardware/drivers/ddi/wdm/nf-wdm-zwsetinformationfile)

0 commit comments

Comments
 (0)