Revision 030b9baf
b/trunk/Libraries/AlphaFS/AlphaFS.XML | ||
---|---|---|
1 |
<?xml version="1.0"?> |
|
2 |
<doc> |
|
3 |
<assembly> |
|
4 |
<name>AlphaFS</name> |
|
5 |
</assembly> |
|
6 |
<members> |
|
7 |
<member name="T:Alphaleonis.Win32.Filesystem.FileType"> |
|
8 |
<summary> |
|
9 |
Specifies the type of a file. |
|
10 |
</summary> |
|
11 |
</member> |
|
12 |
<member name="F:Alphaleonis.Win32.Filesystem.FileType.Unknown"> |
|
13 |
<summary> |
|
14 |
The type of the specified file is unknown. |
|
15 |
</summary> |
|
16 |
</member> |
|
17 |
<member name="F:Alphaleonis.Win32.Filesystem.FileType.DiskFile"> |
|
18 |
<summary> |
|
19 |
The specified file is a disk file. |
|
20 |
</summary> |
|
21 |
</member> |
|
22 |
<member name="F:Alphaleonis.Win32.Filesystem.FileType.CharacterFile"> |
|
23 |
<summary> |
|
24 |
The specified file is a character file, typically an LPT device or a console. |
|
25 |
</summary> |
|
26 |
</member> |
|
27 |
<member name="F:Alphaleonis.Win32.Filesystem.FileType.Pipe"> |
|
28 |
<summary> |
|
29 |
The specified file is a socket, a named pipe, or an anonymous pipe. |
|
30 |
</summary> |
|
31 |
</member> |
|
32 |
<member name="F:Alphaleonis.Win32.Filesystem.FileType.Remote"> |
|
33 |
<summary> |
|
34 |
Unused. |
|
35 |
</summary> |
|
36 |
</member> |
|
37 |
<member name="T:Alphaleonis.Win32.Filesystem.DiskSpaceInfo"> |
|
38 |
<summary> |
|
39 |
Represents information about free and used space on a disk. |
|
40 |
</summary> |
|
41 |
</member> |
|
42 |
<member name="M:Alphaleonis.Win32.Filesystem.DiskSpaceInfo.#ctor(System.UInt64,System.UInt64,System.UInt64)"> |
|
43 |
<summary> |
|
44 |
Initializes the structure |
|
45 |
</summary> |
|
46 |
<param name="freeBytes">The free bytes available</param> |
|
47 |
<param name="totalBytes">The total number of bytes</param> |
|
48 |
<param name="totalFreeBytes">The total number of free bytes</param> |
|
49 |
</member> |
|
50 |
<member name="M:Alphaleonis.Win32.Filesystem.DiskSpaceInfo.Equals(System.Object)"> |
|
51 |
<summary> |
|
52 |
Indicates whether this instance and a specified object are equal. |
|
53 |
</summary> |
|
54 |
<param name="obj">Another object to compare to.</param> |
|
55 |
<returns> |
|
56 |
true if <paramref name="obj"/> and this instance are the same type and represent the same value; otherwise, false. |
|
57 |
</returns> |
|
58 |
</member> |
|
59 |
<member name="M:Alphaleonis.Win32.Filesystem.DiskSpaceInfo.GetHashCode"> |
|
60 |
<summary> |
|
61 |
Returns the hash code for this instance. |
|
62 |
</summary> |
|
63 |
<returns> |
|
64 |
A 32-bit signed integer that is the hash code for this instance. |
|
65 |
</returns> |
|
66 |
</member> |
|
67 |
<member name="M:Alphaleonis.Win32.Filesystem.DiskSpaceInfo.op_Equality(Alphaleonis.Win32.Filesystem.DiskSpaceInfo,Alphaleonis.Win32.Filesystem.DiskSpaceInfo)"> |
|
68 |
<summary> |
|
69 |
Implements the operator ==. |
|
70 |
</summary> |
|
71 |
<param name="left">A.</param> |
|
72 |
<param name="right">B.</param> |
|
73 |
<returns>The result of the operator.</returns> |
|
74 |
</member> |
|
75 |
<member name="M:Alphaleonis.Win32.Filesystem.DiskSpaceInfo.op_Inequality(Alphaleonis.Win32.Filesystem.DiskSpaceInfo,Alphaleonis.Win32.Filesystem.DiskSpaceInfo)"> |
|
76 |
<summary> |
|
77 |
Implements the operator !=. |
|
78 |
</summary> |
|
79 |
<param name="left">A.</param> |
|
80 |
<param name="right">B.</param> |
|
81 |
<returns>The result of the operator.</returns> |
|
82 |
</member> |
|
83 |
<member name="P:Alphaleonis.Win32.Filesystem.DiskSpaceInfo.FreeBytesAvailable"> |
|
84 |
<summary> |
|
85 |
Gets or sets the free bytes available. |
|
86 |
</summary> |
|
87 |
<value>The free bytes available.</value> |
|
88 |
</member> |
|
89 |
<member name="P:Alphaleonis.Win32.Filesystem.DiskSpaceInfo.TotalNumberOfBytes"> |
|
90 |
<summary> |
|
91 |
Gets or sets the total number of bytes. |
|
92 |
</summary> |
|
93 |
<value>The total number of bytes.</value> |
|
94 |
</member> |
|
95 |
<member name="P:Alphaleonis.Win32.Filesystem.DiskSpaceInfo.TotalNumberOfFreeBytes"> |
|
96 |
<summary> |
|
97 |
Gets or sets the total number of free bytes. |
|
98 |
</summary> |
|
99 |
<value>The total number of free bytes.</value> |
|
100 |
</member> |
|
101 |
<member name="T:Alphaleonis.Win32.Filesystem.VolumeInfo"> |
|
102 |
<summary> |
|
103 |
Represents information about a volume. |
|
104 |
</summary> |
|
105 |
</member> |
|
106 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.Name"> |
|
107 |
<summary> |
|
108 |
Gets the name of the volume. |
|
109 |
</summary> |
|
110 |
<value>The name of the volume.</value> |
|
111 |
</member> |
|
112 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.PreservesCase"> |
|
113 |
<summary> |
|
114 |
Gets a value indicating whether the file system preserves the case of file names when it places a name on disk.. |
|
115 |
</summary> |
|
116 |
<value><c>true</c> if the file system preserves the case of file names when it places a name on disk.]; otherwise, <c>false</c>.</value> |
|
117 |
</member> |
|
118 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.SupportsCaseSensitiveFileNames"> |
|
119 |
<summary> |
|
120 |
Gets a value indicating whether the file system supports case-sensitive file names.. |
|
121 |
</summary> |
|
122 |
<value> |
|
123 |
<c>true</c> if the file system supports case-sensitive file names; otherwise, <c>false</c>. |
|
124 |
</value> |
|
125 |
</member> |
|
126 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.SupportsFileCompression"> |
|
127 |
<summary> |
|
128 |
Gets a value indicating whether the file system supports file-based compression. |
|
129 |
</summary> |
|
130 |
<value> |
|
131 |
<c>true</c> if the file system supports file-based compression; otherwise, <c>false</c>. |
|
132 |
</value> |
|
133 |
</member> |
|
134 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.SupportsNamedStreams"> |
|
135 |
<summary> |
|
136 |
Gets a value indicating whether the file system supports named streams. |
|
137 |
</summary> |
|
138 |
<value> |
|
139 |
<c>true</c> if the file system supports named streams; otherwise, <c>false</c>. |
|
140 |
</value> |
|
141 |
</member> |
|
142 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.HasPersistentAccessControlLists"> |
|
143 |
<summary> |
|
144 |
Gets a value indicating whether the file system preserves and enforces access control lists (ACL). |
|
145 |
</summary> |
|
146 |
<value> |
|
147 |
<c>true</c> if the file system preserves and enforces access control lists (ACL); otherwise, <c>false</c>. |
|
148 |
</value> |
|
149 |
<remarks>For example, the NTFS file system preserves and enforces ACLs, and the FAT file system does not.</remarks> |
|
150 |
</member> |
|
151 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.IsReadOnly"> |
|
152 |
<summary> |
|
153 |
Gets a value indicating whether the specified volume is read-only.. |
|
154 |
</summary> |
|
155 |
<value> |
|
156 |
<c>true</c> if the specified volume is read-only.; otherwise, <c>false</c>. |
|
157 |
</value> |
|
158 |
<remarks>This value is not supported on Windows 2000/NT and Windows Me/98/95.</remarks> |
|
159 |
</member> |
|
160 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.SupportsEncryption"> |
|
161 |
<summary> |
|
162 |
Gets a value indicating whether the file system supports the Encrypted File System (EFS). |
|
163 |
</summary> |
|
164 |
<value><c>true</c> if the file system supports the Encrypted File System (EFS); otherwise, <c>false</c>.</value> |
|
165 |
</member> |
|
166 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.SupportsObjectIdentifiers"> |
|
167 |
<summary> |
|
168 |
Gets a value indicating whether the file system supports object identifiers. |
|
169 |
</summary> |
|
170 |
<value> |
|
171 |
<c>true</c> if the file system supports object identifiers; otherwise, <c>false</c>. |
|
172 |
</value> |
|
173 |
</member> |
|
174 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.SupportsReparsePoints"> |
|
175 |
<summary> |
|
176 |
Gets a value indicating whether he file system supports re-parse points. |
|
177 |
</summary> |
|
178 |
<value> |
|
179 |
<c>true</c> if he file system supports re-parse points; otherwise, <c>false</c>. |
|
180 |
</value> |
|
181 |
</member> |
|
182 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.SupportsSparseFiles"> |
|
183 |
<summary> |
|
184 |
Gets a value indicating whether the file system supports sparse files. |
|
185 |
</summary> |
|
186 |
<value><c>true</c> if the file system supports sparse files; otherwise, <c>false</c>.</value> |
|
187 |
</member> |
|
188 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.SupportsUnicodeFileNames"> |
|
189 |
<summary> |
|
190 |
Gets a value indicating whether the file system supports Unicode in file names as they appear on disk. |
|
191 |
</summary> |
|
192 |
<value> |
|
193 |
<c>true</c> if the file system supports Unicode in file names as they appear on disk; otherwise, <c>false</c>. |
|
194 |
</value> |
|
195 |
</member> |
|
196 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.IsCompressed"> |
|
197 |
<summary> |
|
198 |
Gets a value indicating whether the specified volume is a compressed volume, for example, a DoubleSpace volume. |
|
199 |
</summary> |
|
200 |
<value> |
|
201 |
<c>true</c> if the specified volume is a compressed volume; otherwise, <c>false</c>. |
|
202 |
</value> |
|
203 |
</member> |
|
204 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.SupportsDiskQuotas"> |
|
205 |
<summary> |
|
206 |
Gets a value indicating whether the file system supports disk quotas. |
|
207 |
</summary> |
|
208 |
<value><c>true</c> if the file system supports disk quotas; otherwise, <c>false</c>.</value> |
|
209 |
</member> |
|
210 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.SerialNumber"> |
|
211 |
<summary> |
|
212 |
Gets the volume serial number that the operating system assigns when a hard disk is formatted. |
|
213 |
</summary> |
|
214 |
<value>The volume serial number that the operating system assigns when a hard disk is formatted.</value> |
|
215 |
</member> |
|
216 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.MaximumComponentLength"> |
|
217 |
<summary> |
|
218 |
Gets the maximum length of a file name component that the file system supports. |
|
219 |
</summary> |
|
220 |
<value>The maximum length of a file name component that the file system supports.</value> |
|
221 |
</member> |
|
222 |
<member name="P:Alphaleonis.Win32.Filesystem.VolumeInfo.FileSystemName"> |
|
223 |
<summary> |
|
224 |
Gets the name of the file system, for example, the FAT file system or the NTFS file system. |
|
225 |
</summary> |
|
226 |
<value>The name of the file system.</value> |
|
227 |
</member> |
|
228 |
<member name="T:Alphaleonis.Win32.Filesystem.FileOptions"> |
|
229 |
<summary> |
|
230 |
Specifies how the operating system should open a file. |
|
231 |
</summary> |
|
232 |
</member> |
|
233 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.None"> |
|
234 |
<summary> |
|
235 |
None of the options specified. |
|
236 |
</summary> |
|
237 |
</member> |
|
238 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.Archive"> |
|
239 |
<summary> |
|
240 |
The file should be archived. Applications use this attribute to mark files for backup or removal. |
|
241 |
</summary> |
|
242 |
</member> |
|
243 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.Encrypted"> |
|
244 |
<summary> |
|
245 |
The file or directory is encrypted. For a file, this means that all data in the file is encrypted. For a directory, this means that encryption is the default for newly created files and subdirectories. |
|
246 |
</summary> |
|
247 |
</member> |
|
248 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.Hidden"> |
|
249 |
<summary> |
|
250 |
The file is hidden. Do not include it in an ordinary directory listing. |
|
251 |
</summary> |
|
252 |
</member> |
|
253 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.Normal"> |
|
254 |
<summary> |
|
255 |
The file does not have other attributes set. This attribute is valid only if used alone. |
|
256 |
</summary> |
|
257 |
</member> |
|
258 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.Offline"> |
|
259 |
<summary> |
|
260 |
The data of a file is not immediately available. This attribute indicates that file data is physically moved to offline storage. This attribute is used by Remote Storage, the hierarchical storage management software. Applications should not arbitrarily change this attribute. |
|
261 |
</summary> |
|
262 |
</member> |
|
263 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.ReadOnly"> |
|
264 |
<summary> |
|
265 |
The file is read only. Applications can read the file, but cannot write to or delete it. |
|
266 |
</summary> |
|
267 |
</member> |
|
268 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.System"> |
|
269 |
<summary> |
|
270 |
The file is part of or used exclusively by an operating system. |
|
271 |
</summary> |
|
272 |
</member> |
|
273 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.Temporary"> |
|
274 |
<summary> |
|
275 |
The file is being used for temporary storage. |
|
276 |
</summary> |
|
277 |
</member> |
|
278 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.BackupSemantics"> |
|
279 |
<summary> |
|
280 |
The file is being opened or created for a backup or restore operation. The system ensures that the calling process |
|
281 |
overrides file security checks when the process has SE_BACKUP_NAME and SE_RESTORE_NAME privileges. |
|
282 |
You must set this flag to obtain a handle to a directory. A directory handle can be passed to some functions instead of a file handle. |
|
283 |
</summary> |
|
284 |
</member> |
|
285 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.DeleteOnClose"> |
|
286 |
<summary> |
|
287 |
<para>The file is to be deleted immediately after all of its handles are closed, which includes the specified handle and any other open or duplicated handles.</para> |
|
288 |
<para>If there are existing open handles to a file, the call fails unless they were all opened with the <see cref="F:Alphaleonis.Win32.Filesystem.FileShare.Delete"/> share mode.</para> |
|
289 |
<para>Subsequent open requests for the file fail, unless the <see cref="F:Alphaleonis.Win32.Filesystem.FileShare.Delete"/> share mode is specified.</para> |
|
290 |
</summary> |
|
291 |
</member> |
|
292 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.NoBuffering"> |
|
293 |
<summary> |
|
294 |
There are strict requirements for successfully working with files opened with the <see cref="F:Alphaleonis.Win32.Filesystem.FileOptions.NoBuffering"/> flag, for |
|
295 |
details see the section on "File Buffering" in the online MSDN documentation. |
|
296 |
</summary> |
|
297 |
</member> |
|
298 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.OpenNoRecall"> |
|
299 |
<summary> |
|
300 |
The file data is requested, but it should continue to be located in remote storage. It should not be transported back to local storage. This flag is for use by remote storage systems. |
|
301 |
</summary> |
|
302 |
</member> |
|
303 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.OpenReparsePoint"> |
|
304 |
<summary> |
|
305 |
<para>Normal reparse point processing will not occur; an attempt to open the reparse point will be made. |
|
306 |
When a file is opened, a file handle is returned, whether or not the filter that controls the reparse |
|
307 |
point is operational. See MSDN documentation for more information.</para> |
|
308 |
</summary> |
|
309 |
</member> |
|
310 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.Overlapped"> |
|
311 |
<summary> |
|
312 |
The file or device is being opened or created for asynchronous I/O. |
|
313 |
</summary> |
|
314 |
</member> |
|
315 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.PosixSemantics"> |
|
316 |
<summary> |
|
317 |
Access will occur according to POSIX rules. This includes allowing multiple files with names, differing only in case, for file systems that support that naming. Use care when using this option, because files created with this flag may not be accessible by applications that are written for MS-DOS or 16-bit Windows. |
|
318 |
</summary> |
|
319 |
</member> |
|
320 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.RandomAccess"> |
|
321 |
<summary> |
|
322 |
Access is intended to be random. The system can use this as a hint to optimize file caching. |
|
323 |
</summary> |
|
324 |
</member> |
|
325 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.SequentialScan"> |
|
326 |
<summary> |
|
327 |
Access is intended to be sequential from beginning to end. The system can use this as a hint to optimize file caching. |
|
328 |
</summary> |
|
329 |
</member> |
|
330 |
<member name="F:Alphaleonis.Win32.Filesystem.FileOptions.WriteThrough"> |
|
331 |
<summary> |
|
332 |
Write operations will not go through any intermediate cache, they will go directly to disk. |
|
333 |
</summary> |
|
334 |
</member> |
|
335 |
<member name="T:Alphaleonis.Win32.Filesystem.FileSystemInfo"> |
|
336 |
<summary> |
|
337 |
Provides the base class for both FileInfo and DirectoryInfo objects. |
|
338 |
</summary> |
|
339 |
</member> |
|
340 |
<member name="F:Alphaleonis.Win32.Filesystem.FileSystemInfo.mExists"> |
|
341 |
<summary> |
|
342 |
Indicator of file existence. It refreshes each time Refresh() has been called. |
|
343 |
</summary> |
|
344 |
</member> |
|
345 |
<member name="F:Alphaleonis.Win32.Filesystem.FileSystemInfo.mFileSystemEntryInfo"> |
|
346 |
<summary> |
|
347 |
Represents extended file information. |
|
348 |
</summary> |
|
349 |
</member> |
|
350 |
<member name="F:Alphaleonis.Win32.Filesystem.FileSystemInfo.FullPath"> |
|
351 |
<summary> |
|
352 |
Represents the fully qualified path of the directory or file. |
|
353 |
</summary> |
|
354 |
<remarks> |
|
355 |
Notes to Inheritors: |
|
356 |
Classes derived from FileSystemInfo can use the FullPath field to determine the full path of the object being manipulated. |
|
357 |
</remarks> |
|
358 |
</member> |
|
359 |
<member name="F:Alphaleonis.Win32.Filesystem.FileSystemInfo.OriginalPath"> |
|
360 |
<summary> |
|
361 |
The path originally specified by the user, whether relative or absolute. |
|
362 |
</summary> |
|
363 |
</member> |
|
364 |
<member name="M:Alphaleonis.Win32.Filesystem.FileSystemInfo.Delete"> |
|
365 |
<summary> |
|
366 |
Deletes a file or directory. |
|
367 |
</summary> |
|
368 |
</member> |
|
369 |
<member name="M:Alphaleonis.Win32.Filesystem.FileSystemInfo.Refresh"> |
|
370 |
<summary> |
|
371 |
Refreshes the state of the object. |
|
372 |
</summary> |
|
373 |
<remarks> |
|
374 |
FileSystemInfo.Refresh takes a snapshot of the file from the current file system. Refresh cannot correct the underlying file system even if the file system returns incorrect or outdated information. This can happen on platforms such as Windows 98. |
|
375 |
Calls must be made to Refresh before attempting to get the attribute information, or the information will be outdated. |
|
376 |
</remarks> |
|
377 |
</member> |
|
378 |
<member name="M:Alphaleonis.Win32.Filesystem.FileSystemInfo.ToString"> |
|
379 |
<summary> |
|
380 |
Returns a String that represents the current Object. |
|
381 |
</summary> |
|
382 |
<returns>String</returns> |
|
383 |
</member> |
|
384 |
<member name="M:Alphaleonis.Win32.Filesystem.FileSystemInfo.ThrowDoesNotExistsException"> |
|
385 |
<summary> |
|
386 |
Throws the does not exists exception. |
|
387 |
</summary> |
|
388 |
</member> |
|
389 |
<member name="M:Alphaleonis.Win32.Filesystem.FileSystemInfo.Initialize(System.String)"> |
|
390 |
<summary> |
|
391 |
Initializes the specified file name. |
|
392 |
</summary> |
|
393 |
<param name="fileName">Name of the file.</param> |
|
394 |
</member> |
|
395 |
<member name="P:Alphaleonis.Win32.Filesystem.FileSystemInfo.DirectoryName"> |
|
396 |
<summary> |
|
397 |
Gets a full path string representing the file's parent directory. |
|
398 |
</summary> |
|
399 |
<value>A string representing the parent directory full path.</value> |
|
400 |
</member> |
|
401 |
<member name="P:Alphaleonis.Win32.Filesystem.FileSystemInfo.Attributes"> |
|
402 |
<summary> |
|
403 |
Gets or sets the <see cref="T:Alphaleonis.Win32.Filesystem.FileAttributes"/> of the current <see cref="T:Alphaleonis.Win32.Filesystem.FileSystemInfo"/>. |
|
404 |
</summary> |
|
405 |
</member> |
|
406 |
<member name="P:Alphaleonis.Win32.Filesystem.FileSystemInfo.CreationTime"> |
|
407 |
<summary> |
|
408 |
Gets or sets the creation time of the current <see cref="T:Alphaleonis.Win32.Filesystem.FileSystemInfo"/> object. |
|
409 |
</summary> |
|
410 |
<returns>The creation date and time of the current System.IO.FileSystemInfo object.</returns> |
|
411 |
</member> |
|
412 |
<member name="P:Alphaleonis.Win32.Filesystem.FileSystemInfo.CreationTimeUtc"> |
|
413 |
<summary> |
|
414 |
Gets or sets the creation time, in coordinated universal time (UTC), of the current FileSystemInfo object. |
|
415 |
</summary> |
|
416 |
</member> |
|
417 |
<member name="P:Alphaleonis.Win32.Filesystem.FileSystemInfo.Exists"> |
|
418 |
<summary> |
|
419 |
Gets a value indicating whether the file or directory exists. |
|
420 |
</summary> |
|
421 |
</member> |
|
422 |
<member name="P:Alphaleonis.Win32.Filesystem.FileSystemInfo.Extension"> |
|
423 |
<summary> |
|
424 |
The Extension property returns the FileSystemInfo extension, including the period (.). For example, for a file c:\NewFile.txt, this property returns ".txt". |
|
425 |
</summary> |
|
426 |
</member> |
|
427 |
<member name="P:Alphaleonis.Win32.Filesystem.FileSystemInfo.FullName"> |
|
428 |
<summary> |
|
429 |
A string containing the name with full path. |
|
430 |
</summary> |
|
431 |
</member> |
|
432 |
<member name="P:Alphaleonis.Win32.Filesystem.FileSystemInfo.SystemInfo"> |
|
433 |
<summary> |
|
434 |
Gets the system info. |
|
435 |
</summary> |
|
436 |
<value>The system info.</value> |
|
437 |
</member> |
|
438 |
<member name="P:Alphaleonis.Win32.Filesystem.FileSystemInfo.LastAccessTime"> |
|
439 |
<summary> |
|
440 |
Gets or sets the time the current file or directory was last accessed. |
|
441 |
</summary> |
|
442 |
<remarks>When first called, <see cref="T:Alphaleonis.Win32.Filesystem.FileSystemInfo"/> calls Refresh and returns the cached information on APIs to get attributes and so on. On subsequent calls, you must call Refresh to get the latest copy of the information. |
|
443 |
If the file described in the <see cref="T:Alphaleonis.Win32.Filesystem.FileSystemInfo"/> object does not exist, this property will return 12:00 midnight, January 1, 1601 A.D. (C.E.) Coordinated Universal Time (UTC), adjusted to local time. |
|
444 |
</remarks> |
|
445 |
</member> |
|
446 |
<member name="P:Alphaleonis.Win32.Filesystem.FileSystemInfo.LastAccessTimeUtc"> |
|
447 |
<summary> |
|
448 |
Gets or sets the time, in coordinated universal time (UTC), that the current file or directory was last accessed |
|
449 |
</summary> |
|
450 |
<remarks>When first called, <see cref="T:Alphaleonis.Win32.Filesystem.FileSystemInfo"/> calls Refresh and returns the cached information on APIs to get attributes and so on. On subsequent calls, you must call Refresh to get the latest copy of the information. |
|
451 |
If the file described in the <see cref="T:Alphaleonis.Win32.Filesystem.FileSystemInfo"/> object does not exist, this property will return 12:00 midnight, January 1, 1601 A.D. (C.E.) Coordinated Universal Time (UTC), adjusted to local time. |
|
452 |
</remarks> |
|
453 |
</member> |
|
454 |
<member name="P:Alphaleonis.Win32.Filesystem.FileSystemInfo.LastWriteTime"> |
|
455 |
<summary> |
|
456 |
Gets or sets the time when the current file or directory was last written to. |
|
457 |
</summary> |
|
458 |
</member> |
|
459 |
<member name="P:Alphaleonis.Win32.Filesystem.FileSystemInfo.LastWriteTimeUtc"> |
|
460 |
<summary> |
|
461 |
Gets or sets the time, in coordinated universal time (UTC), when the current file or directory was last written to. |
|
462 |
</summary> |
|
463 |
</member> |
|
464 |
<member name="P:Alphaleonis.Win32.Filesystem.FileSystemInfo.Name"> |
|
465 |
<summary> |
|
466 |
For files, gets the name of the file. For directories, gets the name of the last directory in the hierarchy if a hierarchy exists. Otherwise, the Name property gets the name of the directory. |
|
467 |
</summary> |
|
468 |
<remarks> |
|
469 |
For a directory, Name returns only the name of the parent directory, such as Dir, not c:\Dir. For a subdirectory, Name returns only the name of the subdirectory, such as Sub1, not c:\Dir\Sub1. |
|
470 |
For a file, Name returns only the file name and file name extension, such as MyFile.txt, not c:\Dir\Myfile.txt. |
|
471 |
</remarks> |
|
472 |
</member> |
|
473 |
<member name="T:Alphaleonis.Win32.Filesystem.NativeMethods.GET_FILEEX_INFO_LEVELS"> |
|
474 |
<summary> |
|
475 |
Defines values that are used with the GetFileAttributes function to specify the information level of the returned data. |
|
476 |
</summary> |
|
477 |
</member> |
|
478 |
<member name="F:Alphaleonis.Win32.Filesystem.NativeMethods.GET_FILEEX_INFO_LEVELS.GetFileExInfoStandard"> |
|
479 |
<summary> |
|
480 |
The GetFileAttributes function retrieves a standard set of attribute information. The data is returned in a WIN32_FILE_ATTRIBUTE_DATA structure. |
|
481 |
</summary> |
|
482 |
</member> |
|
483 |
<member name="F:Alphaleonis.Win32.Filesystem.NativeMethods.GET_FILEEX_INFO_LEVELS.GetFileExMaxInfoLevel"> |
|
484 |
<summary> |
|
485 |
One greater than the maximum value. Valid values for this enumeration will be less than this value. |
|
486 |
</summary> |
|
487 |
</member> |
|
488 |
<member name="T:Alphaleonis.Win32.Filesystem.NativeMethods.WIN32_FIND_DATA"> |
|
489 |
<summary> |
|
490 |
Note: for some marshalling reason WIN32_FIND_DATA whould be declared as class not a struct. |
|
491 |
</summary> |
|
492 |
</member> |
|
493 |
<member name="F:Alphaleonis.Win32.Filesystem.NativeMethods.WIN32_FIND_DATA.dwReserved1"> |
|
494 |
<summary> |
|
495 |
Reserved for future use |
|
496 |
</summary> |
|
497 |
</member> |
|
498 |
<member name="T:Alphaleonis.Win32.Filesystem.NativeMethods.SecurityAttributes"> |
|
499 |
<summary> |
|
500 |
Class used to represent the SECURITY_ATTRIBUES native win32 structure. |
|
501 |
It provides initialization function from an ObjectSecurity object. |
|
502 |
</summary> |
|
503 |
</member> |
|
504 |
<member name="M:Alphaleonis.Win32.Filesystem.NativeMethods.SecurityAttributes.Initialize(Alphaleonis.Win32.SafeGlobalMemoryBufferHandle@,System.Security.AccessControl.ObjectSecurity)"> |
|
505 |
<summary> |
|
506 |
Initializes the SecurityAttributes structure from an instance of <see cref="T:System.Security.AccessControl.ObjectSecurity"/>. |
|
507 |
</summary> |
|
508 |
<param name="memoryHandle">A handle that will refer to the memory allocated by this object for storage of the |
|
509 |
security descriptor. As long as this object is used, the memory handle should be kept alive, and afterwards it |
|
510 |
should be disposed as soon as possible.</param> |
|
511 |
<param name="securityDescriptor">The security descriptor to assign to this object. This parameter may be <see langword="null"/>.</param> |
|
512 |
</member> |
|
513 |
<member name="F:Alphaleonis.Win32.Filesystem.NativeMethods.FINDEX_INFO_LEVELS.FindExInfoBasic"> |
|
514 |
<summary> |
|
515 |
This value is not supported until Windows Server 2008 R2 and Windows 7. |
|
516 |
</summary> |
|
517 |
</member> |
|
518 |
<member name="T:Alphaleonis.Win32.Filesystem.PathInfo"> |
|
519 |
<summary> |
|
520 |
A representation of a path, providing convenient access to the individual components |
|
521 |
of the path. |
|
522 |
</summary> |
|
523 |
<remarks>Note that no methods in this class verifies whether the path actually exists or not.</remarks> |
|
524 |
</member> |
|
525 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.#ctor(System.String)"> |
|
526 |
<overloads> |
|
527 |
<summary> |
|
528 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.PathInfo"/> class. |
|
529 |
</summary> |
|
530 |
</overloads> |
|
531 |
<param name="path">The path.</param> |
|
532 |
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/></exception> |
|
533 |
<exception cref="T:Alphaleonis.Win32.Filesystem.IllegalPathException">The path is not a legal path in the Win32 file system.</exception> |
|
534 |
</member> |
|
535 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.#ctor(System.String,System.Boolean)"> |
|
536 |
<summary> |
|
537 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.PathInfo"/> class specifying whether wildcards |
|
538 |
should be accepted or not. |
|
539 |
</summary> |
|
540 |
<param name="path">The path.</param> |
|
541 |
<param name="allowWildcardsInFileName">if set to <c>true</c> wildcards are allowed in the file |
|
542 |
name part of the path. If set to <c>false</c>, wildcards are not allowed and an |
|
543 |
<see cref="T:System.ArgumentException"/> will be thrown if they are present.</param> |
|
544 |
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/></exception> |
|
545 |
<remarks> |
|
546 |
<para>Note that under no circumstances will this class accept wildcards in |
|
547 |
the directory part of the path, only in the file-name, i.e. the component |
|
548 |
after the last backslash or separator. |
|
549 |
</para> |
|
550 |
<para> |
|
551 |
Extended length unicode paths (also referred to as long paths) (those starting with \\?\) will <b>not</b> be |
|
552 |
parsed for wildcards etc., regardless of the setting of this parameter. |
|
553 |
In such a path any character is valid and backslashes alone are considered |
|
554 |
to be separators. |
|
555 |
</para> |
|
556 |
</remarks> |
|
557 |
</member> |
|
558 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.#ctor(System.String,System.Collections.Generic.List{System.Int32},System.Int32)"> |
|
559 |
<summary> |
|
560 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.PathInfo"/> class. |
|
561 |
</summary> |
|
562 |
<param name="path">The path.</param> |
|
563 |
<param name="indices">The indices.</param> |
|
564 |
<param name="extensionIndex">Position of the beginning of the file extension in the path.</param> |
|
565 |
</member> |
|
566 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.GetLongPath"> |
|
567 |
<summary> |
|
568 |
Retrieves the full long (or extended) unicode version of the path represented by this <see cref="T:Alphaleonis.Win32.Filesystem.PathInfo"/> instance. |
|
569 |
</summary> |
|
570 |
<remarks> |
|
571 |
<para> |
|
572 |
This method takes care of different path conversions to be usable in Unicode |
|
573 |
variants of the Win32 funcitons (which are internally used throughout AlphaFS). |
|
574 |
</para> |
|
575 |
<para> |
|
576 |
Regular paths are changed like the following: |
|
577 |
<list type="table"> |
|
578 |
<item> |
|
579 |
<term><c>C:\Somewhere\Something.txt</c></term> |
|
580 |
<description><c>\\?\C:\Somewhere\Something.txt</c></description> |
|
581 |
</item> |
|
582 |
<item> |
|
583 |
<term><c>\\Somewhere\Something.txt</c></term> |
|
584 |
<description><c>\\?\UNC\Somewhere\Something.txt</c></description> |
|
585 |
</item> |
|
586 |
</list> |
|
587 |
</para> |
|
588 |
<para> |
|
589 |
Already processed paths are preserved untouched so to avoid mistakes of double prefixing. |
|
590 |
</para> |
|
591 |
<para> |
|
592 |
If the path represented by this instance is not an absolute path, or is not rooted, the path of the |
|
593 |
current directory (and drive) is combined with this path to form |
|
594 |
an absolute path. |
|
595 |
</para> |
|
596 |
</remarks> |
|
597 |
<returns>The long or extended unicode version of the specified path.</returns> |
|
598 |
<seealso cref="M:Alphaleonis.Win32.Filesystem.PathInfo.GetFullPath"/> |
|
599 |
<seealso cref="M:Alphaleonis.Win32.Filesystem.Path.GetLongPath(System.String)"/> |
|
600 |
</member> |
|
601 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.GetFullPath"> |
|
602 |
<summary> |
|
603 |
Gets the full absolute path of the path represented by this instance. |
|
604 |
This is done by "applying" the path to the current directory if the path |
|
605 |
does not contain a root, or the volume of the current directory if the |
|
606 |
path does not contain any drive information. |
|
607 |
</summary> |
|
608 |
<returns>The full absolute path.</returns> |
|
609 |
</member> |
|
610 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.ToString"> |
|
611 |
<summary> |
|
612 |
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>. |
|
613 |
</summary> |
|
614 |
<returns> |
|
615 |
A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>. |
|
616 |
</returns> |
|
617 |
</member> |
|
618 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.CompareTo(Alphaleonis.Win32.Filesystem.PathInfo)"> |
|
619 |
<summary> |
|
620 |
Performs a lexiographical comparison of the string representations of this and |
|
621 |
the other path, ignoring case. |
|
622 |
</summary> |
|
623 |
<param name="other">A <see cref="T:Alphaleonis.Win32.Filesystem.PathInfo"/> to compare with this object.</param> |
|
624 |
<returns> |
|
625 |
A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the <paramref name="other"/> parameter.Zero This object is equal to <paramref name="other"/>. Greater than zero This object is greater than <paramref name="other"/>. |
|
626 |
</returns> |
|
627 |
</member> |
|
628 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.Equals(Alphaleonis.Win32.Filesystem.PathInfo)"> |
|
629 |
<summary> |
|
630 |
Performs a lexiographical comparison for equality of the string representations of this and |
|
631 |
the other path, ignoring case. |
|
632 |
</summary> |
|
633 |
<param name="other">An object to compare with this object.</param> |
|
634 |
<returns> |
|
635 |
true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false. |
|
636 |
</returns> |
|
637 |
</member> |
|
638 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.Equals(System.Object)"> |
|
639 |
<summary> |
|
640 |
Performs a lexiographical comparison for equality of the string representations of this and |
|
641 |
the other path, ignoring case. |
|
642 |
</summary> |
|
643 |
<param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param> |
|
644 |
<returns> |
|
645 |
true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false. |
|
646 |
</returns> |
|
647 |
<exception cref="T:System.NullReferenceException">The <paramref name="obj"/> parameter is null.</exception> |
|
648 |
</member> |
|
649 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.GetHashCode"> |
|
650 |
<summary> |
|
651 |
Serves as a hash function for a particular type. |
|
652 |
</summary> |
|
653 |
<returns> |
|
654 |
A hash code for the current <see cref="T:System.Object"/>. |
|
655 |
</returns> |
|
656 |
</member> |
|
657 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.Combine(Alphaleonis.Win32.Filesystem.PathInfo,Alphaleonis.Win32.Filesystem.PathInfo)"> |
|
658 |
<summary> |
|
659 |
Combines two paths. |
|
660 |
</summary> |
|
661 |
<param name="path1">The first path. </param> |
|
662 |
<param name="path2">The second path.</param> |
|
663 |
<returns>A string containing the combined paths. If one of the specified paths is a zero-length string, this method returns the other path. If path2 contains an absolute path, this method returns path2.</returns> |
|
664 |
</member> |
|
665 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.op_Addition(Alphaleonis.Win32.Filesystem.PathInfo,Alphaleonis.Win32.Filesystem.PathInfo)"> |
|
666 |
<summary> |
|
667 |
Combines two paths. |
|
668 |
</summary> |
|
669 |
<param name="path1">The first path. </param> |
|
670 |
<param name="path2">The second path.</param> |
|
671 |
<returns>A string containing the combined paths. If one of the specified paths is a zero-length string, this method returns the other path. If path2 contains an absolute path, this method returns path2.</returns> |
|
672 |
</member> |
|
673 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.op_Equality(Alphaleonis.Win32.Filesystem.PathInfo,Alphaleonis.Win32.Filesystem.PathInfo)"> |
|
674 |
<summary> |
|
675 |
Implements the operator ==. |
|
676 |
</summary> |
|
677 |
<param name="path1">The path1.</param> |
|
678 |
<param name="path2">The path2.</param> |
|
679 |
<returns>The result of the operator.</returns> |
|
680 |
</member> |
|
681 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.op_Inequality(Alphaleonis.Win32.Filesystem.PathInfo,Alphaleonis.Win32.Filesystem.PathInfo)"> |
|
682 |
<summary> |
|
683 |
Implements the operator !=. |
|
684 |
</summary> |
|
685 |
<param name="path1">The path1.</param> |
|
686 |
<param name="path2">The path2.</param> |
|
687 |
<returns>The result of the operator.</returns> |
|
688 |
</member> |
|
689 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.op_LessThan(Alphaleonis.Win32.Filesystem.PathInfo,Alphaleonis.Win32.Filesystem.PathInfo)"> |
|
690 |
<summary> |
|
691 |
Implements the operator <. |
|
692 |
</summary> |
|
693 |
<param name="path1">The path1.</param> |
|
694 |
<param name="path2">The path2.</param> |
|
695 |
<returns>The result of the operator.</returns> |
|
696 |
</member> |
|
697 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.op_GreaterThan(Alphaleonis.Win32.Filesystem.PathInfo,Alphaleonis.Win32.Filesystem.PathInfo)"> |
|
698 |
<summary> |
|
699 |
Implements the operator >. |
|
700 |
</summary> |
|
701 |
<param name="path1">The path1.</param> |
|
702 |
<param name="path2">The path2.</param> |
|
703 |
<returns>The result of the operator.</returns> |
|
704 |
</member> |
|
705 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.Parent"> |
|
706 |
<summary> |
|
707 |
Retrieves the parent directory of the specified path, including both absolute and relative paths. |
|
708 |
</summary> |
|
709 |
<returns>The parent directory, or <see langword="null"/> if path is the root directory, including the root of a UNC server or share name.</returns> |
|
710 |
</member> |
|
711 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.SuffixedPath"> |
|
712 |
<summary> |
|
713 |
Gets the full normalized path, with a trailing backslash if the path denotes a directory. |
|
714 |
</summary> |
|
715 |
<value>The full normalized path, with a trailing backslash if the path denotes a directory.</value> |
|
716 |
<seealso cref="P:Alphaleonis.Win32.Filesystem.PathInfo.Path"/> |
|
717 |
</member> |
|
718 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.Path"> |
|
719 |
<summary> |
|
720 |
Gets the full normalized path. |
|
721 |
</summary> |
|
722 |
<value>The full path.</value> |
|
723 |
<seealso cref="P:Alphaleonis.Win32.Filesystem.PathInfo.SuffixedPath"/> |
|
724 |
</member> |
|
725 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.FileName"> |
|
726 |
<summary> |
|
727 |
Gets the file name part of the path. |
|
728 |
</summary> |
|
729 |
<value>The file name part of the path, or an empty string if the path does not contain a file name.</value> |
|
730 |
</member> |
|
731 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.Root"> |
|
732 |
<summary> |
|
733 |
Gets the root of the path. |
|
734 |
</summary> |
|
735 |
<value>The root of the path, which may be a drive (eg. "C:\"), a remote computer as part of |
|
736 |
an UNC path (eg. "\\OtherComputer\"), a unique volume name |
|
737 |
(eg. "\\?\Volume{c00fa7c5-63eb-11dd-b6ed-806e6f6e6963}\") or a single directory |
|
738 |
separator ("\") if no drive or volume is present in the path. If does not contain |
|
739 |
any root, an empty string is returned.</value> |
|
740 |
</member> |
|
741 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.IsRooted"> |
|
742 |
<summary> |
|
743 |
Gets a value indicating whether the path is rooted. |
|
744 |
</summary> |
|
745 |
<value><c>true</c> if this instance is rooted; otherwise, <c>false</c>.</value> |
|
746 |
</member> |
|
747 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.HasFileName"> |
|
748 |
<summary> |
|
749 |
Gets a value indicating whether this instance has file name. |
|
750 |
</summary> |
|
751 |
<value> |
|
752 |
<c>true</c> if this instance has file name; otherwise, <c>false</c>. |
|
753 |
</value> |
|
754 |
</member> |
|
755 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.Extension"> |
|
756 |
<summary> |
|
757 |
Gets the extension of the file name of this path. |
|
758 |
</summary> |
|
759 |
<value>The extension of the file name of this path, or an empty string if the path does |
|
760 |
not contain a file name or the file name does not have an extension.</value> |
|
761 |
</member> |
|
762 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.HasExtension"> |
|
763 |
<summary> |
|
764 |
Gets a value indicating whether the file name in this path has an extension. |
|
765 |
</summary> |
|
766 |
<value> |
|
767 |
<c>true</c> if the file name in this path has an extension; otherwise, <c>false</c>. |
|
768 |
</value> |
|
769 |
</member> |
|
770 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.FileNameWithoutExtension"> |
|
771 |
<summary> |
|
772 |
Gets the file name without extension. |
|
773 |
</summary> |
|
774 |
<value>The file name without extension or an empty string if the |
|
775 |
path does not contain a file name.</value> |
|
776 |
</member> |
|
777 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.SuffixedDirectoryName"> |
|
778 |
<summary> |
|
779 |
Returns the directory information for the path with a trailing directory separator. |
|
780 |
</summary> |
|
781 |
<value>The name of the suffixed directory with a trailing directory separator.</value> |
|
782 |
<seealso cref="P:Alphaleonis.Win32.Filesystem.PathInfo.DirectoryName"/> |
|
783 |
</member> |
|
784 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.SuffixedDirectoryNameWithoutRoot"> |
|
785 |
<summary> |
|
786 |
Returns the directory information for the path without the root information, and with a trailing backslash. |
|
787 |
</summary> |
|
788 |
<value>The path without the root and file name part (if any) and with a trailing backslash.</value> |
|
789 |
<seealso cref="P:Alphaleonis.Win32.Filesystem.PathInfo.DirectoryNameWithoutRoot"/> |
|
790 |
<seealso cref="P:Alphaleonis.Win32.Filesystem.PathInfo.DirectoryName"/> |
|
791 |
<seealso cref="P:Alphaleonis.Win32.Filesystem.PathInfo.SuffixedDirectoryName"/> |
|
792 |
</member> |
|
793 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.DirectoryName"> |
|
794 |
<summary> |
|
795 |
Returns the directory information for the path. |
|
796 |
</summary> |
|
797 |
<value>The path without the file name part (if any).</value> |
|
798 |
<seealso cref="P:Alphaleonis.Win32.Filesystem.PathInfo.SuffixedDirectoryName"/> |
|
799 |
</member> |
|
800 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.DirectoryNameWithoutRoot"> |
|
801 |
<summary> |
|
802 |
Returns the directory information for the path with the root stripped off. |
|
803 |
</summary> |
|
804 |
<value>The path without the root and file name part (if any).</value> |
|
805 |
</member> |
|
806 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.DirectoryComponents"> |
|
807 |
<summary> |
|
808 |
Gets a list exposing the individual components of the directory part of this path. |
|
809 |
</summary> |
|
810 |
<value>The directory components of this path.</value> |
|
811 |
</member> |
|
812 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.ComponentList.IndexOf(System.String)"> |
|
813 |
<summary> |
|
814 |
Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1"/>. |
|
815 |
</summary> |
|
816 |
<param name="item">The object to locate in the <see cref="T:System.Collections.Generic.IList`1"/>.</param> |
|
817 |
<returns> |
|
818 |
The index of <paramref name="item"/> if found in the list; otherwise, -1. |
|
819 |
</returns> |
|
820 |
</member> |
|
821 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.ComponentList.Insert(System.Int32,System.String)"> |
|
822 |
<summary> |
|
823 |
Inserts an item to the <see cref="T:System.Collections.Generic.IList`1"/> at the specified index. |
|
824 |
</summary> |
|
825 |
<param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param> |
|
826 |
<param name="item">The object to insert into the <see cref="T:System.Collections.Generic.IList`1"/>.</param> |
|
827 |
<exception cref="T:System.ArgumentOutOfRangeException"> |
|
828 |
<paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.</exception> |
|
829 |
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.IList`1"/> is read-only.</exception> |
|
830 |
</member> |
|
831 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.ComponentList.RemoveAt(System.Int32)"> |
|
832 |
<summary> |
|
833 |
Removes the <see cref="T:System.Collections.Generic.IList`1"/> item at the specified index. |
|
834 |
</summary> |
|
835 |
<param name="index">The zero-based index of the item to remove.</param> |
|
836 |
<exception cref="T:System.ArgumentOutOfRangeException"> |
|
837 |
<paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.</exception> |
|
838 |
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.IList`1"/> is read-only.</exception> |
|
839 |
</member> |
|
840 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.ComponentList.Add(System.String)"> |
|
841 |
<summary> |
|
842 |
Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1"/>. |
|
843 |
</summary> |
|
844 |
<param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param> |
|
845 |
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.</exception> |
|
846 |
</member> |
|
847 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.ComponentList.Clear"> |
|
848 |
<summary> |
|
849 |
Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1"/>. |
|
850 |
</summary> |
|
851 |
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only. </exception> |
|
852 |
</member> |
|
853 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.ComponentList.Contains(System.String)"> |
|
854 |
<summary> |
|
855 |
Determines whether the <see cref="T:System.Collections.Generic.ICollection`1"/> contains a specific value. |
|
856 |
</summary> |
|
857 |
<param name="item">The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param> |
|
858 |
<returns> |
|
859 |
true if <paramref name="item"/> is found in the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, false. |
|
860 |
</returns> |
|
861 |
</member> |
|
862 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.ComponentList.CopyTo(System.String[],System.Int32)"> |
|
863 |
<summary> |
|
864 |
Copies the elements of the <see cref="T:System.Collections.Generic.ICollection`1"/> to an <see cref="T:System.Array"/>, starting at a particular <see cref="T:System.Array"/> index. |
|
865 |
</summary> |
|
866 |
<param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from <see cref="T:System.Collections.Generic.ICollection`1"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param> |
|
867 |
<param name="arrayIndex">The zero-based index in <paramref name="array"/> at which copying begins.</param> |
|
868 |
<exception cref="T:System.ArgumentNullException"> |
|
869 |
<paramref name="array"/> is null.</exception> |
|
870 |
<exception cref="T:System.ArgumentOutOfRangeException"> |
|
871 |
<paramref name="arrayIndex"/> is less than 0.</exception> |
|
872 |
<exception cref="T:System.ArgumentException"> |
|
873 |
<paramref name="array"/> is multidimensional.-or-<paramref name="arrayIndex"/> is equal to or greater than the length of <paramref name="array"/>.-or-The number of elements in the source <see cref="T:System.Collections.Generic.ICollection`1"/> is greater than the available space from <paramref name="arrayIndex"/> to the end of the destination <paramref name="array"/>.</exception> |
|
874 |
</member> |
|
875 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.ComponentList.Remove(System.String)"> |
|
876 |
<summary> |
|
877 |
Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1"/>. |
|
878 |
</summary> |
|
879 |
<param name="item">The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param> |
|
880 |
<returns> |
|
881 |
true if <paramref name="item"/> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, false. This method also returns false if <paramref name="item"/> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1"/>. |
|
882 |
</returns> |
|
883 |
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.</exception> |
|
884 |
</member> |
|
885 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.ComponentList.GetEnumerator"> |
|
886 |
<summary> |
|
887 |
Returns an enumerator that iterates through the collection. |
|
888 |
</summary> |
|
889 |
<returns> |
|
890 |
A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection. |
|
891 |
</returns> |
|
892 |
</member> |
|
893 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.ComponentList.System#Collections#IEnumerable#GetEnumerator"> |
|
894 |
<summary> |
|
895 |
Returns an enumerator that iterates through a collection. |
|
896 |
</summary> |
|
897 |
<returns> |
|
898 |
An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection. |
|
899 |
</returns> |
|
900 |
</member> |
|
901 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.ComponentList.Item(System.Int32)"> |
|
902 |
<summary> |
|
903 |
Gets the <see cref="T:System.String"/> at the specified index. |
|
904 |
</summary> |
|
905 |
<value>The component of the directory at the specified index</value> |
|
906 |
<exception cref="T:System.ArgumentOutOfRangeException">If <paramref name="index"/> is out of range.</exception> |
|
907 |
</member> |
|
908 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.ComponentList.Count"> |
|
909 |
<summary> |
|
910 |
Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>. |
|
911 |
</summary> |
|
912 |
<value></value> |
|
913 |
<returns>The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.</returns> |
|
914 |
</member> |
|
915 |
<member name="P:Alphaleonis.Win32.Filesystem.PathInfo.ComponentList.IsReadOnly"> |
|
916 |
<summary> |
|
917 |
Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only. |
|
918 |
</summary> |
|
919 |
<value></value> |
|
920 |
<returns>true</returns> |
|
921 |
</member> |
|
922 |
<member name="M:Alphaleonis.Win32.Filesystem.PathInfo.Parser.ResolveParentReference"> |
|
923 |
<summary> |
|
924 |
Removes a reference to the parent directory ("..") if possible. |
|
925 |
This must be called *before* the reference to the parent directory has been |
|
926 |
added. |
|
927 |
</summary> |
|
928 |
<returns><c>true</c> if the reference was removed, and <c>false</c> if it was kept.</returns> |
|
929 |
</member> |
|
930 |
<member name="T:Alphaleonis.Win32.Filesystem.FileEncryptionStatus"> |
|
931 |
<summary> |
|
932 |
Represents the encryption status of the specified file. |
|
933 |
</summary> |
|
934 |
</member> |
|
935 |
<member name="F:Alphaleonis.Win32.Filesystem.FileEncryptionStatus.Encryptable"> |
|
936 |
<summary> |
|
937 |
The file can be encrypted. |
|
938 |
</summary> |
|
939 |
</member> |
|
940 |
<member name="F:Alphaleonis.Win32.Filesystem.FileEncryptionStatus.Encrypted"> |
|
941 |
<summary> |
|
942 |
The file is encrypted. |
|
943 |
</summary> |
|
944 |
</member> |
|
945 |
<member name="F:Alphaleonis.Win32.Filesystem.FileEncryptionStatus.ReadOnly"> |
|
946 |
<summary> |
|
947 |
The file is a read-only file. |
|
948 |
</summary> |
|
949 |
</member> |
|
950 |
<member name="F:Alphaleonis.Win32.Filesystem.FileEncryptionStatus.RootDir"> |
|
951 |
<summary> |
|
952 |
The file is a root directory. Root directories cannot be encrypted. |
|
953 |
</summary> |
|
954 |
</member> |
|
955 |
<member name="F:Alphaleonis.Win32.Filesystem.FileEncryptionStatus.SystemFile"> |
|
956 |
<summary> |
|
957 |
The file is a system file. System files cannot be encrypted. |
|
958 |
</summary> |
|
959 |
</member> |
|
960 |
<member name="F:Alphaleonis.Win32.Filesystem.FileEncryptionStatus.SystemDirectory"> |
|
961 |
<summary> |
|
962 |
The file is a system directory. System directories cannot be encrypted. |
|
963 |
</summary> |
|
964 |
</member> |
|
965 |
<member name="F:Alphaleonis.Win32.Filesystem.FileEncryptionStatus.NoFilesystemSupport"> |
|
966 |
<summary> |
|
967 |
The file system does not support file encryption. |
|
968 |
</summary> |
|
969 |
</member> |
|
970 |
<member name="F:Alphaleonis.Win32.Filesystem.FileEncryptionStatus.Unknown"> |
|
971 |
<summary> |
|
972 |
The encryption status is unknown. The file may be encrypted. |
|
973 |
</summary> |
|
974 |
</member> |
|
975 |
<member name="F:Alphaleonis.Win32.Filesystem.FileEncryptionStatus.UserDisallowed"> |
|
976 |
<summary> |
|
977 |
Reserved for future use. |
|
978 |
</summary> |
|
979 |
</member> |
|
980 |
<member name="T:Alphaleonis.Win32.Filesystem.DirectoryNotEmptyException"> |
|
981 |
<summary> |
|
982 |
The exception that is thrown when an attempt to create a directory or file that already exists was made. |
|
983 |
</summary> |
|
984 |
</member> |
|
985 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryNotEmptyException.#ctor"> |
|
986 |
<summary> |
|
987 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.DirectoryNotEmptyException"/> class. |
|
988 |
</summary> |
|
989 |
</member> |
|
990 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryNotEmptyException.#ctor(System.String)"> |
|
991 |
<summary> |
|
992 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.DirectoryNotEmptyException"/> class. |
|
993 |
</summary> |
|
994 |
<param name="message">The message.</param> |
|
995 |
</member> |
|
996 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryNotEmptyException.#ctor(System.String,System.Exception)"> |
|
997 |
<summary> |
|
998 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.DirectoryNotEmptyException"/> class. |
|
999 |
</summary> |
|
1000 |
<param name="message">The message.</param> |
|
1001 |
<param name="innerException">The inner exception.</param> |
|
1002 |
</member> |
|
1003 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryNotEmptyException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> |
|
1004 |
<summary> |
|
1005 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.DirectoryNotEmptyException"/> class. |
|
1006 |
</summary> |
|
1007 |
<param name="info">The data for serializing or deserializing the object.</param> |
|
1008 |
<param name="context">The source and destination for the object.</param> |
|
1009 |
</member> |
|
1010 |
<member name="T:Alphaleonis.Win32.Filesystem.DeviceNotReadyException"> |
|
1011 |
<summary> |
|
1012 |
The requested operation could not be completed because the device was not ready. |
|
1013 |
</summary> |
|
1014 |
</member> |
|
1015 |
<member name="M:Alphaleonis.Win32.Filesystem.DeviceNotReadyException.#ctor"> |
|
1016 |
<summary> |
|
1017 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.DeviceNotReadyException"/> class. |
|
1018 |
</summary> |
|
1019 |
</member> |
|
1020 |
<member name="M:Alphaleonis.Win32.Filesystem.DeviceNotReadyException.#ctor(System.String)"> |
|
1021 |
<summary> |
|
1022 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.DeviceNotReadyException"/> class. |
|
1023 |
</summary> |
|
1024 |
<param name="message">The message.</param> |
|
1025 |
</member> |
|
1026 |
<member name="M:Alphaleonis.Win32.Filesystem.DeviceNotReadyException.#ctor(System.String,System.Exception)"> |
|
1027 |
<summary> |
|
1028 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.DeviceNotReadyException"/> class. |
|
1029 |
</summary> |
|
1030 |
<param name="message">The message.</param> |
|
1031 |
<param name="innerException">The inner exception.</param> |
|
1032 |
</member> |
|
1033 |
<member name="M:Alphaleonis.Win32.Filesystem.DeviceNotReadyException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> |
|
1034 |
<summary> |
|
1035 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.DeviceNotReadyException"/> class. |
|
1036 |
</summary> |
|
1037 |
<param name="info">The data for serializing or deserializing the object.</param> |
|
1038 |
<param name="context">The source and destination for the object.</param> |
|
1039 |
</member> |
|
1040 |
<member name="T:Alphaleonis.Win32.Filesystem.TransactionException"> |
|
1041 |
<summary> |
|
1042 |
The exception that is thrown when an attempt to create a directory or file that already exists was made. |
|
1043 |
</summary> |
|
1044 |
</member> |
|
1045 |
<member name="M:Alphaleonis.Win32.Filesystem.TransactionException.#ctor"> |
|
1046 |
<summary> |
|
1047 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.TransactionException"/> class. |
|
1048 |
</summary> |
|
1049 |
</member> |
|
1050 |
<member name="M:Alphaleonis.Win32.Filesystem.TransactionException.#ctor(System.String)"> |
|
1051 |
<summary> |
|
1052 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.TransactionException"/> class. |
|
1053 |
</summary> |
|
1054 |
<param name="message">The message.</param> |
|
1055 |
</member> |
|
1056 |
<member name="M:Alphaleonis.Win32.Filesystem.TransactionException.#ctor(System.String,System.Exception)"> |
|
1057 |
<summary> |
|
1058 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.TransactionException"/> class. |
|
1059 |
</summary> |
|
1060 |
<param name="message">The message.</param> |
|
1061 |
<param name="innerException">The inner exception.</param> |
|
1062 |
</member> |
|
1063 |
<member name="M:Alphaleonis.Win32.Filesystem.TransactionException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> |
|
1064 |
<summary> |
|
1065 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.TransactionException"/> class. |
|
1066 |
</summary> |
|
1067 |
<param name="info">The data for serializing or deserializing the object.</param> |
|
1068 |
<param name="context">The source and destination for the object.</param> |
|
1069 |
</member> |
|
1070 |
<member name="T:Alphaleonis.Win32.Filesystem.TransactionAlreadyAbortedException"> |
|
1071 |
<summary> |
|
1072 |
It is too late to perform the requested operation, since the Transaction has already been aborted. |
|
1073 |
</summary> |
|
1074 |
</member> |
|
1075 |
<member name="M:Alphaleonis.Win32.Filesystem.TransactionAlreadyAbortedException.#ctor"> |
|
1076 |
<summary> |
|
1077 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.TransactionAlreadyAbortedException"/> class. |
|
1078 |
</summary> |
|
1079 |
</member> |
|
1080 |
<member name="M:Alphaleonis.Win32.Filesystem.TransactionAlreadyAbortedException.#ctor(System.String)"> |
|
1081 |
<summary> |
|
1082 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.TransactionAlreadyAbortedException"/> class. |
|
1083 |
</summary> |
|
1084 |
<param name="message">The message.</param> |
|
1085 |
</member> |
|
1086 |
<member name="M:Alphaleonis.Win32.Filesystem.TransactionAlreadyAbortedException.#ctor(System.String,System.Exception)"> |
|
1087 |
<summary> |
|
1088 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.TransactionAlreadyAbortedException"/> class. |
|
1089 |
</summary> |
|
1090 |
<param name="message">The message.</param> |
|
1091 |
<param name="innerException">The inner exception.</param> |
|
1092 |
</member> |
|
1093 |
<member name="M:Alphaleonis.Win32.Filesystem.TransactionAlreadyAbortedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> |
|
1094 |
<summary> |
|
1095 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.TransactionAlreadyAbortedException"/> class. |
|
1096 |
</summary> |
|
1097 |
<param name="info">The info.</param> |
|
1098 |
<param name="context">The context.</param> |
|
1099 |
</member> |
|
1100 |
<member name="T:Alphaleonis.Win32.Filesystem.TransactionalConflictException"> |
|
1101 |
<summary> |
|
1102 |
The function attempted to use a name that is reserved for use by another transaction. |
|
1103 |
</summary> |
|
1104 |
</member> |
|
1105 |
<member name="M:Alphaleonis.Win32.Filesystem.TransactionalConflictException.#ctor"> |
|
1106 |
<summary> |
|
1107 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.TransactionalConflictException"/> class. |
|
1108 |
</summary> |
|
1109 |
</member> |
|
1110 |
<member name="M:Alphaleonis.Win32.Filesystem.TransactionalConflictException.#ctor(System.String)"> |
|
1111 |
<summary> |
|
1112 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.TransactionalConflictException"/> class. |
|
1113 |
</summary> |
|
1114 |
<param name="message">The message.</param> |
|
1115 |
</member> |
|
1116 |
<member name="M:Alphaleonis.Win32.Filesystem.TransactionalConflictException.#ctor(System.String,System.Exception)"> |
|
1117 |
<summary> |
|
1118 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.TransactionalConflictException"/> class. |
|
1119 |
</summary> |
|
1120 |
<param name="message">The message.</param> |
|
1121 |
<param name="innerException">The inner exception.</param> |
|
1122 |
</member> |
|
1123 |
<member name="M:Alphaleonis.Win32.Filesystem.TransactionalConflictException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> |
|
1124 |
<summary> |
|
1125 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.TransactionalConflictException"/> class. |
|
1126 |
</summary> |
|
1127 |
<param name="info">The info.</param> |
|
1128 |
<param name="context">The context.</param> |
|
1129 |
</member> |
|
1130 |
<member name="T:Alphaleonis.Win32.Security.SafeLocalMemoryBufferHandle"> |
|
1131 |
<summary> |
|
1132 |
IntPtr wrapper which can be used as result of |
|
1133 |
Marshal.AllocHGlobal operation. |
|
1134 |
Calls Marshal.FreeHGlobal when disposed or finalized. |
|
1135 |
</summary> |
|
1136 |
</member> |
|
1137 |
<member name="M:Alphaleonis.Win32.Security.SafeLocalMemoryBufferHandle.#ctor"> |
|
1138 |
<summary> |
|
1139 |
Creates new instance with zero IntPtr |
|
1140 |
</summary> |
|
1141 |
</member> |
|
1142 |
<member name="M:Alphaleonis.Win32.Security.SafeLocalMemoryBufferHandle.CopyFrom(System.Byte[],System.Int32,System.Int32)"> |
|
1143 |
<summary> |
|
1144 |
Copies data from a one-dimensional, managed 8-bit unsigned integer array to the unmanaged memory pointer referenced by this instance- |
|
1145 |
</summary> |
|
1146 |
<param name="source">The one-dimensional array to copy from. </param> |
|
1147 |
<param name="startIndex">The zero-based index into the array where Copy should start.</param> |
|
1148 |
<param name="length">The number of array elements to copy.</param> |
|
1149 |
</member> |
|
1150 |
<member name="M:Alphaleonis.Win32.Security.SafeLocalMemoryBufferHandle.ReleaseHandle"> |
|
1151 |
<summary> |
|
1152 |
Called when object is disposed or finalized. |
|
1153 |
</summary> |
|
1154 |
</member> |
|
1155 |
<member name="T:Alphaleonis.Win32.Filesystem.ByHandleFileInfo"> |
|
1156 |
<summary> |
|
1157 |
Represents information retrieved by <see cref="M:Alphaleonis.Win32.Filesystem.File.GetFileInformationByHandle(System.IO.FileStream)"/>. |
|
1158 |
</summary> |
|
1159 |
</member> |
|
1160 |
<member name="P:Alphaleonis.Win32.Filesystem.ByHandleFileInfo.Attributes"> |
|
1161 |
<summary> |
|
1162 |
Gets the file attributes. |
|
1163 |
</summary> |
|
1164 |
<value>The file attributes.</value> |
|
1165 |
</member> |
|
1166 |
<member name="P:Alphaleonis.Win32.Filesystem.ByHandleFileInfo.CreationTime"> |
|
1167 |
<summary> |
|
1168 |
Gets a <see cref="T:System.DateTime"/> structure that specified when a file or directory was created. |
|
1169 |
</summary> |
|
1170 |
<value>A <see cref="T:System.DateTime"/> structure that specified when a file or directory was created.</value> |
|
1171 |
</member> |
|
1172 |
<member name="P:Alphaleonis.Win32.Filesystem.ByHandleFileInfo.LastAccessTime"> |
|
1173 |
<summary> |
|
1174 |
Gets a <see cref="T:System.DateTime"/> structure. |
|
1175 |
For a file, the structure specifies the last time that a file is read from or written to. |
|
1176 |
For a directory, the structure specifies when the directory is created. |
|
1177 |
For both files and directories, the specified date is correct, but the time of day is always set to midnight. |
|
1178 |
If the underlying file system does not support the last access time, this member is zero (0). |
|
1179 |
</summary> |
|
1180 |
<value>A <see cref="T:System.DateTime"/> structure that specified when a file was last written to or the directory created.</value> |
|
1181 |
</member> |
|
1182 |
<member name="P:Alphaleonis.Win32.Filesystem.ByHandleFileInfo.LastWriteTime"> |
|
1183 |
<summary> |
|
1184 |
Gets a <see cref="T:System.DateTime"/> structure. |
|
1185 |
For a file, the structure specifies the last time that a file is written to. |
|
1186 |
For a directory, the structure specifies when the directory is created. |
|
1187 |
If the underlying file system does not support the last access time, this member is zero (0). |
|
1188 |
</summary> |
|
1189 |
<value>A <see cref="T:System.DateTime"/> structure that specified when a file was last written to or the directory created.</value> |
|
1190 |
</member> |
|
1191 |
<member name="P:Alphaleonis.Win32.Filesystem.ByHandleFileInfo.VolumeSerialNumber"> |
|
1192 |
<summary> |
|
1193 |
Gets the the serial number of the volume that contains a file. |
|
1194 |
</summary> |
|
1195 |
<value>The serial number of the volume that contains a file.</value> |
|
1196 |
</member> |
|
1197 |
<member name="P:Alphaleonis.Win32.Filesystem.ByHandleFileInfo.FileSize"> |
|
1198 |
<summary> |
|
1199 |
Gets the size of the file. |
|
1200 |
</summary> |
|
1201 |
<value>The size of the file.</value> |
|
1202 |
</member> |
|
1203 |
<member name="P:Alphaleonis.Win32.Filesystem.ByHandleFileInfo.NumberOfLinks"> |
|
1204 |
<summary> |
|
1205 |
Gets the number of links to this file. For the FAT file system this member is always 1. For the NTFS file system, it can be more than 1. |
|
1206 |
</summary> |
|
1207 |
<value>The number of links to this file. </value> |
|
1208 |
</member> |
|
1209 |
<member name="P:Alphaleonis.Win32.Filesystem.ByHandleFileInfo.FileIndex"> |
|
1210 |
<summary> |
|
1211 |
Gets the unique identifier associated with the file. The identifier and the volume serial number uniquely identify a |
|
1212 |
file on a single computer. To determine whether two open handles represent the same file, combine the identifier |
|
1213 |
and the volume serial number for each file and compare them. |
|
1214 |
</summary> |
|
1215 |
<value>The unique identifier of the file.</value> |
|
1216 |
</member> |
|
1217 |
<member name="T:Alphaleonis.Win32.Filesystem.FileAccess"> |
|
1218 |
<summary> |
|
1219 |
<para>Defines constants for read, write, or read/write access to a file.</para> |
|
1220 |
<para>This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a bitwise combination of its member values.</para> |
|
1221 |
</summary> |
|
1222 |
</member> |
|
1223 |
<member name="F:Alphaleonis.Win32.Filesystem.FileAccess.None"> |
|
1224 |
<summary> |
|
1225 |
No access to the file. |
|
1226 |
</summary> |
|
1227 |
</member> |
|
1228 |
<member name="F:Alphaleonis.Win32.Filesystem.FileAccess.Read"> |
|
1229 |
<summary> |
|
1230 |
Read access to the file. Data can be read from the file. Combine with Write for read/write access. |
|
1231 |
</summary> |
|
1232 |
</member> |
|
1233 |
<member name="F:Alphaleonis.Win32.Filesystem.FileAccess.Write"> |
|
1234 |
<summary> |
|
1235 |
Write access to the file. Data can be written to the file. Combine with Read for read/write access. |
|
1236 |
</summary> |
|
1237 |
</member> |
|
1238 |
<member name="F:Alphaleonis.Win32.Filesystem.FileAccess.ReadWrite"> |
|
1239 |
<summary> |
|
1240 |
Read and write access to the file. Data can be written to and read from the file. |
|
1241 |
</summary> |
|
1242 |
</member> |
|
1243 |
<member name="T:Alphaleonis.Win32.Filesystem.SafeFindFileHandle"> |
|
1244 |
<summary> |
|
1245 |
Represents a wrapper class for a handle used by the FindFirstFile/FindNextFile methods of the Win32 API |
|
1246 |
</summary> |
|
1247 |
</member> |
|
1248 |
<member name="M:Alphaleonis.Win32.Filesystem.SafeFindFileHandle.#ctor"> |
|
1249 |
<summary> |
|
1250 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.SafeFindFileHandle"/> class. |
|
1251 |
</summary> |
|
1252 |
</member> |
|
1253 |
<member name="M:Alphaleonis.Win32.Filesystem.SafeFindFileHandle.#ctor(System.IntPtr,System.Boolean)"> |
|
1254 |
<summary> |
|
1255 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.SafeFindFileHandle"/> class. |
|
1256 |
</summary> |
|
1257 |
<param name="handle">The handle.</param> |
|
1258 |
<param name="ownsHandle">if set to <c>true</c> [owns handle].</param> |
|
1259 |
</member> |
|
1260 |
<member name="M:Alphaleonis.Win32.Filesystem.SafeFindFileHandle.ReleaseHandle"> |
|
1261 |
<summary> |
|
1262 |
When overridden in a derived class, executes the code required to free the handle. |
|
1263 |
</summary> |
|
1264 |
<returns> |
|
1265 |
true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it generates a ReleaseHandleFailed Managed Debugging Assistant. |
|
1266 |
</returns> |
|
1267 |
</member> |
|
1268 |
<member name="T:Alphaleonis.Win32.Filesystem.DirectoryInfo"> |
|
1269 |
<summary> |
|
1270 |
Exposes instance methods for creating, moving, and enumerating through directories and subdirectories. This class cannot be inherited. |
|
1271 |
</summary> |
|
1272 |
</member> |
|
1273 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.#ctor(System.String)"> |
|
1274 |
<summary> |
|
1275 |
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Filesystem.DirectoryInfo"/> class on the specified dirPath. |
|
1276 |
</summary> |
|
1277 |
<param name="dirPath">A string specifying the path on which to create the DirectoryInfo.</param> |
|
1278 |
</member> |
|
1279 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.Refresh"> |
|
1280 |
<summary> |
|
1281 |
Refreshes the state of the object. |
|
1282 |
</summary> |
|
1283 |
<remarks> |
|
1284 |
FileSystemInfo.Refresh takes a snapshot of the file from the current file system. Refresh cannot correct the underlying file system even if the file system returns incorrect or outdated information. This can happen on platforms such as Windows 98. |
|
1285 |
Calls must be made to Refresh before attempting to get the attribute information, or the information will be outdated. |
|
1286 |
</remarks> |
|
1287 |
</member> |
|
1288 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.Delete"> |
|
1289 |
<summary> |
|
1290 |
Deletes a file or directory. |
|
1291 |
</summary> |
|
1292 |
</member> |
|
1293 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.Delete(System.Boolean)"> |
|
1294 |
<summary> |
|
1295 |
Deletes this instance of a DirectoryInfo, specifying whether to delete subdirectories and files. |
|
1296 |
</summary> |
|
1297 |
<param name="recursive"><c>true</c> to remove directories, subdirectories, and files in path; otherwise, <c>false</c>.</param> |
|
1298 |
<remarks> |
|
1299 |
If the DirectoryInfo has no files or subdirectories, this method deletes the DirectoryInfo even if recursive is false. Attempting to delete a DirectoryInfo that is not empty when recursive is false throws an IOException. |
|
1300 |
For a list of common I/O tasks, see Common I/O Tasks. |
|
1301 |
</remarks> |
|
1302 |
</member> |
|
1303 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.Delete(System.Boolean,System.Boolean)"> |
|
1304 |
<summary> |
|
1305 |
Deletes this instance of a DirectoryInfo, specifying whether to delete subdirectories and files. |
|
1306 |
</summary> |
|
1307 |
<param name="recursive"><c>true</c> to remove directories, subdirectories, and files in path; otherwise, <c>false</c>.</param> |
|
1308 |
<param name="ignoreReadOnly">if set to <c>true</c> ignores read only attribute of files and directories.</param> |
|
1309 |
<remarks> |
|
1310 |
If the DirectoryInfo has no files or subdirectories, this method deletes the DirectoryInfo even if recursive is false. Attempting to delete a DirectoryInfo that is not empty when recursive is false throws an IOException. |
|
1311 |
For a list of common I/O tasks, see Common I/O Tasks. |
|
1312 |
</remarks> |
|
1313 |
</member> |
|
1314 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.ToString"> |
|
1315 |
<summary> |
|
1316 |
Returns the original path that was passed by the user. |
|
1317 |
</summary> |
|
1318 |
<returns>Returns the original path that was passed by the user.</returns> |
|
1319 |
</member> |
|
1320 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.GetAccessControl"> |
|
1321 |
<summary> |
|
1322 |
Gets a DirectorySecurity object that encapsulates the access control list (ACL) entries for the directory described by the current DirectoryInfo object. |
|
1323 |
</summary> |
|
1324 |
<returns>A DirectorySecurity object that encapsulates the access control rules for the directory.</returns> |
|
1325 |
</member> |
|
1326 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.GetAccessControl(System.Security.AccessControl.AccessControlSections)"> |
|
1327 |
<summary> |
|
1328 |
Gets a DirectorySecurity object that encapsulates the specified type of access control list (ACL) entries for the directory described by the current DirectoryInfo object. |
|
1329 |
</summary> |
|
1330 |
<param name="includeSections">One of the AccessControlSections values that specifies the type of access control list (ACL) information to receive.</param> |
|
1331 |
<returns>A DirectorySecurity object that encapsulates the access control rules for the file described by the path parameter.</returns> |
|
1332 |
</member> |
|
1333 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.SetAccessControl(System.Security.AccessControl.DirectorySecurity)"> |
|
1334 |
<summary> |
|
1335 |
Applies access control list (ACL) entries described by a DirectorySecurity object to the directory described by the current DirectoryInfo object. |
|
1336 |
</summary> |
|
1337 |
<param name="directorySecurity">A DirectorySecurity object that describes an ACL entry to apply to the directory described by the path parameter.</param> |
|
1338 |
</member> |
|
1339 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.GetDirectories"> |
|
1340 |
<summary> |
|
1341 |
Returns the subdirectories of the current directory. |
|
1342 |
</summary> |
|
1343 |
<returns>An array of DirectoryInfo objects.</returns> |
|
1344 |
<remarks>If there are no subdirectories, this method returns an empty array. This method is not recursive.</remarks> |
|
1345 |
</member> |
|
1346 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.GetDirectories(System.String)"> |
|
1347 |
<summary> |
|
1348 |
Returns an array of directories in the current DirectoryInfo matching the given search criteria. |
|
1349 |
</summary> |
|
1350 |
<param name="searchPattern">The search string, such as "System*", used to search for all directories beginning with the word "System".</param> |
|
1351 |
<returns>An array of type DirectoryInfo matching searchPattern.</returns> |
|
1352 |
<remarks> |
|
1353 |
Wildcards are permitted. For example, the searchPattern string "*t" searches for all directory names in path ending with the letter "t". The searchPattern string "s*" searches for all directory names in path beginning with the letter "s". |
|
1354 |
The string ".." can only be used in searchPattern if it is specified as a part of a valid directory name, such as in the directory name "a..b". It cannot be used to move up the directory hierarchy. |
|
1355 |
If there are no subdirectories, or no subdirectories match the searchPattern parameter, this method returns an empty array. |
|
1356 |
For a list of common I/O tasks, see Common I/O Tasks. |
|
1357 |
</remarks> |
|
1358 |
</member> |
|
1359 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.GetDirectories(System.String,System.IO.SearchOption)"> |
|
1360 |
<summary> |
|
1361 |
Returns an array of directories in the current DirectoryInfo matching the given search criteria and using a value to determine whether to search subdirectories. |
|
1362 |
</summary> |
|
1363 |
<param name="searchPattern">The search string, such as "System*", used to search for all directories beginning with the word "System".</param> |
|
1364 |
<param name="searchOption">One of the values of the SearchOption enumeration that specifies whether the search operation should include only the current directory or should include all subdirectories.</param> |
|
1365 |
<returns> |
|
1366 |
An array of type DirectoryInfo matching searchPattern. |
|
1367 |
</returns> |
|
1368 |
<remarks> |
|
1369 |
Wildcards are permitted. For example, the searchPattern string "*t" searches for all directory names in path ending with the letter "t". The searchPattern string "s*" searches for all directory names in path beginning with the letter "s". |
|
1370 |
The string ".." can only be used in searchPattern if it is specified as a part of a valid directory name, such as in the directory name "a..b". It cannot be used to move up the directory hierarchy. |
|
1371 |
If there are no subdirectories, or no subdirectories match the searchPattern parameter, this method returns an empty array. |
|
1372 |
For a list of common I/O tasks, see Common I/O Tasks. |
|
1373 |
</remarks> |
|
1374 |
</member> |
|
1375 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.GetFiles"> |
|
1376 |
<summary> |
|
1377 |
Returns a file list from the current directory. |
|
1378 |
</summary> |
|
1379 |
<returns>An array of type FileInfo.</returns> |
|
1380 |
</member> |
|
1381 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.GetFiles(System.String)"> |
|
1382 |
<summary> |
|
1383 |
Returns a file list from the current directory matching the given searchPattern. |
|
1384 |
</summary> |
|
1385 |
<param name="searchPattern">The search string, such as "*.txt".</param> |
|
1386 |
<returns>An array of type FileInfo.</returns> |
|
1387 |
</member> |
|
1388 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.GetFiles(System.String,System.IO.SearchOption)"> |
|
1389 |
<summary> |
|
1390 |
Returns a file list from the current directory matching the given searchPattern and using a value to determine whether to search subdirectories. |
|
1391 |
</summary> |
|
1392 |
<param name="searchPattern">The search string, such as "System*", used to search for all directories beginning with the word "System".</param> |
|
1393 |
<param name="searchOption">One of the values of the SearchOption enumeration that specifies whether the search operation should include only the current directory or should include all subdirectories.</param> |
|
1394 |
<returns>An array of type FileInfo.</returns> |
|
1395 |
<remarks> |
|
1396 |
The following wildcard specifiers are permitted in searchPattern: "*" and "?". |
|
1397 |
The order of the returned file names is not guaranteed; use the Sort()()() method if a specific sort order is required. |
|
1398 |
Wildcards are permitted. For example, the searchPattern string "*.txt" searches for all file names having an extension of "txt". |
|
1399 |
The searchPattern string "s*" searches for all file names beginning with the letter "s". If there are no files, or no files that match the searchPattern string in the DirectoryInfo, this method returns an empty array. |
|
1400 |
</remarks> |
|
1401 |
</member> |
|
1402 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.GetFileSystemInfos"> |
|
1403 |
<summary> |
|
1404 |
Returns an array of strongly typed FileSystemInfo entries representing all the files and subdirectories in a directory. |
|
1405 |
</summary> |
|
1406 |
<returns>An array of strongly typed FileSystemInfo entries.</returns> |
|
1407 |
<remarks> |
|
1408 |
This method is not recursive. |
|
1409 |
For subdirectories, the FileSystemInfo objects returned by this method can be cast to the derived class DirectoryInfo. Use the FileAttributes value returned by the FileSystemInfo.Attributes property to determine whether the FileSystemInfo represents a file or a directory. |
|
1410 |
Wild cards are permitted. For example, the searchPattern string "*t" searches for all directory names in path ending with the letter "t". The searchPattern string "s*" searches for all directory names in path beginning with the letter "s". |
|
1411 |
The string ".." can only be used in searchPattern if it is specified as a part of a valid directory name, such as in the directory name "a..b". It cannot be used to move up the directory hierarchy. If there are no files or directories, or no files or directories that match the searchPattern string in the DirectoryInfo, this method returns an empty array. |
|
1412 |
For a list of common I/O tasks, see Common I/O Tasks. |
|
1413 |
</remarks> |
|
1414 |
</member> |
|
1415 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.GetFileSystemInfos(System.String)"> |
|
1416 |
<summary> |
|
1417 |
Retrieves an array of strongly typed FileSystemInfo objects representing the files and subdirectories matching the specified search criteria. |
|
1418 |
</summary> |
|
1419 |
<param name="searchPattern">The search string, such as "System*", used to search for all directories beginning with the word "System".</param> |
|
1420 |
<returns>An array of strongly typed FileSystemInfo objects matching the search criteria.</returns> |
|
1421 |
<remarks> |
|
1422 |
This method is not recursive. |
|
1423 |
For subdirectories, the FileSystemInfo objects returned by this method can be cast to the derived class DirectoryInfo. Use the FileAttributes value returned by the FileSystemInfo.Attributes property to determine whether the FileSystemInfo represents a file or a directory. |
|
1424 |
Wild cards are permitted. For example, the searchPattern string "*t" searches for all directory names in path ending with the letter "t". The searchPattern string "s*" searches for all directory names in path beginning with the letter "s". |
|
1425 |
The string ".." can only be used in searchPattern if it is specified as a part of a valid directory name, such as in the directory name "a..b". It cannot be used to move up the directory hierarchy. If there are no files or directories, or no files or directories that match the searchPattern string in the DirectoryInfo, this method returns an empty array. |
|
1426 |
For a list of common I/O tasks, see Common I/O Tasks. |
|
1427 |
</remarks> |
|
1428 |
</member> |
|
1429 |
<member name="M:Alphaleonis.Win32.Filesystem.DirectoryInfo.MoveTo(System.String)"> |
|
1430 |
<summary> |
|
1431 |
Moves a DirectoryInfo instance and its contents to a new path. |
|
1432 |
</summary> |
|
1433 |
<param name="destDirName">The name and path to which to move this directory. |
|
1434 |
The destination cannot be directory with the identical name. It can be an existing directory to which you want to add this directory as a subdirectory.</param> |
|
1435 |
<remarks> |
|
1436 |
This method throws an IOException if, for example, you try to move c:\mydir to c:\public, and c:\public already exists. You must specify "c:\\public\\mydir" as the destDirName parameter, or specify a new directory name such as "c:\\newdir". |
|
1437 |
This method permits moving a directory to a read-only directory. The read/write attribute of neither directory is affected. |
|
1438 |
For a list of common I/O tasks, see Common I/O Tasks. |
|
1439 |
</remarks> |
|
1440 |
</member> |
|
1441 |
<member name="P:Alphaleonis.Win32.Filesystem.DirectoryInfo.Exists"> |
|
1442 |
<summary> |
|
1443 |
Gets a value indicating whether the file or directory exists. |
|
1444 |
</summary> |
|
1445 |
<value><c>true</c> if the file exists; otherwise, <c>false</c>.</value> |
|
1446 |
</member> |
|
1447 |
<member name="P:Alphaleonis.Win32.Filesystem.DirectoryInfo.Name"> |
|
1448 |
<summary> |
|
1449 |
Gets the name of the last directory in the hierarchy if a hierarchy exists. Otherwise, the Name property gets the name of the directory. |
|
1450 |
</summary> |
|
1451 |
<value></value> |
|
1452 |
<remarks> |
|
1453 |
For a directory, Name returns only the name of the parent directory, such as Dir, not c:\Dir. For a subdirectory, Name returns only the name of the subdirectory, such as Sub1, not c:\Dir\Sub1. |
|
1454 |
</remarks> |
|
1455 |
</member> |
|
1456 |
<member name="P:Alphaleonis.Win32.Filesystem.DirectoryInfo.Parent"> |
|
1457 |
<summary> |
|
1458 |
Gets the parent directory of a specified subdirectory. |
|
1459 |
</summary> |
|
1460 |
<value>The parent directory, or nullNothingnullptra null reference (Nothing in Visual Basic) if the path is null or if the file path denotes a root (such as "\", "C:", or * "\\server\share").</value> |
|
1461 |
</member> |
|
1462 |
<member name="P:Alphaleonis.Win32.Filesystem.DirectoryInfo.Root"> |
|
1463 |
<summary> |
|
1464 |
Gets the root portion of a path. |
|
1465 |
</summary> |
|
1466 |
<value>A DirectoryInfo object representing the root of a path.</value> |
|
1467 |
</member> |
|
1468 |
<member name="T:Alphaleonis.Win32.Filesystem.CopyProgressRoutine"> |
|
1469 |
<summary> |
|
1470 |
Callback used by MoveFile and CopyFile to report progress about the |
|
1471 |
operation. |
|
1472 |
</summary> |
|
1473 |
</member> |
|
1474 |
<member name="F:Alphaleonis.Win32.Win32Errors.ERROR_TRANSACTION_NOT_ACTIVE"> |
|
1475 |
<summary> |
|
1476 |
The requested operation was made in the context of a transaction that is no longer active. |
|
1477 |
</summary> |
|
1478 |
</member> |
|
1479 |
<member name="F:Alphaleonis.Win32.Win32Errors.ERROR_TRANSACTION_REQUEST_NOT_VALID"> |
|
1480 |
<summary> |
|
1481 |
The requested operation is not valid on the Transaction object in its current state. |
|
1482 |
</summary> |
|
1483 |
</member> |
|
1484 |
<member name="F:Alphaleonis.Win32.Win32Errors.ERROR_TRANSACTIONAL_CONFLICT"> |
|
1485 |
<summary> |
|
1486 |
The function attempted to use a name that is reserved for use by another transaction. |
|
1487 |
</summary> |
|
1488 |
</member> |
|
1489 |
<member name="F:Alphaleonis.Win32.Win32Errors.ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE"> |
Also available in: Unified diff