/
SqlTrackingQuery.xml
213 lines (196 loc) · 16.2 KB
/
SqlTrackingQuery.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
<Type Name="SqlTrackingQuery" FullName="System.Workflow.Runtime.Tracking.SqlTrackingQuery">
<TypeSignature Language="C#" Value="public sealed class SqlTrackingQuery" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SqlTrackingQuery extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Workflow.Runtime.Tracking.SqlTrackingQuery" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class SqlTrackingQuery" />
<TypeSignature Language="F#" Value="type SqlTrackingQuery = class" />
<TypeSignature Language="C++ CLI" Value="public ref class SqlTrackingQuery sealed" />
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="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.Obsolete("The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Contains methods and properties that are used to manage queries to the tracking data that is contained in the SQL database used by a <see cref="T:System.Workflow.Runtime.Tracking.SqlTrackingService" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
> [!NOTE]
> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)]
<xref:System.Workflow.Runtime.Tracking.SqlTrackingQuery> provides methods and properties that you can use in order to access certain kinds of tracking data stored in a SQL database by the <xref:System.Workflow.Runtime.Tracking.SqlTrackingService>. Access to this data is provided through <xref:System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance> objects. You can call <xref:System.Workflow.Runtime.Tracking.SqlTrackingQuery.TryGetWorkflow%2A> to try to get a <xref:System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance> for a specific workflow instance. You can call <xref:System.Workflow.Runtime.Tracking.SqlTrackingQuery.GetWorkflows%2A> to get a collection of <xref:System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance> objects that correspond workflow instances that have tracking data that matches a set of query parameters contained in a <xref:System.Workflow.Runtime.Tracking.SqlTrackingQueryOptions> that is passed as a parameter to the method. See the <xref:System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance> class for more information about the kind of tracking data available and see the <xref:System.Workflow.Runtime.Tracking.SqlTrackingQueryOptions> class for more information about the kind of queries that can be performed.
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.Tracking.SqlTrackingQuery" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SqlTrackingQuery ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.Tracking.SqlTrackingQuery.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 SqlTrackingQuery();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.Tracking.SqlTrackingQuery" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The parameterless constructor initializes <xref:System.Workflow.Runtime.Tracking.SqlTrackingQuery.ConnectionString%2A> to a null reference (`Nothing` in Visual Basic). You must set <xref:System.Workflow.Runtime.Tracking.SqlTrackingQuery.ConnectionString%2A> before you call <xref:System.Workflow.Runtime.Tracking.SqlTrackingQuery.GetWorkflows%2A> or <xref:System.Workflow.Runtime.Tracking.SqlTrackingQuery.TryGetWorkflow%2A> or an <xref:System.InvalidOperationException> will be thrown.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SqlTrackingQuery (string connectionString);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string connectionString) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.Tracking.SqlTrackingQuery.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (connectionString As String)" />
<MemberSignature Language="F#" Value="new System.Workflow.Runtime.Tracking.SqlTrackingQuery : string -> System.Workflow.Runtime.Tracking.SqlTrackingQuery" Usage="new System.Workflow.Runtime.Tracking.SqlTrackingQuery connectionString" />
<MemberSignature Language="C++ CLI" Value="public:
 SqlTrackingQuery(System::String ^ connectionString);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="connectionString" Type="System.String" />
