-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Expand file tree
/
Copy pathDownloadStringCompletedEventArgs.xml
More file actions
133 lines (119 loc) · 7.38 KB
/
DownloadStringCompletedEventArgs.xml
File metadata and controls
133 lines (119 loc) · 7.38 KB
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
<Type Name="DownloadStringCompletedEventArgs" FullName="System.Net.DownloadStringCompletedEventArgs">
<TypeSignature Language="C#" Value="public class DownloadStringCompletedEventArgs : System.ComponentModel.AsyncCompletedEventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DownloadStringCompletedEventArgs extends System.ComponentModel.AsyncCompletedEventArgs" />
<TypeSignature Language="DocId" Value="T:System.Net.DownloadStringCompletedEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Class DownloadStringCompletedEventArgs
Inherits AsyncCompletedEventArgs" />
<TypeSignature Language="F#" Value="type DownloadStringCompletedEventArgs = class
 inherit AsyncCompletedEventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class DownloadStringCompletedEventArgs : System::ComponentModel::AsyncCompletedEventArgs" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Net.WebClient</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeForwardingChain>
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.WebClient" ToVersion="10.0.0.0" FrameworkAlternate="net-10.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.WebClient" ToVersion="11.0.0.0" FrameworkAlternate="net-11.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.WebClient" ToVersion="5.0.0.0" FrameworkAlternate="net-5.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.WebClient" ToVersion="6.0.0.0" FrameworkAlternate="net-6.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.WebClient" ToVersion="7.0.0.0" FrameworkAlternate="net-7.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.WebClient" ToVersion="8.0.0.0" FrameworkAlternate="net-8.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.WebClient" ToVersion="9.0.0.0" FrameworkAlternate="net-9.0" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.ComponentModel.AsyncCompletedEventArgs</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-10.0;net-11.0;net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Provides data for the <see cref="E:System.Net.WebClient.DownloadStringCompleted" /> event.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Instances of this class are passed to the <xref:System.Net.DownloadStringCompletedEventHandler>.
## Examples
The following code example demonstrates downloading a string asynchronously.
:::code language="csharp" source="~/snippets/csharp/System.Net/DownloadDataCompletedEventArgs/Overview/asyncmethods.cs" id="Snippet28":::
:::code language="vb" source="~/snippets/visualbasic/System.Net/DownloadDataCompletedEventArgs/Overview/asyncmethods.vb" id="Snippet28":::
The following method is called when the download completes.
:::code language="csharp" source="~/snippets/csharp/System.Net/DownloadDataCompletedEventArgs/Overview/asyncmethods.cs" id="Snippet29":::
:::code language="vb" source="~/snippets/visualbasic/System.Net/DownloadDataCompletedEventArgs/Overview/asyncmethods.vb" id="Snippet29":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Result">
<MemberSignature Language="C#" Value="public string Result { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Result" />
<MemberSignature Language="DocId" Value="P:System.Net.DownloadStringCompletedEventArgs.Result" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Result As String" />
<MemberSignature Language="F#" Value="member this.Result : string" Usage="System.Net.DownloadStringCompletedEventArgs.Result" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Result { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Net.WebClient</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the data that is downloaded by a <see cref="Overload:System.Net.WebClient.DownloadStringAsync" /> method.</summary>
<value>A <see cref="T:System.String" /> that contains the downloaded data.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
You should check the <xref:System.ComponentModel.AsyncCompletedEventArgs.Error*> and <xref:System.ComponentModel.AsyncCompletedEventArgs.Cancelled*> properties before using the data that is returned by this property. If the <xref:System.ComponentModel.AsyncCompletedEventArgs.Error> property's value is an <xref:System.Exception> object or the <xref:System.ComponentModel.AsyncCompletedEventArgs.Cancelled> property's value is `true`, the asynchronous operation did not complete correctly and the <xref:System.Net.DownloadDataCompletedEventArgs.Result> property's value will not be valid.
## Examples
The following code example displays the value of this property.
:::code language="csharp" source="~/snippets/csharp/System.Net/DownloadDataCompletedEventArgs/Overview/asyncmethods.cs" id="Snippet29":::
:::code language="vb" source="~/snippets/visualbasic/System.Net/DownloadDataCompletedEventArgs/Overview/asyncmethods.vb" id="Snippet29":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>