/
WsdlContractConversionContext.xml
300 lines (280 loc) · 24 KB
/
WsdlContractConversionContext.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
<Type Name="WsdlContractConversionContext" FullName="System.ServiceModel.Description.WsdlContractConversionContext">
<TypeSignature Language="C#" Value="public class WsdlContractConversionContext" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WsdlContractConversionContext extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.ServiceModel.Description.WsdlContractConversionContext" />
<TypeSignature Language="VB.NET" Value="Public Class WsdlContractConversionContext" />
<TypeSignature Language="F#" Value="type WsdlContractConversionContext = class" />
<TypeSignature Language="C++ CLI" Value="public ref class WsdlContractConversionContext" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Passed to custom WSDL exporters and importers to enable customization of the metadata export and import processes for a contract.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.ServiceModel.Description.WsdlContractConversionContext> object to examine and modify items that are to be converted to or from WSDL.
When exporting metadata a <xref:System.ServiceModel.Description.WsdlContractConversionContext> object is passed to the <xref:System.ServiceModel.Description.IWsdlExportExtension.ExportContract%2A> and <xref:System.ServiceModel.Description.IWsdlExportExtension.ExportEndpoint%2A> methods. Use the various methods and properties to obtain metadata objects that you can use to examine and modify to alter the published WSDL.
When importing metadata a <xref:System.ServiceModel.Description.WsdlContractConversionContext> object is passed to the <xref:System.ServiceModel.Description.IWsdlImportExtension.ImportContract%2A> and <xref:System.ServiceModel.Description.IWsdlImportExtension.ImportEndpoint%2A> methods. Use the various methods and properties to obtain metadata objects that you can use to examine and modify the imported metadata.
## Examples
The following code example shows the use of the <xref:System.ServiceModel.Description.WsdlContractConversionContext> to add custom WSDL annotations to the exported metadata using the <xref:System.ServiceModel.Description.WsdlContractConversionContext.WsdlPortType%2A> and <xref:System.ServiceModel.Description.WsdlContractConversionContext.Contract%2A> properties.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationattribute.cs" id="Snippet6":::
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationattribute.cs" id="Snippet7":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Contract">
<MemberSignature Language="C#" Value="public System.ServiceModel.Description.ContractDescription Contract { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.Description.ContractDescription Contract" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Description.WsdlContractConversionContext.Contract" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Contract As ContractDescription" />
<MemberSignature Language="F#" Value="member this.Contract : System.ServiceModel.Description.ContractDescription" Usage="System.ServiceModel.Description.WsdlContractConversionContext.Contract" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::ServiceModel::Description::ContractDescription ^ Contract { System::ServiceModel::Description::ContractDescription ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.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.Description.ContractDescription</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.ServiceModel.Description.ContractDescription" /> being exported or imported.</summary>
<value>The <see cref="T:System.ServiceModel.Description.ContractDescription" /> being exported or imported.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.ServiceModel.Description.WsdlContractConversionContext.Contract%2A> property to obtain the contract description on export or import.
## Examples
The following code example shows the use of the <xref:System.ServiceModel.Description.WsdlContractConversionContext> to add custom WSDL annotations to the exported metadata using the <xref:System.ServiceModel.Description.WsdlContractConversionContext.WsdlPortType%2A> and <xref:System.ServiceModel.Description.WsdlContractConversionContext.Contract%2A> properties.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationattribute.cs" id="Snippet6":::
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationattribute.cs" id="Snippet7":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetFaultDescription">
<MemberSignature Language="C#" Value="public System.ServiceModel.Description.FaultDescription GetFaultDescription (System.Web.Services.Description.OperationFault operationFault);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.ServiceModel.Description.FaultDescription GetFaultDescription(class System.Web.Services.Description.OperationFault operationFault) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Description.WsdlContractConversionContext.GetFaultDescription(System.Web.Services.Description.OperationFault)" />
<MemberSignature Language="VB.NET" Value="Public Function GetFaultDescription (operationFault As OperationFault) As FaultDescription" />
<MemberSignature Language="F#" Value="member this.GetFaultDescription : System.Web.Services.Description.OperationFault -> System.ServiceModel.Description.FaultDescription" Usage="wsdlContractConversionContext.GetFaultDescription operationFault" />
<MemberSignature Language="C++ CLI" Value="public:
 System::ServiceModel::Description::FaultDescription ^ GetFaultDescription(System::Web::Services::Description::OperationFault ^ operationFault);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Description.FaultDescription</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operationFault" Type="System.Web.Services.Description.OperationFault" />
</Parameters>
<Docs>
<param name="operationFault">The <see cref="T:System.Web.Services.Description.OperationFault" /> for the requested <see cref="T:System.ServiceModel.Description.FaultDescription" />.</param>
<summary>Returns the fault description for the specified fault.</summary>
<returns>The fault description for the specified fault.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Collections.Generic.KeyNotFoundException">The value was not found.</exception>
<exception cref="T:System.ArgumentNullException">The value is null.</exception>
</Docs>
</Member>
<Member MemberName="GetMessageDescription">
<MemberSignature Language="C#" Value="public System.ServiceModel.Description.MessageDescription GetMessageDescription (System.Web.Services.Description.OperationMessage operationMessage);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.ServiceModel.Description.MessageDescription GetMessageDescription(class System.Web.Services.Description.OperationMessage operationMessage) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Description.WsdlContractConversionContext.GetMessageDescription(System.Web.Services.Description.OperationMessage)" />
<MemberSignature Language="VB.NET" Value="Public Function GetMessageDescription (operationMessage As OperationMessage) As MessageDescription" />
<MemberSignature Language="F#" Value="member this.GetMessageDescription : System.Web.Services.Description.OperationMessage -> System.ServiceModel.Description.MessageDescription" Usage="wsdlContractConversionContext.GetMessageDescription operationMessage" />
<MemberSignature Language="C++ CLI" Value="public:
 System::ServiceModel::Description::MessageDescription ^ GetMessageDescription(System::Web::Services::Description::OperationMessage ^ operationMessage);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Description.MessageDescription</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operationMessage" Type="System.Web.Services.Description.OperationMessage" />
</Parameters>
<Docs>
<param name="operationMessage">The <see cref="T:System.Web.Services.Description.OperationMessage" /> for the requested <see cref="T:System.ServiceModel.Description.MessageDescription" />.</param>
<summary>Returns the message description for the specified message.</summary>
<returns>The message description for the specified message.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Collections.Generic.KeyNotFoundException">The value was not found.</exception>
<exception cref="T:System.ArgumentNullException">The value is null.</exception>
</Docs>
</Member>
<Member MemberName="GetOperation">
<MemberSignature Language="C#" Value="public System.Web.Services.Description.Operation GetOperation (System.ServiceModel.Description.OperationDescription operation);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Web.Services.Description.Operation GetOperation(class System.ServiceModel.Description.OperationDescription operation) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Description.WsdlContractConversionContext.GetOperation(System.ServiceModel.Description.OperationDescription)" />
<MemberSignature Language="VB.NET" Value="Public Function GetOperation (operation As OperationDescription) As Operation" />
<MemberSignature Language="F#" Value="member this.GetOperation : System.ServiceModel.Description.OperationDescription -> System.Web.Services.Description.Operation" Usage="wsdlContractConversionContext.GetOperation operation" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Web::Services::Description::Operation ^ GetOperation(System::ServiceModel::Description::OperationDescription ^ operation);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.Services.Description.Operation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operation" Type="System.ServiceModel.Description.OperationDescription" />
</Parameters>
<Docs>
<param name="operation">The <see cref="T:System.ServiceModel.Description.OperationDescription" /> for the requested <see cref="T:System.Web.Services.Description.Operation" />.</param>
<summary>Returns the operation for the specified operation description.</summary>
<returns>The operation for the specified operation description.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example shows the use of the <xref:System.ServiceModel.Description.WsdlContractConversionContext> to add custom WSDL annotations to the exported metadata using the <xref:System.ServiceModel.Description.WsdlContractConversionContext.WsdlPortType%2A> and <xref:System.ServiceModel.Description.WsdlContractConversionContext.Contract%2A> properties. When exporting operations, the method iterates through the operation descriptions, and locates each associated <xref:System.Web.Services.Description.Operation?displayProperty=nameWithType> by calling the <xref:System.ServiceModel.Description.WsdlContractConversionContext.GetOperation%2A> method.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationattribute.cs" id="Snippet7":::
]]></format>
</remarks>
<exception cref="T:System.Collections.Generic.KeyNotFoundException">The value was not found.</exception>
<exception cref="T:System.ArgumentNullException">The value is null.</exception>
</Docs>
</Member>
<Member MemberName="GetOperationDescription">
<MemberSignature Language="C#" Value="public System.ServiceModel.Description.OperationDescription GetOperationDescription (System.Web.Services.Description.Operation operation);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.ServiceModel.Description.OperationDescription GetOperationDescription(class System.Web.Services.Description.Operation operation) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Description.WsdlContractConversionContext.GetOperationDescription(System.Web.Services.Description.Operation)" />
<MemberSignature Language="VB.NET" Value="Public Function GetOperationDescription (operation As Operation) As OperationDescription" />
<MemberSignature Language="F#" Value="member this.GetOperationDescription : System.Web.Services.Description.Operation -> System.ServiceModel.Description.OperationDescription" Usage="wsdlContractConversionContext.GetOperationDescription operation" />
<MemberSignature Language="C++ CLI" Value="public:
 System::ServiceModel::Description::OperationDescription ^ GetOperationDescription(System::Web::Services::Description::Operation ^ operation);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Description.OperationDescription</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operation" Type="System.Web.Services.Description.Operation" />
