/
SoapMethodAttribute.xml
294 lines (261 loc) · 18.1 KB
/
SoapMethodAttribute.xml
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
<Type Name="SoapMethodAttribute" FullName="System.Runtime.Remoting.Metadata.SoapMethodAttribute">
<TypeSignature Language="C#" Value="public sealed class SoapMethodAttribute : System.Runtime.Remoting.Metadata.SoapAttribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SoapMethodAttribute extends System.Runtime.Remoting.Metadata.SoapAttribute" />
<TypeSignature Language="DocId" Value="T:System.Runtime.Remoting.Metadata.SoapMethodAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class SoapMethodAttribute
Inherits SoapAttribute" />
<TypeSignature Language="F#" Value="type SoapMethodAttribute = class
 inherit SoapAttribute" />
<TypeSignature Language="C++ CLI" Value="public ref class SoapMethodAttribute sealed : System::Runtime::Remoting::Metadata::SoapAttribute" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Runtime.Remoting.Metadata.SoapAttribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Method)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Method)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Runtime.InteropServices.ComVisible(true)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.ComVisible(true)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Customizes SOAP generation and processing for a method. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The target objects for the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute> attribute are methods that can be remotely invoked. Apply the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute> to customize SOAP generation and processing. Properties of this attribute allow the programmer to customize the SOAPAction HTTP header field to indicate the intent of the SOAP HTTP request.
## Examples
The following code example shows how to use the members in the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute> class to customize SOAP generation and processing for a method.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/System.Runtime.Remoting.Metadata.SoapMethodAttribute/CPP/demo.cpp" id="Snippet100":::
:::code language="csharp" source="~/snippets/csharp/System.Runtime.Remoting.Metadata/SoapMethodAttribute/Overview/demo.cs" id="Snippet100":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SoapMethodAttribute ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Runtime.Remoting.Metadata.SoapMethodAttribute.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 SoapMethodAttribute();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Creates an instance of <see cref="T:System.Runtime.Remoting.Metadata.SoapMethodAttribute" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResponseXmlElementName">
<MemberSignature Language="C#" Value="public string ResponseXmlElementName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ResponseXmlElementName" />
<MemberSignature Language="DocId" Value="P:System.Runtime.Remoting.Metadata.SoapMethodAttribute.ResponseXmlElementName" />
<MemberSignature Language="VB.NET" Value="Public Property ResponseXmlElementName As String" />
<MemberSignature Language="F#" Value="member this.ResponseXmlElementName : string with get, set" Usage="System.Runtime.Remoting.Metadata.SoapMethodAttribute.ResponseXmlElementName" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ResponseXmlElementName { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the XML element name to use for the method response to the target method.</summary>
<value>The XML element name to use for the method response to the target method.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default value of this property is the string "Response" appended to the name of the method.
## Examples
The following code example shows how to use the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute.ResponseXmlElementName%2A> property. This code example is part of a larger example provided for the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute> class.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/System.Runtime.Remoting.Metadata.SoapMethodAttribute/CPP/demo.cpp" id="Snippet110":::
:::code language="csharp" source="~/snippets/csharp/System.Runtime.Remoting.Metadata/SoapMethodAttribute/Overview/demo.cs" id="Snippet110":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ResponseXmlNamespace">
<MemberSignature Language="C#" Value="public string ResponseXmlNamespace { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ResponseXmlNamespace" />
<MemberSignature Language="DocId" Value="P:System.Runtime.Remoting.Metadata.SoapMethodAttribute.ResponseXmlNamespace" />
<MemberSignature Language="VB.NET" Value="Public Property ResponseXmlNamespace As String" />
<MemberSignature Language="F#" Value="member this.ResponseXmlNamespace : string with get, set" Usage="System.Runtime.Remoting.Metadata.SoapMethodAttribute.ResponseXmlNamespace" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ResponseXmlNamespace { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the XML element namespace used for method response to the target method.</summary>
<value>The XML element namespace used for method response to the target method.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example shows how to use the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute.ResponseXmlNamespace%2A> property. This code example is part of a larger example provided for the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute> class.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/System.Runtime.Remoting.Metadata.SoapMethodAttribute/CPP/demo.cpp" id="Snippet110":::
:::code language="csharp" source="~/snippets/csharp/System.Runtime.Remoting.Metadata/SoapMethodAttribute/Overview/demo.cs" id="Snippet110":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ReturnXmlElementName">
<MemberSignature Language="C#" Value="public string ReturnXmlElementName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ReturnXmlElementName" />
<MemberSignature Language="DocId" Value="P:System.Runtime.Remoting.Metadata.SoapMethodAttribute.ReturnXmlElementName" />
<MemberSignature Language="VB.NET" Value="Public Property ReturnXmlElementName As String" />
<MemberSignature Language="F#" Value="member this.ReturnXmlElementName : string with get, set" Usage="System.Runtime.Remoting.Metadata.SoapMethodAttribute.ReturnXmlElementName" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ReturnXmlElementName { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the XML element name used for the return value from the target method.</summary>
<value>The XML element name used for the return value from the target method.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default value of this property is the "__return" string.
## Examples
The following code example shows how to use the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute.ReturnXmlElementName%2A> property. This code example is part of a larger example provided for the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute> class.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/System.Runtime.Remoting.Metadata.SoapMethodAttribute/CPP/demo.cpp" id="Snippet110":::
:::code language="csharp" source="~/snippets/csharp/System.Runtime.Remoting.Metadata/SoapMethodAttribute/Overview/demo.cs" id="Snippet110":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="SoapAction">
<MemberSignature Language="C#" Value="public string SoapAction { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SoapAction" />
<MemberSignature Language="DocId" Value="P:System.Runtime.Remoting.Metadata.SoapMethodAttribute.SoapAction" />
<MemberSignature Language="VB.NET" Value="Public Property SoapAction As String" />
<MemberSignature Language="F#" Value="member this.SoapAction : string with get, set" Usage="System.Runtime.Remoting.Metadata.SoapMethodAttribute.SoapAction" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ SoapAction { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[get: System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<get: System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the SOAPAction header field used with HTTP requests sent with this method. This property is currently not implemented.</summary>
<value>The SOAPAction header field used with HTTP requests sent with this method.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property is currently not implemented.
The SOAPAction HTTP request header field indicates the intent of the SOAP HTTP request. For more information on the SOAPAction field, see [The SOAPAction HTTP Header Field](https://www.w3.org/TR/2000/NOTE-SOAP-20000508/#_Toc478383528) section of the W3C specification.
## Examples
The following code example shows how to use the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute.SoapAction%2A> property. This code example is part of a larger example provided for the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute> class.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/System.Runtime.Remoting.Metadata.SoapMethodAttribute/CPP/demo.cpp" id="Snippet110":::
:::code language="csharp" source="~/snippets/csharp/System.Runtime.Remoting.Metadata/SoapMethodAttribute/Overview/demo.cs" id="Snippet110":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="UseAttribute">
<MemberSignature Language="C#" Value="public override bool UseAttribute { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UseAttribute" />
<MemberSignature Language="DocId" Value="P:System.Runtime.Remoting.Metadata.SoapMethodAttribute.UseAttribute" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property UseAttribute As Boolean" />
<MemberSignature Language="F#" Value="member this.UseAttribute : bool with get, set" Usage="System.Runtime.Remoting.Metadata.SoapMethodAttribute.UseAttribute" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool UseAttribute { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether the target of the current attribute will be serialized as an XML attribute instead of an XML field.</summary>
<value>The current implementation always returns <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Runtime.Remoting.Metadata.SoapTypeAttribute.UseAttribute%2A> property cannot be set on the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute> attribute.
]]></format>
</remarks>
<exception cref="T:System.Runtime.Remoting.RemotingException">An attempt was made to set the current property.</exception>
</Docs>
</Member>
<Member MemberName="XmlNamespace">
<MemberSignature Language="C#" Value="public override string XmlNamespace { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string XmlNamespace" />
<MemberSignature Language="DocId" Value="P:System.Runtime.Remoting.Metadata.SoapMethodAttribute.XmlNamespace" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property XmlNamespace As String" />
<MemberSignature Language="F#" Value="member this.XmlNamespace : string with get, set" Usage="System.Runtime.Remoting.Metadata.SoapMethodAttribute.XmlNamespace" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::String ^ XmlNamespace { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[get: System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<get: System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the XML namespace that is used during serialization of remote method calls of the target method.</summary>
<value>The XML namespace that is used during serialization of remote method calls of the target method.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example shows how to use the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute.XmlNamespace%2A> property. This code example is part of a larger example provided for the <xref:System.Runtime.Remoting.Metadata.SoapMethodAttribute> class.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/System.Runtime.Remoting.Metadata.SoapMethodAttribute/CPP/demo.cpp" id="Snippet110":::
:::code language="csharp" source="~/snippets/csharp/System.Runtime.Remoting.Metadata/SoapMethodAttribute/Overview/demo.cs" id="Snippet110":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>