Add docs template

This commit is contained in:
Karl Burtram
2016-12-15 17:06:28 -08:00
275 changed files with 10751 additions and 19075 deletions

View File

@@ -10,43 +10,45 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Batch
">
<meta name="generator" content="docfx 1.0.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/style.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix">
<!--
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-63735192-1', 'auto');
ga('send', 'pageview');
</script>
-->
</head> <body data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<nav class="navbar navbar-inverse">
<div class="container">
<a href="../"><img height="50px" src="../images/sqlserver.png" style="float:right;"></a>
<div class="navbar-header ">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../"><span class="dotnet">SQL Tools Service</span></a>
</div>
<div id="navbar" class="collapse navbar-collapse">
</div><!--/.nav-collapse -->
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
@@ -68,7 +70,8 @@
<div class="col-md-10">
<article class="content wrap" id="_content">
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="pull-right mobile-hide"><span class="fa fa-github"></span>Improve this Doc</a>
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L24" class="pull-right mobile-hide">View Source</a>
<h1 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch">Class Batch
</h1>
<div class="markdown level0 summary"><p>This class represents a batch within a query</p>
@@ -79,30 +82,6 @@
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">Batch</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.QueryExecution</h6>
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
<h5 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_syntax">Syntax</h5>
@@ -118,7 +97,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L109">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_BatchText_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.BatchText*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_BatchText" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.BatchText">BatchText</h4>
<div class="markdown level1 summary"><p>The text of batch that will be executed</p>
</div>
@@ -127,7 +105,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string BatchText { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -149,7 +127,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L120">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ExecutionElapsedTime_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ExecutionElapsedTime*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ExecutionElapsedTime" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ExecutionElapsedTime">ExecutionElapsedTime</h4>
<div class="markdown level1 summary"><p>Localized timestamp for how long it took for the execution to complete</p>
</div>
@@ -158,7 +135,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ExecutionElapsedTime { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -180,7 +157,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L115">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ExecutionEndTimeStamp_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ExecutionEndTimeStamp*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ExecutionEndTimeStamp" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ExecutionEndTimeStamp">ExecutionEndTimeStamp</h4>
<div class="markdown level1 summary"><p>Localized timestamp for when the execution completed.
Stored in UTC ISO 8601 format; should be localized before displaying to any user</p>
@@ -190,7 +166,7 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ExecutionEndTimeStamp { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -212,7 +188,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L133">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ExecutionStartTimeStamp_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ExecutionStartTimeStamp*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ExecutionStartTimeStamp" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ExecutionStartTimeStamp">ExecutionStartTimeStamp</h4>
<div class="markdown level1 summary"><p>Localized timestamp for when the execution began.
Stored in UTC ISO 8601 format; should be localized before displaying to any user</p>
@@ -222,7 +197,7 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ExecutionStartTimeStamp { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -244,7 +219,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L138">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_HasError_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.HasError*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_HasError" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.HasError">HasError</h4>
<div class="markdown level1 summary"><p>Whether or not this batch has an error</p>
</div>
@@ -253,7 +227,7 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool HasError { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -275,7 +249,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L143">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_HasExecuted_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.HasExecuted*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_HasExecuted" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.HasExecuted">HasExecuted</h4>
<div class="markdown level1 summary"><p>Whether or not this batch has been executed, regardless of success or failure </p>
</div>
@@ -284,7 +257,7 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool HasExecuted { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -306,7 +279,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L148">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Id_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Id*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Id" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Id">Id</h4>
<div class="markdown level1 summary"><p>Ordinal of the batch in the query</p>
</div>
@@ -315,7 +287,7 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Id { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -337,7 +309,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L153">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ResultMessages_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultMessages*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ResultMessages" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultMessages">ResultMessages</h4>
<div class="markdown level1 summary"><p>Messages that have come back from the server</p>
</div>
@@ -346,7 +317,7 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;ResultMessage&gt; ResultMessages { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -368,7 +339,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L161">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ResultSets_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultSets*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ResultSets" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultSets">ResultSets</h4>
<div class="markdown level1 summary"><p>The result sets of the batch execution</p>
</div>
@@ -377,7 +347,7 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IList&lt;ResultSet&gt; ResultSets { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -399,7 +369,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L169">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ResultSummaries_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultSummaries*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ResultSummaries" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultSummaries">ResultSummaries</h4>
<div class="markdown level1 summary"><p>Property for generating a set result set summaries from the result sets</p>
</div>
@@ -408,7 +377,7 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ResultSetSummary[] ResultSummaries { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -430,7 +399,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L183">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Summary_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Summary*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Summary" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Summary">Summary</h4>
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.BatchSummary.html">BatchSummary</a> based on the batch instance</p>
</div>
@@ -439,7 +407,7 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BatchSummary Summary { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -463,7 +431,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L453">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Dispose_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Dispose*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Dispose" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Dispose">Dispose()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
@@ -471,8 +438,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
</div>
<h5 class="implements">Implements</h5>
<div><span class="xref">System.IDisposable.Dispose()</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Dispose_System_Boolean_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Dispose(System.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@@ -480,7 +445,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L459">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Dispose_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Dispose*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Dispose_System_Boolean_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Dispose(System.Boolean)">Dispose(Boolean)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
@@ -500,7 +464,7 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">disposing</span></td>
<td><em>disposing</em></td>
<td></td>
</tr>
</tbody>
@@ -512,7 +476,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L223">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Execute_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Execute*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_Execute_System_Data_Common_DbConnection_System_Threading_CancellationToken_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.Execute(System.Data.Common.DbConnection,System.Threading.CancellationToken)">Execute(DbConnection, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Executes this batch and captures any server messages that are returned.</p>
</div>
@@ -533,13 +496,13 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<tbody>
<tr>
<td><span class="xref">System.Data.Common.DbConnection</span></td>
<td><span class="parametername">conn</span></td>
<td><em>conn</em></td>
<td><p>The connection to use to execute the batch</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Threading.CancellationToken</span></td>
<td><span class="parametername">cancellationToken</span></td>
<td><em>cancellationToken</em></td>
<td><p>Token for cancelling the execution</p>
</td>
</tr>
@@ -567,7 +530,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/Batch.cs/#L352">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_GetSubset_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.GetSubset*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_GetSubset_System_Int32_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.GetSubset(System.Int32,System.Int32,System.Int32)">GetSubset(Int32, Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Generates a subset of the rows from a result set of the batch</p>
</div>
@@ -588,19 +550,19 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">resultSetIndex</span></td>
<td><em>resultSetIndex</em></td>
<td><p>The index for selecting the result set</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">startRow</span></td>
<td><em>startRow</em></td>
<td><p>The starting row of the results</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">rowCount</span></td>
<td><em>rowCount</em></td>
<td><p>How many rows to retrieve</p>
</td>
</tr>
@@ -639,21 +601,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Batch.BatchAsyncEventHandler BatchCompletion</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.BatchAsyncEventHandler.html">Batch.BatchAsyncEventHandler</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_BatchStart.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.BatchStart%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@@ -669,21 +616,6 @@ Stored in UTC ISO 8601 format; should be localized before displaying to any user
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Batch.BatchAsyncEventHandler BatchStart</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.BatchAsyncEventHandler.html">Batch.BatchAsyncEventHandler</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_Batch_ResultSetCompletion.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.Batch.ResultSetCompletion%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@@ -700,21 +632,6 @@ called from the Batch but from the ResultSet instance</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event ResultSet.ResultSetAsyncEventHandler ResultSetCompletion</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.ResultSetAsyncEventHandler.html">ResultSet.ResultSetAsyncEventHandler</a></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
@@ -739,16 +656,9 @@ called from the Batch but from the ResultSet instance</p>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2016 Microsoft<br>Generated by <strong>DocFX</strong></span>
<div class="inner-footer">
<p>© Microsoft &nbsp;//&nbsp; Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
</div>
</div>
</footer>
</div>