mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-23 01:25:42 -05:00
Add docs template
This commit is contained in:
Karl Burtram
@@ -10,43 +10,45 @@
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Struct FileStreamReadResult
|
||||
">
|
||||
<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,34 +70,14 @@
|
||||
<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_DataStorage_FileStreamReadResult.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult%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/DataStorage/FileStreamReadResult.cs/#L14" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_DataStorage_FileStreamReadResult" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult">Struct FileStreamReadResult
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Represents a value returned from a read from a file stream. This is used to eliminate ref
|
||||
parameters used in the read methods.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritedMembers">
|
||||
<h5>Inherited Members</h5>
|
||||
<div>
|
||||
<span class="xref">System.ValueType.Equals(System.Object)</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.ValueType.GetHashCode()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.ValueType.ToString()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.GetType()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
||||
</div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_DataStorage_FileStreamReadResult_syntax">Syntax</h5>
|
||||
@@ -111,7 +93,6 @@ parameters used in the read methods.</p>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/DataStorage/FileStreamReadResult.cs/#L38">View Source</a>
|
||||
</span>
|
||||
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_DataStorage_FileStreamReadResult__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.#ctor*"></a>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_DataStorage_FileStreamReadResult__ctor_Microsoft_SqlTools_ServiceLayer_QueryExecution_Contracts_DbCellValue_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.#ctor(Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbCellValue,System.Int32)">FileStreamReadResult(DbCellValue, Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>Constructs a new FileStreamReadResult</p>
|
||||
</div>
|
||||
@@ -132,13 +113,13 @@ parameters used in the read methods.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts.DbCellValue.html">DbCellValue</a></td>
|
||||
<td><span class="parametername">value</span></td>
|
||||
<td><em>value</em></td>
|
||||
<td><p>The value of the result, ready for consumption by a client</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">totalLength</span></td>
|
||||
<td><em>totalLength</em></td>
|
||||
<td><p>The number of bytes for the used to store the value's length and value</p>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -153,17 +134,22 @@ parameters used in the read methods.</p>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/DataStorage/FileStreamReadResult.cs/#L26">View Source</a>
|
||||
</span>
|
||||
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_DataStorage_FileStreamReadResult_TotalLength_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.TotalLength*"></a>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_DataStorage_FileStreamReadResult_TotalLength" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.TotalLength">TotalLength</h4>
|
||||
<div class="markdown level1 summary"><p>The total length in bytes of the value, (including the bytes used to store the length
|
||||
of the value)</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_DataStorage_FileStreamReadResult_TotalLength_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>Cell values are stored such that the length of the value is stored first, then the
|
||||
value itself is stored. Eg, a string may be stored as 0x03 0x6C 0x6F 0x6C. Under this
|
||||
system, the value would be "lol", the length would be 3, and the total length would be
|
||||
4 bytes.</p>
|
||||
</div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int TotalLength { 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>
|
||||
@@ -178,12 +164,6 @@ of the value)</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_DataStorage_FileStreamReadResult_TotalLength_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>Cell values are stored such that the length of the value is stored first, then the
|
||||
value itself is stored. Eg, a string may be stored as 0x03 0x6C 0x6F 0x6C. Under this
|
||||
system, the value would be "lol", the length would be 3, and the total length would be
|
||||
4 bytes.</p>
|
||||
</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_DataStorage_FileStreamReadResult_Value.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.Value%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>
|
||||
@@ -191,7 +171,6 @@ system, the value would be "lol", the length would be 3, and the total
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/DataStorage/FileStreamReadResult.cs/#L31">View Source</a>
|
||||
</span>
|
||||
<a id="Microsoft_SqlTools_ServiceLayer_QueryExecution_DataStorage_FileStreamReadResult_Value_" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.Value*"></a>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_QueryExecution_DataStorage_FileStreamReadResult_Value" data-uid="Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage.FileStreamReadResult.Value">Value</h4>
|
||||
<div class="markdown level1 summary"><p>Value of the cell</p>
|
||||
</div>
|
||||
@@ -200,7 +179,7 @@ system, the value would be "lol", the length would be 3, and the total
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public DbCellValue Value { 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>
|
||||
@@ -239,16 +218,9 @@ system, the value would be "lol", the length would be 3, and the total
|
||||
</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 // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user