-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
EnvelopeVersion.xml
366 lines (332 loc) · 19.6 KB
/
EnvelopeVersion.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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
<Type Name="EnvelopeVersion" FullName="System.ServiceModel.EnvelopeVersion">
<TypeSignature Language="C#" Value="public sealed class EnvelopeVersion" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit EnvelopeVersion extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.ServiceModel.EnvelopeVersion" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class EnvelopeVersion" />
<TypeSignature Language="F#" Value="type EnvelopeVersion = class" />
<TypeSignature Language="C++ CLI" Value="public ref class EnvelopeVersion sealed" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
<AssemblyVersion>4.7.0.0</AssemblyVersion>
<AssemblyVersion>4.9.0.0</AssemblyVersion>
<AssemblyVersion>4.10.0.0</AssemblyVersion>
<AssemblyVersion>4.10.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<TypeForwardingChain>
<TypeForwarding From="System.ServiceModel" FromVersion="4.0.0.0" To="System.ServiceModel.Primitives" ToVersion="0.0.0.0" FrameworkAlternate="dotnet-uwp-10.0" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Contains information related to the version of SOAP associated with a message and its exchange.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The SOAP versions currently available are SOAP 1.1 and SOAP 1.2. There is an <xref:System.ServiceModel.EnvelopeVersion> for each of these versions of SOAP that can be recovered using the <xref:System.ServiceModel.EnvelopeVersion.Soap11%2A> and <xref:System.ServiceModel.EnvelopeVersion.Soap12%2A> properties. There is also a <xref:System.ServiceModel.EnvelopeVersion.None%2A> message version that is used to sent and receive XML messages that do not use SOAP formatting. The processing roles associated with each message version can be recovered using the <xref:System.ServiceModel.EnvelopeVersion.NextDestinationActorValue%2A> property and the <xref:System.ServiceModel.EnvelopeVersion.GetUltimateDestinationActorValues%2A> method.
## Examples
The following code shows how to access the methods and properties of <xref:System.ServiceModel.EnvelopeVersion>.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ueenvelopeversion/cs/program.cs" id="Snippet0":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_ueenvelopeversion/vb/module1.vb" id="Snippet0":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="GetUltimateDestinationActorValues">
<MemberSignature Language="C#" Value="public string[] GetUltimateDestinationActorValues ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string[] GetUltimateDestinationActorValues() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.EnvelopeVersion.GetUltimateDestinationActorValues" />
<MemberSignature Language="VB.NET" Value="Public Function GetUltimateDestinationActorValues () As String()" />
<MemberSignature Language="F#" Value="member this.GetUltimateDestinationActorValues : unit -> string[]" Usage="envelopeVersion.GetUltimateDestinationActorValues " />
<MemberSignature Language="C++ CLI" Value="public:
 cli::array <System::String ^> ^ GetUltimateDestinationActorValues();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets a string that contains the URI name for the SOAP role associated with the current message version for the ultimate destination.</summary>
