mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-14 01:25:40 -05:00
* Initial commit for GitHub IO pages * Add initial doxfx content * Update manifest.json * Update manifest.json * Set theme jekyll-theme-cayman * Set theme jekyll-theme-slate * Set theme jekyll-theme-minimal * Set theme jekyll-theme-tactile * Clear out theme setting * Remove API docs * Revert "Adding Milliseconds to DateTime fields (#173)" (#197) This reverts commit431dfa4156. * ported new BatchParser * added BatchParser tests * fixing merge conflicts * fix build issues * cleaned code and addressed comments from code review * addressed code review and made BatchParser logic more efficient * fixed batch parser tests * changed class name to fix build issues * fixed merge conflicts * added path for lab mode baseline tests * changed env path for lab mode * added env variable to appveyor * testing env variable for appveyor * fixed lab build * debug appveyor build * testing changes for appveyor * changed trace env path * debugging appveyor build * changed baseline env path * debugging * debugging * debugging * switched on trace flag * debugging * debugging * changed build config * changed baseline files * checking baseline output * changed baseline files * debug baseline tests * debugging baseline * debugging * debugging * debug * debugging * testing baseline format * debug * debug * debug * debug * debug * newline debug * changed baseline file * debug * test * try new way to read * added execution engine tests * change test * testing file encoding * moved execution engine tests to integration * try compare without spaces * removed no op test * added env variable for travis * put batch parser tests to integration too * put batch parser in integration * try new baseline string match * compare baseline test logic changed * changed baseline logic as well as cleaned tests * fix build for travis CI * fix travis CI issues * fixed highlighting bugs on vscode * code review changes * ported new BatchParser * added BatchParser tests * Initial commit for GitHub IO pages * Add initial doxfx content * Update manifest.json * Update manifest.json * Set theme jekyll-theme-cayman * Set theme jekyll-theme-slate * Set theme jekyll-theme-minimal * Set theme jekyll-theme-tactile * Clear out theme setting * Remove API docs * Revert "Adding Milliseconds to DateTime fields (#173)" (#197) This reverts commit431dfa4156. * fixing merge conflicts * fix build issues * cleaned code and addressed comments from code review * addressed code review and made BatchParser logic more efficient * fixed batch parser tests * changed class name to fix build issues * fixed merge conflicts * added path for lab mode baseline tests changed env path for lab mode added env variable to appveyor testing env variable for appveyor fixed lab build debug appveyor build testing changes for appveyor changed trace env path debugging appveyor build changed baseline env path debugging debugging debugging switched on trace flag debugging debugging changed build config changed baseline files checking baseline output changed baseline files debug baseline tests debugging baseline debugging debugging debug debugging testing baseline format debug debug debug debug debug newline debug changed baseline file debug test try new way to read added execution engine tests change test testing file encoding moved execution engine tests to integration try compare without spaces removed no op test added env variable for travis * put batch parser tests to integration too * put batch parser in integration try new baseline string match * compare baseline test logic changed * changed baseline logic as well as cleaned tests * fix build for travis CI * fix travis CI issues * fixed highlighting bugs on vscode * code review changes * fixed filestream writer test * added localization string * added localization string * generated new string files again * code review changes
486 lines
28 KiB
HTML
486 lines
28 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class Validate
|
|
</title>
|
|
<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="../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_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
|
|
parameter checks.</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">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>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static class Validate</code></pre>
|
|
</div>
|
|
<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_Utility_Validate_IsGreaterThan_System_String_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsGreaterThan(System.String%2CSystem.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/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>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void IsGreaterThan(string parameterName, int valueToCheck, int lowerLimit)</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.String</span></td>
|
|
<td><span class="parametername">parameterName</span></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><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><p>The lower limit which the value should be greater than.</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_Utility_Validate_IsLessThan_System_String_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsLessThan(System.String%2CSystem.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/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>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void IsLessThan(string parameterName, int valueToCheck, int upperLimit)</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.String</span></td>
|
|
<td><span class="parametername">parameterName</span></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><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><p>The upper limit which the value should be less than.</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_Utility_Validate_IsNotEqual__1_System_String___0___0_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsNotEqual%60%601(System.String%2C%60%600%2C%60%600)%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/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>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void IsNotEqual<TValue>(string parameterName, TValue valueToCheck, TValue undesiredValue)</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.String</span></td>
|
|
<td><span class="parametername">parameterName</span></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><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><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>
|
|
</span>
|
|
<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>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void IsNotNull(string parameterName, object valueToCheck)</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.String</span></td>
|
|
<td><span class="parametername">parameterName</span></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><p>The value of the parameter being validated.</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_Utility_Validate_IsNotNullOrEmptyString_System_String_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsNotNullOrEmptyString(System.String%2CSystem.String)%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/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>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void IsNotNullOrEmptyString(string parameterName, string valueToCheck)</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.String</span></td>
|
|
<td><span class="parametername">parameterName</span></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><p>The value of the parameter being validated.</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_Utility_Validate_IsNotNullOrWhitespaceString_System_String_System_String_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsNotNullOrWhitespaceString(System.String%2CSystem.String)%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/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>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void IsNotNullOrWhitespaceString(string parameterName, string valueToCheck)</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.String</span></td>
|
|
<td><span class="parametername">parameterName</span></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><p>The value of the parameter being validated.</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_Utility_Validate_IsWithinRange_System_String_System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.Validate.IsWithinRange(System.String%2CSystem.Int32%2CSystem.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/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>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void IsWithinRange(string parameterName, int valueToCheck, int lowerLimit, int upperLimit)</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.String</span></td>
|
|
<td><span class="parametername">parameterName</span></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><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><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><p>The upper limit which the value should not be greater than.</p>
|
|
</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_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="contribution-link">Improve this Doc</a>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Utility/Validate.cs/#L15" 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>
|