mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-23 01:25:42 -05:00
245 lines
14 KiB
HTML
245 lines
14 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 Logger
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class Logger
|
|
">
|
|
|
|
<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/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">
|
|
<!--
|
|
<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 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">
|
|
<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">
|
|
|
|
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_Utility_Logger.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.Logger%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/Logger.cs/#L44" class="pull-right mobile-hide">View Source</a>
|
|
<h1 id="Microsoft_SqlTools_ServiceLayer_Utility_Logger" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Logger">Class Logger
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Provides a simple logging interface. May be replaced with a
|
|
more robust solution at a later date.</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">Logger</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_Logger_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static class Logger</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_Logger_Close.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.Logger.Close%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/Logger.cs/#L114">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_Logger_Close" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Logger.Close">Close()</h4>
|
|
<div class="markdown level1 summary"><p>Closes the Logger.</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 Close()</code></pre>
|
|
</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_Utility_Logger_Initialize_System_String_Microsoft_SqlTools_ServiceLayer_Utility_LogLevel_System_Boolean_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.Logger.Initialize(System.String%2CMicrosoft.SqlTools.ServiceLayer.Utility.LogLevel%2CSystem.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/Utility/Logger.cs/#L61">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_Logger_Initialize_System_String_Microsoft_SqlTools_ServiceLayer_Utility_LogLevel_System_Boolean_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Logger.Initialize(System.String,Microsoft.SqlTools.ServiceLayer.Utility.LogLevel,System.Boolean)">Initialize(String, LogLevel, Boolean)</h4>
|
|
<div class="markdown level1 summary"><p>Initializes the Logger for the current session.</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 Initialize(string logFilePath = "sqltools", LogLevel minimumLogLevel = LogLevel.Normal, bool isEnabled = true)</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><em>logFilePath</em></td>
|
|
<td><p>Optional. Specifies the path at which log messages will be written.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Utility.LogLevel.html">LogLevel</a></td>
|
|
<td><em>minimumLogLevel</em></td>
|
|
<td><p>Optional. Specifies the minimum log message level to write to the log file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><em>isEnabled</em></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_Utility_Logger_Write_Microsoft_SqlTools_ServiceLayer_Utility_LogLevel_System_String_System_String_System_String_System_Int32_.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.Logger.Write(Microsoft.SqlTools.ServiceLayer.Utility.LogLevel%2CSystem.String%2CSystem.String%2CSystem.String%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/Logger.cs/#L130">View Source</a>
|
|
</span>
|
|
<h4 id="Microsoft_SqlTools_ServiceLayer_Utility_Logger_Write_Microsoft_SqlTools_ServiceLayer_Utility_LogLevel_System_String_System_String_System_String_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.Utility.Logger.Write(Microsoft.SqlTools.ServiceLayer.Utility.LogLevel,System.String,System.String,System.String,System.Int32)">Write(LogLevel, String, String, String, Int32)</h4>
|
|
<div class="markdown level1 summary"><p>Writes a message to the log file.</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 Write(LogLevel logLevel, string logMessage, string callerName = null, string callerSourceFile = null, int callerLineNumber = 0)</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><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Utility.LogLevel.html">LogLevel</a></td>
|
|
<td><em>logLevel</em></td>
|
|
<td><p>The level at which the message will be written.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><em>logMessage</em></td>
|
|
<td><p>The message text to be written.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><em>callerName</em></td>
|
|
<td><p>The name of the calling method.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><em>callerSourceFile</em></td>
|
|
<td><p>The source file path where the calling method exists.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><em>callerLineNumber</em></td>
|
|
<td><p>The line number of the calling method.</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_Logger.md&value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Utility.Logger%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/Logger.cs/#L44" 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="inner-footer">
|
|
<p>© Microsoft // Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
|
|
</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>
|