/
TransactionMessageProperty.xml
89 lines (85 loc) · 6.14 KB
/
TransactionMessageProperty.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
<Type Name="TransactionMessageProperty" FullName="System.ServiceModel.Channels.TransactionMessageProperty">
<TypeSignature Language="C#" Value="public sealed class TransactionMessageProperty" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit TransactionMessageProperty extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.ServiceModel.Channels.TransactionMessageProperty" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class TransactionMessageProperty" />
<TypeSignature Language="F#" Value="type TransactionMessageProperty = class" />
<TypeSignature Language="C++ CLI" Value="public ref class TransactionMessageProperty sealed" />
<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>Allows a custom channel, which uses a proprietary transaction flow mechanism, to inject its transaction into the Windows Communication Foundation (WCF) framework. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class allows third-party channel developers who use a proprietary transaction flow mechanism for their channel, to introduce their transaction into the ServiceModel framework. The transaction is then used when executing the service method. This mechanism cannot be used in conjunction with the <xref:System.ServiceModel.TransactionFlowAttribute>.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Set">
<MemberSignature Language="C#" Value="public static void Set (System.Transactions.Transaction transaction, System.ServiceModel.Channels.Message message);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Set(class System.Transactions.Transaction transaction, class System.ServiceModel.Channels.Message message) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Channels.TransactionMessageProperty.Set(System.Transactions.Transaction,System.ServiceModel.Channels.Message)" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub Set (transaction As Transaction, message As Message)" />
<MemberSignature Language="F#" Value="static member Set : System.Transactions.Transaction * System.ServiceModel.Channels.Message -> unit" Usage="System.ServiceModel.Channels.TransactionMessageProperty.Set (transaction, message)" />
<MemberSignature Language="C++ CLI" Value="public:
 static void Set(System::Transactions::Transaction ^ transaction, System::ServiceModel::Channels::Message ^ 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.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="transaction" Type="System.Transactions.Transaction" />
<Parameter Name="message" Type="System.ServiceModel.Channels.Message" />
</Parameters>
<Docs>
<param name="transaction">The transaction that will be used when executing the service method.</param>
<param name="message">The incoming message that results in calling the service method.</param>
<summary>Sets the transaction that will be used when executing the service method.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A custom incoming channel (which is part of a service's channel stack) can call this method to add a <xref:System.ServiceModel.Channels.TransactionMessageProperty>, containing the `transaction` parameter, to the `Properties` collection of the `message` parameter. This prompts the infrastructure to create a <xref:System.Transactions.TransactionScope> instance using the transaction passed in, before calling the service method requested in the incoming message. The service method must have the <xref:System.ServiceModel.OperationBehaviorAttribute.TransactionScopeRequired%2A> property set to `true`.
]]></format>
</remarks>
<exception cref="T:System.ServiceModel.FaultException">The property has already been set on <paramref name="message" />.</exception>
<exception cref="T:System.Transactions.TransactionException">
<paramref name="transaction" /> needs to be unmarshaled, and that operation fails.</exception>
</Docs>
</Member>
<Member MemberName="Transaction">
<MemberSignature Language="C#" Value="public System.Transactions.Transaction Transaction { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Transactions.Transaction Transaction" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Channels.TransactionMessageProperty.Transaction" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Transaction As Transaction" />
<MemberSignature Language="F#" Value="member this.Transaction : System.Transactions.Transaction" Usage="System.ServiceModel.Channels.TransactionMessageProperty.Transaction" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Transactions::Transaction ^ Transaction { System::Transactions::Transaction ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Transactions.Transaction</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the transaction that will be used when executing the service method.</summary>
<value>A <see cref="T:System.Transactions.Transaction" /> instance that will be used when executing the service method.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>