</Parameters>
<Docs>
<param name="operation">The <see cref="T:System.Web.Services.Description.Operation" /> for the requested <see cref="T:System.ServiceModel.Description.OperationDescription" />.</param>
<summary>Returns the operation description associated with the operation.</summary>
<returns>The operation description associated with the operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Collections.Generic.KeyNotFoundException">The value was not found.</exception>
<exception cref="T:System.ArgumentNullException">The value is null.</exception>
</Docs>
</Member>
<Member MemberName="GetOperationFault">
<MemberSignature Language="C#" Value="public System.Web.Services.Description.OperationFault GetOperationFault (System.ServiceModel.Description.FaultDescription fault);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Web.Services.Description.OperationFault GetOperationFault(class System.ServiceModel.Description.FaultDescription fault) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Description.WsdlContractConversionContext.GetOperationFault(System.ServiceModel.Description.FaultDescription)" />
<MemberSignature Language="VB.NET" Value="Public Function GetOperationFault (fault As FaultDescription) As OperationFault" />
<MemberSignature Language="F#" Value="member this.GetOperationFault : System.ServiceModel.Description.FaultDescription -> System.Web.Services.Description.OperationFault" Usage="wsdlContractConversionContext.GetOperationFault fault" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Web::Services::Description::OperationFault ^ GetOperationFault(System::ServiceModel::Description::FaultDescription ^ fault);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.Services.Description.OperationFault</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fault" Type="System.ServiceModel.Description.FaultDescription" />
</Parameters>
<Docs>
<param name="fault">The <see cref="T:System.ServiceModel.Description.FaultDescription" /> for the requested <see cref="T:System.Web.Services.Description.OperationFault" />.</param>
<summary>Returns the <see cref="T:System.Web.Services.Description.OperationFault" /> for the requested <see cref="T:System.ServiceModel.Description.FaultDescription" />.</summary>
<returns>The <see cref="T:System.Web.Services.Description.OperationFault" /> for the requested <see cref="T:System.ServiceModel.Description.FaultDescription" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Collections.Generic.KeyNotFoundException">The value was not found.</exception>
<exception cref="T:System.ArgumentNullException">The value is null.</exception>
</Docs>
</Member>
<Member MemberName="GetOperationMessage">
<MemberSignature Language="C#" Value="public System.Web.Services.Description.OperationMessage GetOperationMessage (System.ServiceModel.Description.MessageDescription message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Web.Services.Description.OperationMessage GetOperationMessage(class System.ServiceModel.Description.MessageDescription message) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Description.WsdlContractConversionContext.GetOperationMessage(System.ServiceModel.Description.MessageDescription)" />
<MemberSignature Language="VB.NET" Value="Public Function GetOperationMessage (message As MessageDescription) As OperationMessage" />
<MemberSignature Language="F#" Value="member this.GetOperationMessage : System.ServiceModel.Description.MessageDescription -> System.Web.Services.Description.OperationMessage" Usage="wsdlContractConversionContext.GetOperationMessage message" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Web::Services::Description::OperationMessage ^ GetOperationMessage(System::ServiceModel::Description::MessageDescription ^ message);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.Services.Description.OperationMessage</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="System.ServiceModel.Description.MessageDescription" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:System.ServiceModel.Description.MessageDescription" /> for the requested <see cref="T:System.Web.Services.Description.OperationMessage" />.</param>
<summary>Gets a <see cref="T:System.Web.Services.Description.OperationMessage" /> object for the specified <paramref name="message" /> that represents a message type passed by the action of an XML Web service.</summary>
<returns>A <see cref="T:System.Web.Services.Description.OperationMessage" /> object that represents a message type passed by the action of an XML Web service.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Collections.Generic.KeyNotFoundException">The value was not found.</exception>
<exception cref="T:System.ArgumentNullException">The value is null.</exception>
</Docs>
</Member>
<Member MemberName="WsdlPortType">
<MemberSignature Language="C#" Value="public System.Web.Services.Description.PortType WsdlPortType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.Services.Description.PortType WsdlPortType" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Description.WsdlContractConversionContext.WsdlPortType" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property WsdlPortType As PortType" />
<MemberSignature Language="F#" Value="member this.WsdlPortType : System.Web.Services.Description.PortType" Usage="System.ServiceModel.Description.WsdlContractConversionContext.WsdlPortType" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::Services::Description::PortType ^ WsdlPortType { System::Web::Services::Description::PortType ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.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.Web.Services.Description.PortType</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Web.Services.Description.PortType" /> that represents the contract.</summary>
<value>The <see cref="T:System.Web.Services.Description.PortType" /> that represents the contract.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example shows the use of the <xref:System.ServiceModel.Description.WsdlContractConversionContext> to add custom WSDL annotations to the exported metadata using the <xref:System.ServiceModel.Description.WsdlContractConversionContext.WsdlPortType%2A> and <xref:System.ServiceModel.Description.WsdlContractConversionContext.Contract%2A> properties.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationattribute.cs" id="Snippet6":::
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationattribute.cs" id="Snippet7":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>