mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-23 09:35:38 -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="Class Validate
|
||||
">
|
||||
<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_Utility_Validate.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.Validate%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/Utility/Validate.cs/#L15" class="pull-right mobile-hide">View Source</a>
|
||||
<h1 id="Microsoft_SqlTools_ServiceLayer_Utility_Validate" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate">Class Validate
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Provides common validation methods to simplify method
|
||||
@@ -80,30 +83,6 @@ parameter checks.</p>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">Validate</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.Utility</h6>
|
||||
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
|
||||
<h5 id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_syntax">Syntax</h5>
|
||||
@@ -119,7 +98,6 @@ parameter checks.</p>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/Validate.cs/#L88">View Source</a>
|
||||
</span>
|
||||
<a id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsGreaterThan_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsGreaterThan*"></a>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsGreaterThan_System_String_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsGreaterThan(System.String,System.Int32,System.Int32)">IsGreaterThan(String, Int32, Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>Throws ArgumentOutOfRangeException if the value is less than or equal
|
||||
to the given lower limit.</p>
|
||||
@@ -141,19 +119,19 @@ to the given lower limit.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">parameterName</span></td>
|
||||
<td><em>parameterName</em></td>
|
||||
<td><p>The name of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">valueToCheck</span></td>
|
||||
<td><em>valueToCheck</em></td>
|
||||
<td><p>The value of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">lowerLimit</span></td>
|
||||
<td><em>lowerLimit</em></td>
|
||||
<td><p>The lower limit which the value should be greater than.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -166,7 +144,6 @@ to the given lower limit.</p>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/Validate.cs/#L65">View Source</a>
|
||||
</span>
|
||||
<a id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsLessThan_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsLessThan*"></a>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsLessThan_System_String_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsLessThan(System.String,System.Int32,System.Int32)">IsLessThan(String, Int32, Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>Throws ArgumentOutOfRangeException if the value is greater than or equal
|
||||
to the given upper limit.</p>
|
||||
@@ -188,19 +165,19 @@ to the given upper limit.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">parameterName</span></td>
|
||||
<td><em>parameterName</em></td>
|
||||
<td><p>The name of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">valueToCheck</span></td>
|
||||
<td><em>valueToCheck</em></td>
|
||||
<td><p>The value of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">upperLimit</span></td>
|
||||
<td><em>upperLimit</em></td>
|
||||
<td><p>The upper limit which the value should be less than.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -213,7 +190,6 @@ to the given upper limit.</p>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/Validate.cs/#L111">View Source</a>
|
||||
</span>
|
||||
<a id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsNotEqual_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsNotEqual*"></a>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsNotEqual__1_System_String___0___0_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsNotEqual``1(System.String,``0,``0)">IsNotEqual<TValue>(String, TValue, TValue)</h4>
|
||||
<div class="markdown level1 summary"><p>Throws ArgumentException if the value is equal to the undesired value. </p>
|
||||
</div>
|
||||
@@ -234,39 +210,24 @@ to the given upper limit.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">parameterName</span></td>
|
||||
<td><em>parameterName</em></td>
|
||||
<td><p>The name of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">TValue</span></td>
|
||||
<td><span class="parametername">valueToCheck</span></td>
|
||||
<td><em>valueToCheck</em></td>
|
||||
<td><p>The value of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">TValue</span></td>
|
||||
<td><span class="parametername">undesiredValue</span></td>
|
||||
<td><em>undesiredValue</em></td>
|
||||
<td><p>The value that valueToCheck should not equal.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="typeParameters">Type Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="parametername">TValue</span></td>
|
||||
<td>The type of value to be validated.</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_Utility_Validate_IsNotNull_System_String_System_Object_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsNotNull(System.String%2CSystem.Object)%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>
|
||||
@@ -274,7 +235,6 @@ to the given upper limit.</p>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/Validate.cs/#L22">View Source</a>
|
||||
</span>
|
||||
<a id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsNotNull_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsNotNull*"></a>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsNotNull_System_String_System_Object_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsNotNull(System.String,System.Object)">IsNotNull(String, Object)</h4>
|
||||
<div class="markdown level1 summary"><p>Throws ArgumentNullException if value is null.</p>
|
||||
</div>
|
||||
@@ -295,13 +255,13 @@ to the given upper limit.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">parameterName</span></td>
|
||||
<td><em>parameterName</em></td>
|
||||
<td><p>The name of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Object</span></td>
|
||||
<td><span class="parametername">valueToCheck</span></td>
|
||||
<td><em>valueToCheck</em></td>
|
||||
<td><p>The value of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -314,7 +274,6 @@ to the given upper limit.</p>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/Validate.cs/#L132">View Source</a>
|
||||
</span>
|
||||
<a id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsNotNullOrEmptyString_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsNotNullOrEmptyString*"></a>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsNotNullOrEmptyString_System_String_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsNotNullOrEmptyString(System.String,System.String)">IsNotNullOrEmptyString(String, String)</h4>
|
||||
<div class="markdown level1 summary"><p>Throws ArgumentException if the value is null or an empty string.</p>
|
||||
</div>
|
||||
@@ -335,13 +294,13 @@ to the given upper limit.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">parameterName</span></td>
|
||||
<td><em>parameterName</em></td>
|
||||
<td><p>The name of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">valueToCheck</span></td>
|
||||
<td><em>valueToCheck</em></td>
|
||||
<td><p>The value of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -354,7 +313,6 @@ to the given upper limit.</p>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/Validate.cs/#L148">View Source</a>
|
||||
</span>
|
||||
<a id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsNotNullOrWhitespaceString_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsNotNullOrWhitespaceString*"></a>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsNotNullOrWhitespaceString_System_String_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsNotNullOrWhitespaceString(System.String,System.String)">IsNotNullOrWhitespaceString(String, String)</h4>
|
||||
<div class="markdown level1 summary"><p>Throws ArgumentException if the value is null, an empty string,
|
||||
or a string containing only whitespace.</p>
|
||||
@@ -376,13 +334,13 @@ or a string containing only whitespace.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">parameterName</span></td>
|
||||
<td><em>parameterName</em></td>
|
||||
<td><p>The name of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">valueToCheck</span></td>
|
||||
<td><em>valueToCheck</em></td>
|
||||
<td><p>The value of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -395,7 +353,6 @@ or a string containing only whitespace.</p>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/Validate.cs/#L38">View Source</a>
|
||||
</span>
|
||||
<a id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsWithinRange_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsWithinRange*"></a>
|
||||
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_Validate_IsWithinRange_System_String_System_Int32_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsWithinRange(System.String,System.Int32,System.Int32,System.Int32)">IsWithinRange(String, Int32, Int32, Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>Throws ArgumentOutOfRangeException if the value is outside
|
||||
of the given lower and upper limits.</p>
|
||||
@@ -417,25 +374,25 @@ of the given lower and upper limits.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">parameterName</span></td>
|
||||
<td><em>parameterName</em></td>
|
||||
<td><p>The name of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">valueToCheck</span></td>
|
||||
<td><em>valueToCheck</em></td>
|
||||
<td><p>The value of the parameter being validated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">lowerLimit</span></td>
|
||||
<td><em>lowerLimit</em></td>
|
||||
<td><p>The lower limit which the value should not be less than.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">upperLimit</span></td>
|
||||
<td><em>upperLimit</em></td>
|
||||
<td><p>The upper limit which the value should not be greater than.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -465,16 +422,9 @@ of the given lower and upper limits.</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 // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user