<returns>An empty string if SOAP1.1 is used; a string that contains http://www.w3.org/2003/05/soap-envelope/role/ultimateReceiver if SOAP1.2 is used.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The ultimate receiver is `null` if <xref:System.ServiceModel.EnvelopeVersion.None%2A> is specified.
## Examples
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ueenvelopeversion/cs/program.cs" id="Snippet5":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_ueenvelopeversion/vb/module1.vb" id="Snippet5":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="NextDestinationActorValue">
<MemberSignature Language="C#" Value="public string NextDestinationActorValue { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string NextDestinationActorValue" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.EnvelopeVersion.NextDestinationActorValue" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property NextDestinationActorValue As String" />
<MemberSignature Language="F#" Value="member this.NextDestinationActorValue : string" Usage="System.ServiceModel.EnvelopeVersion.NextDestinationActorValue" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ NextDestinationActorValue { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a string that contains the URI name for the SOAP role associated with the current message version for the next destination.</summary>
<value>A string that contains http://schemas.xmlsoap.org/soap/actor/next if SOAP1.1 is used; a string that contains http://www.w3.org/2003/05/soap-envelope/role/next if SOAP1.2 is used; and an empty string if the message version is none.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ueenvelopeversion/cs/program.cs" id="Snippet4":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_ueenvelopeversion/vb/module1.vb" id="Snippet4":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="None">
<MemberSignature Language="C#" Value="public static System.ServiceModel.EnvelopeVersion None { get; }" />
<MemberSignature Language="ILAsm" Value=".property class System.ServiceModel.EnvelopeVersion None" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.EnvelopeVersion.None" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property None As EnvelopeVersion" />
<MemberSignature Language="F#" Value="static member None : System.ServiceModel.EnvelopeVersion" Usage="System.ServiceModel.EnvelopeVersion.None" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::ServiceModel::EnvelopeVersion ^ None { System::ServiceModel::EnvelopeVersion ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.ServiceModel.EnvelopeVersion</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the envelope version not using a version of SOAP.</summary>
<value>The envelope version not using a SOAP formatting.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the <xref:System.ServiceModel.EnvelopeVersion.None%2A> message version is used this means that a SOAP envelope is not written out and the message emits the contents of the body. This enables an Windows Communication Foundation (WCF) channel to communicate with an endpoint that is expecting XML with no SOAP formatting. The XML payload lives in the body of a message and is the only thing emitted when it hits the encoder.
Similarly, when the arbitrary chunk of XML is received it is wrapped up in a Message for propagation up the channel stack. The required headers are inserted and the message is processed as if it had been a SOAP message.
## Examples
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ueenvelopeversion/cs/program.cs" id="Snippet3":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_ueenvelopeversion/vb/module1.vb" id="Snippet3":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Soap11">
<MemberSignature Language="C#" Value="public static System.ServiceModel.EnvelopeVersion Soap11 { get; }" />
<MemberSignature Language="ILAsm" Value=".property class System.ServiceModel.EnvelopeVersion Soap11" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.EnvelopeVersion.Soap11" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property Soap11 As EnvelopeVersion" />
<MemberSignature Language="F#" Value="static member Soap11 : System.ServiceModel.EnvelopeVersion" Usage="System.ServiceModel.EnvelopeVersion.Soap11" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::ServiceModel::EnvelopeVersion ^ Soap11 { System::ServiceModel::EnvelopeVersion ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.ServiceModel.EnvelopeVersion</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the SOAP1.1 envelope version.</summary>
<value>The SOAP1.1 <see cref="T:System.ServiceModel.EnvelopeVersion" /> object.</value>
<remarks>
<format type="text/markdown"><.
## Examples
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ueenvelopeversion/cs/program.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_ueenvelopeversion/vb/module1.vb" id="Snippet1":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Soap12">
<MemberSignature Language="C#" Value="public static System.ServiceModel.EnvelopeVersion Soap12 { get; }" />
<MemberSignature Language="ILAsm" Value=".property class System.ServiceModel.EnvelopeVersion Soap12" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.EnvelopeVersion.Soap12" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property Soap12 As EnvelopeVersion" />
<MemberSignature Language="F#" Value="static member Soap12 : System.ServiceModel.EnvelopeVersion" Usage="System.ServiceModel.EnvelopeVersion.Soap12" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::ServiceModel::EnvelopeVersion ^ Soap12 { System::ServiceModel::EnvelopeVersion ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.ServiceModel.EnvelopeVersion</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the SOAP1.2 envelope version.</summary>
<value>The SOAP1.2 <see cref="T:System.ServiceModel.EnvelopeVersion" /> object.</value>
<remarks>
<format type="text/markdown"><.
## Examples
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ueenvelopeversion/cs/program.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_ueenvelopeversion/vb/module1.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.EnvelopeVersion.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="envelopeVersion.ToString " />
<MemberSignature Language="C++ CLI" Value="public:
 override System::String ^ ToString();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets a string that represents the current envelope version.</summary>
<returns>The string representation of the current envelope version.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method returns a human-readable string that is culture-sensitive.
## Examples
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ueenvelopeversion/cs/program.cs" id="Snippet6":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_ueenvelopeversion/vb/module1.vb" id="Snippet6":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>