</Parameters>
<Docs>
<param name="connectionString">The connection string of the SQL database to query.</param>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.Tracking.SqlTrackingQuery" /> class.</summary>
<remarks>
<format type="text/markdown"><).
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet129":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet129":::
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="connectionString" /> is a null reference (<see langword="Nothing" /> in Visual Basic).</exception>
<related type="Article" href="https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)">Workflow Monitor</related>
</Docs>
</Member>
<Member MemberName="ConnectionString">
<MemberSignature Language="C#" Value="public string ConnectionString { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ConnectionString" />
<MemberSignature Language="DocId" Value="P:System.Workflow.Runtime.Tracking.SqlTrackingQuery.ConnectionString" />
<MemberSignature Language="VB.NET" Value="Public Property ConnectionString As String" />
<MemberSignature Language="F#" Value="member this.ConnectionString : string with get, set" Usage="System.Workflow.Runtime.Tracking.SqlTrackingQuery.ConnectionString" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ConnectionString { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>The connection string of the SQL tracking database to query.</summary>
<value>A SQL database connection string.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">An attempt to set <see cref="P:System.Workflow.Runtime.Tracking.SqlTrackingQuery.ConnectionString" /> to a null reference (<see langword="Nothing" /> in Visual Basic) was made.</exception>
</Docs>
</Member>
<Member MemberName="GetWorkflows">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance> GetWorkflows (System.Workflow.Runtime.Tracking.SqlTrackingQueryOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IList`1<class System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance> GetWorkflows(class System.Workflow.Runtime.Tracking.SqlTrackingQueryOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.Tracking.SqlTrackingQuery.GetWorkflows(System.Workflow.Runtime.Tracking.SqlTrackingQueryOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function GetWorkflows (options As SqlTrackingQueryOptions) As IList(Of SqlTrackingWorkflowInstance)" />
<MemberSignature Language="F#" Value="member this.GetWorkflows : System.Workflow.Runtime.Tracking.SqlTrackingQueryOptions -> System.Collections.Generic.IList<System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance>" Usage="sqlTrackingQuery.GetWorkflows options" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Collections::Generic::IList<System::Workflow::Runtime::Tracking::SqlTrackingWorkflowInstance ^> ^ GetWorkflows(System::Workflow::Runtime::Tracking::SqlTrackingQueryOptions ^ options);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="System.Workflow.Runtime.Tracking.SqlTrackingQueryOptions" />
</Parameters>
<Docs>
<param name="options">A <see cref="T:System.Workflow.Runtime.Tracking.SqlTrackingQueryOptions" /> that specifies query parameters.</param>
<summary>Returns tracking data for a set of workflow instances that correspond to a set of query parameters specified by a <see cref="T:System.Workflow.Runtime.Tracking.SqlTrackingQueryOptions" />.</summary>
<returns>A list of <see cref="T:System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance" /> objects that provide access to tracking data for the set of workflow instances with tracking data that matches the query parameters specified by <paramref name="options" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="options" /> is a null reference (<see langword="Nothing" /> in Visual Basic).</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="P:System.Workflow.Runtime.Tracking.SqlTrackingQuery.ConnectionString" /> is a null reference (<see langword="Nothing" />).</exception>
</Docs>
</Member>
<Member MemberName="TryGetWorkflow">
<MemberSignature Language="C#" Value="public bool TryGetWorkflow (Guid workflowInstanceId, out System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance workflowInstance);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetWorkflow(valuetype System.Guid workflowInstanceId, [out] class System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance& workflowInstance) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.Tracking.SqlTrackingQuery.TryGetWorkflow(System.Guid,System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetWorkflow (workflowInstanceId As Guid, ByRef workflowInstance As SqlTrackingWorkflowInstance) As Boolean" />
<MemberSignature Language="F#" Value="member this.TryGetWorkflow : Guid * SqlTrackingWorkflowInstance -> bool" Usage="sqlTrackingQuery.TryGetWorkflow (workflowInstanceId, workflowInstance)" />
<MemberSignature Language="C++ CLI" Value="public:
 bool TryGetWorkflow(Guid workflowInstanceId, [Runtime::InteropServices::Out] System::Workflow::Runtime::Tracking::SqlTrackingWorkflowInstance ^ % workflowInstance);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="workflowInstanceId" Type="System.Guid" />
<Parameter Name="workflowInstance" Type="System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance" RefType="out" />
</Parameters>
<Docs>
<param name="workflowInstanceId">The <see cref="T:System.Guid" /> of the workflow instance for which the tracking data is requested.</param>
<param name="workflowInstance">When this method returns <see langword="true" />, contains a <see cref="T:System.Workflow.Runtime.Tracking.SqlTrackingWorkflowInstance" /> that provides access to the tracking data associated with the workflow instance. This parameter is passed uninitiailized.</param>
<summary>Tries to get query data for a specified workflow instance.</summary>
<returns>
<see langword="true" /> if tracking data is available for the requested workflow instance; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><).
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets1.cs" id="Snippet129":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets1.vb" id="Snippet129":::
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">
<see cref="P:System.Workflow.Runtime.Tracking.SqlTrackingQuery.ConnectionString" /> is a null reference (<see langword="Nothing" /> in Visual Basic).</exception>
<related type="Article" href="https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741706(v=vs.90)">Workflow Monitor</related>
</Docs>
</Member>
</Members>
</Type>