Release 4.0.0-preview1-00304
[platform/core/csapi/tizenfx.git] / pkg / build / tizen40 / ref / System.IO.FileSystem.DriveInfo.xml
1 <?xml version="1.0" encoding="utf-8"?><span>
2 <doc>
3   <assembly>
4     <name>System.IO.FileSystem.DriveInfo</name>
5   </assembly>
6   <members>
7     <member name="T:System.IO.DriveInfo">
8       <summary>Provides access to information on a drive.</summary>
9     </member>
10     <member name="M:System.IO.DriveInfo.#ctor(System.String)">
11       <summary>Provides access to information on the specified drive.</summary>
12       <param name="driveName">A valid drive path or drive letter. This can be either uppercase or lowercase, 'a' to 'z'. A null value is not valid.</param>
13       <exception cref="T:System.ArgumentNullException">The drive letter cannot be null.</exception>
14       <exception cref="T:System.ArgumentException">The first letter of <paramref name="driveName">driveName</paramref> is not an uppercase or lowercase letter from 'a' to 'z'.   -or-  <paramref name="driveName">driveName</paramref> does not refer to a valid drive.</exception>
15     </member>
16     <member name="P:System.IO.DriveInfo.AvailableFreeSpace">
17       <summary>Indicates the amount of available free space on a drive, in bytes.</summary>
18       <returns>The amount of free space available on the drive, in bytes.</returns>
19       <exception cref="T:System.UnauthorizedAccessException">Access to the drive information is denied.</exception>
20       <exception cref="T:System.IO.IOException">An I/O error occurred (for example, a disk error or a drive was not ready).</exception>
21     </member>
22     <member name="P:System.IO.DriveInfo.DriveFormat">
23       <summary>Gets the name of the file system, such as NTFS or FAT32.</summary>
24       <returns>The name of the file system on the specified drive.</returns>
25       <exception cref="T:System.UnauthorizedAccessException">Access to the drive information is denied.</exception>
26       <exception cref="T:System.IO.DriveNotFoundException">The drive does not exist or is not mapped.</exception>
27       <exception cref="T:System.IO.IOException">An I/O error occurred (for example, a disk error or a drive was not ready).</exception>
28     </member>
29     <member name="P:System.IO.DriveInfo.DriveType">
30       <summary>Gets the drive type, such as CD-ROM, removable, network, or fixed.</summary>
31       <returns>One of the enumeration values that specifies a drive type.</returns>
32     </member>
33     <member name="M:System.IO.DriveInfo.GetDrives">
34       <summary>Retrieves the drive names of all logical drives on a computer.</summary>
35       <returns>An array of type <see cref="T:System.IO.DriveInfo"></see> that represents the logical drives on a computer.</returns>
36       <exception cref="T:System.IO.IOException">An I/O error occurred (for example, a disk error or a drive was not ready).</exception>
37       <exception cref="T:System.UnauthorizedAccessException">The caller does not have the required permission.</exception>
38     </member>
39     <member name="P:System.IO.DriveInfo.IsReady">
40       <summary>Gets a value that indicates whether a drive is ready.</summary>
41       <returns>true if the drive is ready; false if the drive is not ready.</returns>
42     </member>
43     <member name="P:System.IO.DriveInfo.Name">
44       <summary>Gets the name of a drive, such as C:\.</summary>
45       <returns>The name of the drive.</returns>
46     </member>
47     <member name="P:System.IO.DriveInfo.RootDirectory">
48       <summary>Gets the root directory of a drive.</summary>
49       <returns>An object that contains the root directory of the drive.</returns>
50     </member>
51     <member name="M:System.IO.DriveInfo.ToString">
52       <summary>Returns a drive name as a string.</summary>
53       <returns>The name of the drive.</returns>
54     </member>
55     <member name="P:System.IO.DriveInfo.TotalFreeSpace">
56       <summary>Gets the total amount of free space available on a drive, in bytes.</summary>
57       <returns>The total free space available on a drive, in bytes.</returns>
58       <exception cref="T:System.UnauthorizedAccessException">Access to the drive information is denied.</exception>
59       <exception cref="T:System.IO.DriveNotFoundException">The drive is not mapped or does not exist.</exception>
60       <exception cref="T:System.IO.IOException">An I/O error occurred (for example, a disk error or a drive was not ready).</exception>
61     </member>
62     <member name="P:System.IO.DriveInfo.TotalSize">
63       <summary>Gets the total size of storage space on a drive, in bytes.</summary>
64       <returns>The total size of the drive, in bytes.</returns>
65       <exception cref="T:System.UnauthorizedAccessException">Access to the drive information is denied.</exception>
66       <exception cref="T:System.IO.DriveNotFoundException">The drive is not mapped or does not exist.</exception>
67       <exception cref="T:System.IO.IOException">An I/O error occurred (for example, a disk error or a drive was not ready).</exception>
68     </member>
69     <member name="P:System.IO.DriveInfo.VolumeLabel">
70       <summary>Gets or sets the volume label of a drive.</summary>
71       <returns>The volume label.</returns>
72       <exception cref="T:System.IO.IOException">An I/O error occurred (for example, a disk error or a drive was not ready).</exception>
73       <exception cref="T:System.IO.DriveNotFoundException">The drive is not mapped or does not exist.</exception>
74       <exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
75       <exception cref="T:System.UnauthorizedAccessException">The volume label is being set on a network or CD-ROM drive.   -or-   Access to the drive information is denied.</exception>
76     </member>
77     <member name="M:System.IO.DriveInfo.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
78       <summary>Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"></see> object with the data needed to serialize the target object.</summary>
79       <param name="info">The object to populate with data.</param>
80       <param name="context">The destination (see <see cref="T:System.Runtime.Serialization.StreamingContext"></see>) for this serialization.</param>
81     </member>
82     <member name="T:System.IO.DriveNotFoundException">
83       <summary>The exception that is thrown when trying to access a drive or share that is not available.</summary>
84     </member>
85     <member name="M:System.IO.DriveNotFoundException.#ctor">
86       <summary>Initializes a new instance of the <see cref="T:System.IO.DriveNotFoundException"></see> class with its message string set to a system-supplied message and its HRESULT set to COR_E_DIRECTORYNOTFOUND.</summary>
87     </member>
88     <member name="M:System.IO.DriveNotFoundException.#ctor(System.String)">
89       <summary>Initializes a new instance of the <see cref="T:System.IO.DriveNotFoundException"></see> class with the specified message string and the HRESULT set to COR_E_DIRECTORYNOTFOUND.</summary>
90       <param name="message">A <see cref="T:System.String"></see> object that describes the error. The caller of this constructor is required to ensure that this string has been localized for the current system culture.</param>
91     </member>
92     <member name="M:System.IO.DriveNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
93       <summary>Initializes a new instance of the <see cref="T:System.IO.DriveNotFoundException"></see> class with the specified serialization and context information.</summary>
94       <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"></see> object that contains the serialized object data about the exception being thrown.</param>
95       <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"></see> object that contains contextual information about the source or destination of the exception being thrown.</param>
96     </member>
97     <member name="M:System.IO.DriveNotFoundException.#ctor(System.String,System.Exception)">
98       <summary>Initializes a new instance of the <see cref="T:System.IO.DriveNotFoundException"></see> class with the specified error message and a reference to the inner exception that is the cause of this exception.</summary>
99       <param name="message">The error message that explains the reason for the exception.</param>
100       <param name="innerException">The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.</param>
101     </member>
102     <member name="T:System.IO.DriveType">
103       <summary>Defines constants for drive types, including CDRom, Fixed, Network, NoRootDirectory, Ram, Removable, and Unknown.</summary>
104     </member>
105     <member name="F:System.IO.DriveType.CDRom">
106       <summary>The drive is an optical disc device, such as a CD or DVD-ROM.</summary>
107       <returns></returns>
108     </member>
109     <member name="F:System.IO.DriveType.Fixed">
110       <summary>The drive is a fixed disk.</summary>
111       <returns></returns>
112     </member>
113     <member name="F:System.IO.DriveType.Network">
114       <summary>The drive is a network drive.</summary>
115       <returns></returns>
116     </member>
117     <member name="F:System.IO.DriveType.NoRootDirectory">
118       <summary>The drive does not have a root directory.</summary>
119       <returns></returns>
120     </member>
121     <member name="F:System.IO.DriveType.Ram">
122       <summary>The drive is a RAM disk.</summary>
123       <returns></returns>
124     </member>
125     <member name="F:System.IO.DriveType.Removable">
126       <summary>The drive is a removable storage device, such as a floppy disk drive or a USB flash drive.</summary>
127       <returns></returns>
128     </member>
129     <member name="F:System.IO.DriveType.Unknown">
130       <summary>The type of drive is unknown.</summary>
131       <returns></returns>
132     </member>
133   </members>
134 </doc></span>