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