You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

349 lines
17 KiB

  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class PluginLogFilePrinter
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class PluginLogFilePrinter
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <link rel="stylesheet" href="../styles/fix.css">
  18. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../">
  22. <meta property="docfx:newtab" content="true">
  23. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  24. <div id="wrapper">
  25. <header>
  26. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  27. <div class="container">
  28. <div class="navbar-header">
  29. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  30. <span class="sr-only">Toggle navigation</span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. <span class="icon-bar"></span>
  34. </button>
  35. <a class="navbar-brand" href="../index.html">
  36. <img id="logo" class="svg" src="../logo.svg" alt="">
  37. </a>
  38. </div>
  39. <div class="collapse navbar-collapse" id="navbar">
  40. <form class="navbar-form navbar-right" role="search" id="search">
  41. <div class="form-group">
  42. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  43. </div>
  44. </form>
  45. </div>
  46. </div>
  47. </nav>
  48. <div class="subnav navbar navbar-default">
  49. <div class="container hide-when-search" id="breadcrumb">
  50. <ul class="breadcrumb">
  51. <li></li>
  52. </ul>
  53. </div>
  54. </div>
  55. </header>
  56. <div class="container body-content">
  57. <div id="search-results">
  58. <div class="search-list">Search Results for <span></span></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  63. </div>
  64. </div>
  65. <div role="main" class="container body-content hide-when-search">
  66. <div class="sidenav hide-when-search">
  67. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  68. <div class="sidetoggle collapse" id="sidetoggle">
  69. <div id="sidetoc"></div>
  70. </div>
  71. </div>
  72. <div class="article row grid-right">
  73. <div class="col-md-10">
  74. <article class="content wrap" id="_content" data-uid="IPA.Logging.Printers.PluginLogFilePrinter">
  75. <h1 id="IPA_Logging_Printers_PluginLogFilePrinter" data-uid="IPA.Logging.Printers.PluginLogFilePrinter" class="text-break">Class PluginLogFilePrinter
  76. </h1>
  77. <div class="markdown level0 summary"><p>Prints log messages to the file specified by the name.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  83. <div class="level1"><a class="xref" href="IPA.Logging.LogPrinter.html">LogPrinter</a></div>
  84. <div class="level2"><a class="xref" href="IPA.Logging.Printers.GZFilePrinter.html">GZFilePrinter</a></div>
  85. <div class="level3"><span class="xref">PluginLogFilePrinter</span></div>
  86. </div>
  87. <div class="implements">
  88. <h5>Implements</h5>
  89. <div><span class="xref">IDisposable</span></div>
  90. </div>
  91. <div class="inheritedMembers">
  92. <h5>Inherited Members</h5>
  93. <div>
  94. <a class="xref" href="IPA.Logging.Printers.GZFilePrinter.html#IPA_Logging_Printers_GZFilePrinter_FileWriter">GZFilePrinter.FileWriter</a>
  95. </div>
  96. <div>
  97. <a class="xref" href="IPA.Logging.Printers.GZFilePrinter.html#IPA_Logging_Printers_GZFilePrinter_StartPrint">GZFilePrinter.StartPrint()</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="IPA.Logging.Printers.GZFilePrinter.html#IPA_Logging_Printers_GZFilePrinter_EndPrint">GZFilePrinter.EndPrint()</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="IPA.Logging.Printers.GZFilePrinter.html#IPA_Logging_Printers_GZFilePrinter_Dispose">GZFilePrinter.Dispose()</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="IPA.Logging.Printers.GZFilePrinter.html#IPA_Logging_Printers_GZFilePrinter_Dispose_System_Boolean_">GZFilePrinter.Dispose(Boolean)</a>
  107. </div>
  108. </div>
  109. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Logging.Printers.html">IPA.Logging.Printers</a></h6>
  110. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  111. <h5 id="IPA_Logging_Printers_PluginLogFilePrinter_syntax">Syntax</h5>
  112. <div class="codewrapper">
  113. <pre><code class="lang-csharp hljs">public class PluginLogFilePrinter : GZFilePrinter</code></pre>
  114. </div>
  115. <h3 id="constructors">Constructors
  116. </h3>
  117. <span class="small pull-right mobile-hide">
  118. <span class="divider">|</span>
  119. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_PluginLogFilePrinter__ctor_System_String_.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.PluginLogFilePrinter.%23ctor(System.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>
  120. </span>
  121. <span class="small pull-right mobile-hide">
  122. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Logging/Printers/PluginLogFilePrinter.cs/#L36">View Source</a>
  123. </span>
  124. <a id="IPA_Logging_Printers_PluginLogFilePrinter__ctor_" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.#ctor*"></a>
  125. <h4 id="IPA_Logging_Printers_PluginLogFilePrinter__ctor_System_String_" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.#ctor(System.String)">PluginLogFilePrinter(String)</h4>
  126. <div class="markdown level1 summary"><p>Creates a new printer with the given name.</p>
  127. </div>
  128. <div class="markdown level1 conceptual"></div>
  129. <h5 class="decalaration">Declaration</h5>
  130. <div class="codewrapper">
  131. <pre><code class="lang-csharp hljs">public PluginLogFilePrinter(string name)</code></pre>
  132. </div>
  133. <h5 class="parameters">Parameters</h5>
  134. <table class="table table-bordered table-striped table-condensed">
  135. <thead>
  136. <tr>
  137. <th>Type</th>
  138. <th>Name</th>
  139. <th>Description</th>
  140. </tr>
  141. </thead>
  142. <tbody>
  143. <tr>
  144. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  145. <td><span class="parametername">name</span></td>
  146. <td><p>the name of the logger</p>
  147. </td>
  148. </tr>
  149. </tbody>
  150. </table>
  151. <h3 id="properties">Properties
  152. </h3>
  153. <span class="small pull-right mobile-hide">
  154. <span class="divider">|</span>
  155. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_PluginLogFilePrinter_Filter.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.PluginLogFilePrinter.Filter%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>
  156. </span>
  157. <span class="small pull-right mobile-hide">
  158. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Logging/Printers/PluginLogFilePrinter.cs/#L16">View Source</a>
  159. </span>
  160. <a id="IPA_Logging_Printers_PluginLogFilePrinter_Filter_" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.Filter*"></a>
  161. <h4 id="IPA_Logging_Printers_PluginLogFilePrinter_Filter" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.Filter">Filter</h4>
  162. <div class="markdown level1 summary"><p>Provides a filter for this specific printer.</p>
  163. </div>
  164. <div class="markdown level1 conceptual"></div>
  165. <h5 class="decalaration">Declaration</h5>
  166. <div class="codewrapper">
  167. <pre><code class="lang-csharp hljs">public override Logger.LogLevel Filter { get; set; }</code></pre>
  168. </div>
  169. <h5 class="propertyValue">Property Value</h5>
  170. <table class="table table-bordered table-striped table-condensed">
  171. <thead>
  172. <tr>
  173. <th>Type</th>
  174. <th>Description</th>
  175. </tr>
  176. </thead>
  177. <tbody>
  178. <tr>
  179. <td><a class="xref" href="IPA.Logging.Logger.LogLevel.html">Logger.LogLevel</a></td>
  180. <td><p>the filter level for this printer</p>
  181. </td>
  182. </tr>
  183. </tbody>
  184. </table>
  185. <h5 class="overrides">Overrides</h5>
  186. <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Filter">LogPrinter.Filter</a></div>
  187. <h3 id="methods">Methods
  188. </h3>
  189. <span class="small pull-right mobile-hide">
  190. <span class="divider">|</span>
  191. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_PluginLogFilePrinter_GetFileInfo.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.PluginLogFilePrinter.GetFileInfo%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>
  192. </span>
  193. <span class="small pull-right mobile-hide">
  194. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Logging/Printers/PluginLogFilePrinter.cs/#L24">View Source</a>
  195. </span>
  196. <a id="IPA_Logging_Printers_PluginLogFilePrinter_GetFileInfo_" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.GetFileInfo*"></a>
  197. <h4 id="IPA_Logging_Printers_PluginLogFilePrinter_GetFileInfo" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.GetFileInfo">GetFileInfo()</h4>
  198. <div class="markdown level1 summary"><p>Gets the <see cref="!:FileInfo"></see> for the target file.</p>
  199. </div>
  200. <div class="markdown level1 conceptual"></div>
  201. <h5 class="decalaration">Declaration</h5>
  202. <div class="codewrapper">
  203. <pre><code class="lang-csharp hljs">protected override FileInfo GetFileInfo()</code></pre>
  204. </div>
  205. <h5 class="returns">Returns</h5>
  206. <table class="table table-bordered table-striped table-condensed">
  207. <thead>
  208. <tr>
  209. <th>Type</th>
  210. <th>Description</th>
  211. </tr>
  212. </thead>
  213. <tbody>
  214. <tr>
  215. <td><span class="xref">FileInfo</span></td>
  216. <td><p>the file to write to</p>
  217. </td>
  218. </tr>
  219. </tbody>
  220. </table>
  221. <h5 class="overrides">Overrides</h5>
  222. <div><a class="xref" href="IPA.Logging.Printers.GZFilePrinter.html#IPA_Logging_Printers_GZFilePrinter_GetFileInfo">GZFilePrinter.GetFileInfo()</a></div>
  223. <span class="small pull-right mobile-hide">
  224. <span class="divider">|</span>
  225. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_PluginLogFilePrinter_Print_IPA_Logging_Logger_Level_DateTime_System_String_System_String_.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.PluginLogFilePrinter.Print(IPA.Logging.Logger.Level%2CDateTime%2CSystem.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>
  226. </span>
  227. <span class="small pull-right mobile-hide">
  228. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Logging/Printers/PluginLogFilePrinter.cs/#L48">View Source</a>
  229. </span>
  230. <a id="IPA_Logging_Printers_PluginLogFilePrinter_Print_" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.Print*"></a>
  231. <h4 id="IPA_Logging_Printers_PluginLogFilePrinter_Print_IPA_Logging_Logger_Level_DateTime_System_String_System_String_" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.Print(IPA.Logging.Logger.Level,DateTime,System.String,System.String)">Print(Logger.Level, DateTime, String, String)</h4>
  232. <div class="markdown level1 summary"><p>Prints an entry to the associated file.</p>
  233. </div>
  234. <div class="markdown level1 conceptual"></div>
  235. <h5 class="decalaration">Declaration</h5>
  236. <div class="codewrapper">
  237. <pre><code class="lang-csharp hljs">public override void Print(Logger.Level level, DateTime time, string logName, string message)</code></pre>
  238. </div>
  239. <h5 class="parameters">Parameters</h5>
  240. <table class="table table-bordered table-striped table-condensed">
  241. <thead>
  242. <tr>
  243. <th>Type</th>
  244. <th>Name</th>
  245. <th>Description</th>
  246. </tr>
  247. </thead>
  248. <tbody>
  249. <tr>
  250. <td><a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a></td>
  251. <td><span class="parametername">level</span></td>
  252. <td><p>the <a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a> of the message</p>
  253. </td>
  254. </tr>
  255. <tr>
  256. <td><span class="xref">DateTime</span></td>
  257. <td><span class="parametername">time</span></td>
  258. <td><p>the <see cref="!:DateTime"></see> the message was recorded at</p>
  259. </td>
  260. </tr>
  261. <tr>
  262. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  263. <td><span class="parametername">logName</span></td>
  264. <td><p>the name of the log that sent the message</p>
  265. </td>
  266. </tr>
  267. <tr>
  268. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  269. <td><span class="parametername">message</span></td>
  270. <td><p>the message to print</p>
  271. </td>
  272. </tr>
  273. </tbody>
  274. </table>
  275. <h5 class="overrides">Overrides</h5>
  276. <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Print_IPA_Logging_Logger_Level_DateTime_System_String_System_String_">LogPrinter.Print(Logger.Level, DateTime, String, String)</a></div>
  277. <h3 id="implements">Implements</h3>
  278. <div>
  279. <span class="xref">IDisposable</span>
  280. </div>
  281. <h3 id="extensionmethods">Extension Methods</h3>
  282. <div>
  283. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__2___0_System_String___1_">ReflectionUtil.SetField&lt;T, U&gt;(T, String, U)</a>
  284. </div>
  285. <div>
  286. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField&lt;U, T&gt;(T, String)</a>
  287. </div>
  288. <div>
  289. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty&lt;T, U&gt;(T, String, U)</a>
  290. </div>
  291. <div>
  292. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty&lt;U, T&gt;(T, String)</a>
  293. </div>
  294. <div>
  295. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;U, T&gt;(T, String, Object[])</a>
  296. </div>
  297. </article>
  298. </div>
  299. <div class="hidden-sm col-md-2" role="complementary">
  300. <div class="sideaffix">
  301. <div class="contribution">
  302. <ul class="nav">
  303. <li>
  304. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_PluginLogFilePrinter.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.PluginLogFilePrinter%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>
  305. </li>
  306. <li>
  307. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Logging/Printers/PluginLogFilePrinter.cs/#L10" class="contribution-link">View Source</a>
  308. </li>
  309. </ul>
  310. </div>
  311. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  312. <h5>In This Article</h5>
  313. <div></div>
  314. </nav>
  315. </div>
  316. </div>
  317. </div>
  318. </div>
  319. <footer>
  320. <div class="grad-bottom"></div>
  321. <div class="footer">
  322. <div class="container">
  323. <span class="pull-right">
  324. <a href="#top">Back to top</a>
  325. </span>
  326. <span>Generated by <strong>DocFX</strong></span>
  327. </div>
  328. </div>
  329. </footer>
  330. </div>
  331. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  332. <script type="text/javascript" src="../styles/docfx.js"></script>
  333. <script type="text/javascript" src="../styles/main.js"></script>
  334. </body>
  335. </html>