ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-22 09:35:38 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
e3c080b2a06ec24ac39b9664a414fa494f61a361
sqltoolsservice/docs/_site/api/Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.html
Karl Burtram e3c080b2a0 Add initial doxfx content
2016-12-15 16:37:50 -08:00

616 lines
38 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class ResultSet
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ResultSet
">
<meta name="generator" content="docfx 1.0.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</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>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content">
<h1 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet">Class ResultSet
</h1>
<div class="markdown level0 summary"><p>Class that represents a resultset the was generated from a query. Contains logic for
storing and retrieving results. Is contained by a Batch class.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">ResultSet</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_ResultSet_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ResultSet : IDisposable</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<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_ResultSet__ctor_System_Data_Common_DbDataReader_System_Int32_System_Int32_Microsoft_SqlTools_ServiceLayer_QueryExecution_DataStorage_IFileStreamFactory_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.%23ctor(System.Data.Common.DbDataReader%2CSystem.Int32%2CSystem.Int32%2CMicrosoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.IFileStreamFactory)%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L91">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet__ctor_System_Data_Common_DbDataReader_System_Int32_System_Int32_Microsoft_SqlTools_ServiceLayer_QueryExecution_DataStorage_IFileStreamFactory_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.#ctor(System.Data.Common.DbDataReader,System.Int32,System.Int32,Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.IFileStreamFactory)">ResultSet(DbDataReader, Int32, Int32, IFileStreamFactory)</h4>
<div class="markdown level1 summary"><p>Creates a new result set and initializes its state</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ResultSet(DbDataReader reader, int ordinal, int batchOrdinal, IFileStreamFactory factory)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Data.Common.DbDataReader</span></td>
<td><span class="parametername">reader</span></td>
<td><p>The reader from executing a query</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">ordinal</span></td>
<td><p>The ID of the resultset, the ordinal of the result within the batch</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">batchOrdinal</span></td>
<td><p>The ID of the batch, the ordinal of the batch within the query</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.IFileStreamFactory.html">IFileStreamFactory</a></td>
<td><span class="parametername">factory</span></td>
<td><p>Factory for creating a reader/writer</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<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_ResultSet_BatchId.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.BatchId%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L142">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_BatchId_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.BatchId*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_BatchId" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.BatchId">BatchId</h4>
<div class="markdown level1 summary"><p>ID of the batch set, relative to the query</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int BatchId { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></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_ResultSet_Columns.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Columns%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L132">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_Columns_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Columns*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_Columns" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Columns">Columns</h4>
<div class="markdown level1 summary"><p>The columns for this result set</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DbColumnWrapper[] Columns { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Contracts.DbColumnWrapper.html">DbColumnWrapper</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_ResultSet_Id.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Id%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L137">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_Id_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Id*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_Id" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Id">Id</h4>
<div class="markdown level1 summary"><p>ID of the result set, relative to the batch</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Id { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></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_ResultSet_MaxCharsToStore.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.MaxCharsToStore%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L147">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_MaxCharsToStore_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.MaxCharsToStore*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_MaxCharsToStore" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.MaxCharsToStore">MaxCharsToStore</h4>
<div class="markdown level1 summary"><p>Maximum number of characters to store for a field</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int MaxCharsToStore { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></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_ResultSet_MaxXmlCharsToStore.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.MaxXmlCharsToStore%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L152">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_MaxXmlCharsToStore_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.MaxXmlCharsToStore*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_MaxXmlCharsToStore" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.MaxXmlCharsToStore">MaxXmlCharsToStore</h4>
<div class="markdown level1 summary"><p>Maximum number of characters to store for an XML field</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int MaxXmlCharsToStore { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></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_ResultSet_RowCount.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.RowCount%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L157">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_RowCount_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.RowCount*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_RowCount" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.RowCount">RowCount</h4>
<div class="markdown level1 summary"><p>The number of rows for this result set</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public long RowCount { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int64</span></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_ResultSet_Summary.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Summary%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L162">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_Summary_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Summary*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_Summary" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Summary">Summary</h4>
<div class="markdown level1 summary"><p>Generates a summary of this result set</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ResultSetSummary Summary { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Contracts.ResultSetSummary.html">ResultSetSummary</a></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<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_ResultSet_Dispose.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Dispose%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L289">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_Dispose_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Dispose*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_Dispose" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Dispose">Dispose()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<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_ResultSet_Dispose_System_Boolean_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L295">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_Dispose_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Dispose*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_Dispose_System_Boolean_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.Dispose(System.Boolean)">Dispose(Boolean)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">disposing</span></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_ResultSet_GetSubset_System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.GetSubset(System.Int32%2CSystem.Int32)%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L186">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_GetSubset_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.GetSubset*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_GetSubset_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.GetSubset(System.Int32,System.Int32)">GetSubset(Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Generates a subset of the rows from the result set</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;ResultSetSubset&gt; GetSubset(int startRow, int rowCount)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">startRow</span></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><p>How many rows to retrieve</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.ResultSetSubset.html">ResultSetSubset</a>&gt;</td>
<td><p>A subset of results</p>
</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_ResultSet_ReadResultToEnd_System_Threading_CancellationToken_.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.ReadResultToEnd(System.Threading.CancellationToken)%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L246">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_ReadResultToEnd_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.ReadResultToEnd*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_ReadResultToEnd_System_Threading_CancellationToken_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.ReadResultToEnd(System.Threading.CancellationToken)">ReadResultToEnd(CancellationToken)</h4>
<div class="markdown level1 summary"><p>Reads from the reader until there are no more results to read</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task ReadResultToEnd(CancellationToken cancellationToken)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.CancellationToken</span></td>
<td><span class="parametername">cancellationToken</span></td>
<td><p>Cancellation token for cancelling the query</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="events">Events
</h3>
<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_ResultSet_ResultCompletion.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.ResultCompletion%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L121">View Source</a>
</span>
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet_ResultCompletion" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet.ResultCompletion">ResultCompletion</h4>
<div class="markdown level1 summary"><p>Event that will be called when the result set has completed execution</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event ResultSet.ResultSetAsyncEventHandler ResultCompletion</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>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_QueryExecution_ResultSet.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.ResultSet%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="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs/#L23" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</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>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink