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.

369 lines
19 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.48.0.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"></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination"></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 classs="implements">
  88. <h5>Implements</h5>
  89. <div><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></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. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  110. </div>
  111. <div>
  112. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  113. </div>
  114. <div>
  115. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_System_Object_">Object.Equals(Object, Object)</a>
  116. </div>
  117. <div>
  118. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#System_Object_ReferenceEquals_System_Object_System_Object_">Object.ReferenceEquals(Object, Object)</a>
  119. </div>
  120. <div>
  121. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  122. </div>
  123. <div>
  124. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  125. </div>
  126. <div>
  127. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  128. </div>
  129. </div>
  130. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Logging.Printers.html">IPA.Logging.Printers</a></h6>
  131. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  132. <h5 id="IPA_Logging_Printers_PluginLogFilePrinter_syntax">Syntax</h5>
  133. <div class="codewrapper">
  134. <pre><code class="lang-csharp hljs">public class PluginLogFilePrinter : GZFilePrinter, IDisposable</code></pre>
  135. </div>
  136. <h3 id="constructors">Constructors
  137. </h3>
  138. <span class="small pull-right mobile-hide">
  139. <span class="divider">|</span>
  140. <a href="https://github.com/bsmg/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>
  141. </span>
  142. <span class="small pull-right mobile-hide">
  143. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/9e375e6e917bc37121a9bd6ea1c949edc41786ef/IPA.Loader/Logging/Printers/PluginLogFilePrinter.cs/#L36">View Source</a>
  144. </span>
  145. <a id="IPA_Logging_Printers_PluginLogFilePrinter__ctor_" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.#ctor*"></a>
  146. <h4 id="IPA_Logging_Printers_PluginLogFilePrinter__ctor_System_String_" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.#ctor(System.String)">PluginLogFilePrinter(String)</h4>
  147. <div class="markdown level1 summary"><p>Creates a new printer with the given name.</p>
  148. </div>
  149. <div class="markdown level1 conceptual"></div>
  150. <h5 class="decalaration">Declaration</h5>
  151. <div class="codewrapper">
  152. <pre><code class="lang-csharp hljs">public PluginLogFilePrinter(string name)</code></pre>
  153. </div>
  154. <h5 class="parameters">Parameters</h5>
  155. <table class="table table-bordered table-striped table-condensed">
  156. <thead>
  157. <tr>
  158. <th>Type</th>
  159. <th>Name</th>
  160. <th>Description</th>
  161. </tr>
  162. </thead>
  163. <tbody>
  164. <tr>
  165. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  166. <td><span class="parametername">name</span></td>
  167. <td><p>the name of the logger</p>
  168. </td>
  169. </tr>
  170. </tbody>
  171. </table>
  172. <h3 id="properties">Properties
  173. </h3>
  174. <span class="small pull-right mobile-hide">
  175. <span class="divider">|</span>
  176. <a href="https://github.com/bsmg/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>
  177. </span>
  178. <span class="small pull-right mobile-hide">
  179. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/9e375e6e917bc37121a9bd6ea1c949edc41786ef/IPA.Loader/Logging/Printers/PluginLogFilePrinter.cs/#L16">View Source</a>
  180. </span>
  181. <a id="IPA_Logging_Printers_PluginLogFilePrinter_Filter_" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.Filter*"></a>
  182. <h4 id="IPA_Logging_Printers_PluginLogFilePrinter_Filter" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.Filter">Filter</h4>
  183. <div class="markdown level1 summary"><p>Provides a filter for this specific printer.</p>
  184. </div>
  185. <div class="markdown level1 conceptual"></div>
  186. <h5 class="decalaration">Declaration</h5>
  187. <div class="codewrapper">
  188. <pre><code class="lang-csharp hljs">public override Logger.LogLevel Filter { get; set; }</code></pre>
  189. </div>
  190. <h5 class="propertyValue">Property Value</h5>
  191. <table class="table table-bordered table-striped table-condensed">
  192. <thead>
  193. <tr>
  194. <th>Type</th>
  195. <th>Description</th>
  196. </tr>
  197. </thead>
  198. <tbody>
  199. <tr>
  200. <td><a class="xref" href="IPA.Logging.Logger.LogLevel.html">Logger.LogLevel</a></td>
  201. <td><p>the filter level for this printer</p>
  202. </td>
  203. </tr>
  204. </tbody>
  205. </table>
  206. <h5 class="overrides">Overrides</h5>
  207. <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Filter">LogPrinter.Filter</a></div>
  208. <h3 id="methods">Methods
  209. </h3>
  210. <span class="small pull-right mobile-hide">
  211. <span class="divider">|</span>
  212. <a href="https://github.com/bsmg/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>
  213. </span>
  214. <span class="small pull-right mobile-hide">
  215. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/9e375e6e917bc37121a9bd6ea1c949edc41786ef/IPA.Loader/Logging/Printers/PluginLogFilePrinter.cs/#L24">View Source</a>
  216. </span>
  217. <a id="IPA_Logging_Printers_PluginLogFilePrinter_GetFileInfo_" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.GetFileInfo*"></a>
  218. <h4 id="IPA_Logging_Printers_PluginLogFilePrinter_GetFileInfo" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.GetFileInfo">GetFileInfo()</h4>
  219. <div class="markdown level1 summary"><p>Gets the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a> for the target file.</p>
  220. </div>
  221. <div class="markdown level1 conceptual"></div>
  222. <h5 class="decalaration">Declaration</h5>
  223. <div class="codewrapper">
  224. <pre><code class="lang-csharp hljs">protected override FileInfo GetFileInfo()</code></pre>
  225. </div>
  226. <h5 class="returns">Returns</h5>
  227. <table class="table table-bordered table-striped table-condensed">
  228. <thead>
  229. <tr>
  230. <th>Type</th>
  231. <th>Description</th>
  232. </tr>
  233. </thead>
  234. <tbody>
  235. <tr>
  236. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a></td>
  237. <td><p>the file to write to</p>
  238. </td>
  239. </tr>
  240. </tbody>
  241. </table>
  242. <h5 class="overrides">Overrides</h5>
  243. <div><a class="xref" href="IPA.Logging.Printers.GZFilePrinter.html#IPA_Logging_Printers_GZFilePrinter_GetFileInfo">GZFilePrinter.GetFileInfo()</a></div>
  244. <span class="small pull-right mobile-hide">
  245. <span class="divider">|</span>
  246. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_PluginLogFilePrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.PluginLogFilePrinter.Print(IPA.Logging.Logger.Level%2CSystem.DateTime%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>
  247. </span>
  248. <span class="small pull-right mobile-hide">
  249. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/9e375e6e917bc37121a9bd6ea1c949edc41786ef/IPA.Loader/Logging/Printers/PluginLogFilePrinter.cs/#L48">View Source</a>
  250. </span>
  251. <a id="IPA_Logging_Printers_PluginLogFilePrinter_Print_" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.Print*"></a>
  252. <h4 id="IPA_Logging_Printers_PluginLogFilePrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_" data-uid="IPA.Logging.Printers.PluginLogFilePrinter.Print(IPA.Logging.Logger.Level,System.DateTime,System.String,System.String)">Print(Logger.Level, DateTime, String, String)</h4>
  253. <div class="markdown level1 summary"><p>Prints an entry to the associated file.</p>
  254. </div>
  255. <div class="markdown level1 conceptual"></div>
  256. <h5 class="decalaration">Declaration</h5>
  257. <div class="codewrapper">
  258. <pre><code class="lang-csharp hljs">public override void Print(Logger.Level level, DateTime time, string logName, string message)</code></pre>
  259. </div>
  260. <h5 class="parameters">Parameters</h5>
  261. <table class="table table-bordered table-striped table-condensed">
  262. <thead>
  263. <tr>
  264. <th>Type</th>
  265. <th>Name</th>
  266. <th>Description</th>
  267. </tr>
  268. </thead>
  269. <tbody>
  270. <tr>
  271. <td><a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a></td>
  272. <td><span class="parametername">level</span></td>
  273. <td><p>the <a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a> of the message</p>
  274. </td>
  275. </tr>
  276. <tr>
  277. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.datetime">DateTime</a></td>
  278. <td><span class="parametername">time</span></td>
  279. <td><p>the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.datetime">DateTime</a> the message was recorded at</p>
  280. </td>
  281. </tr>
  282. <tr>
  283. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  284. <td><span class="parametername">logName</span></td>
  285. <td><p>the name of the log that sent the message</p>
  286. </td>
  287. </tr>
  288. <tr>
  289. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  290. <td><span class="parametername">message</span></td>
  291. <td><p>the message to print</p>
  292. </td>
  293. </tr>
  294. </tbody>
  295. </table>
  296. <h5 class="overrides">Overrides</h5>
  297. <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_">LogPrinter.Print(Logger.Level, DateTime, String, String)</a></div>
  298. <h3 id="implements">Implements</h3>
  299. <div>
  300. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">System.IDisposable</a>
  301. </div>
  302. <h3 id="extensionmethods">Extension Methods</h3>
  303. <div>
  304. <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>
  305. </div>
  306. <div>
  307. <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>
  308. </div>
  309. <div>
  310. <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>
  311. </div>
  312. <div>
  313. <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>
  314. </div>
  315. <div>
  316. <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>
  317. </div>
  318. </article>
  319. </div>
  320. <div class="hidden-sm col-md-2" role="complementary">
  321. <div class="sideaffix">
  322. <div class="contribution">
  323. <ul class="nav">
  324. <li>
  325. <a href="https://github.com/bsmg/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>
  326. </li>
  327. <li>
  328. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/9e375e6e917bc37121a9bd6ea1c949edc41786ef/IPA.Loader/Logging/Printers/PluginLogFilePrinter.cs/#L10" class="contribution-link">View Source</a>
  329. </li>
  330. </ul>
  331. </div>
  332. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  333. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  334. </nav>
  335. </div>
  336. </div>
  337. </div>
  338. </div>
  339. <footer>
  340. <div class="grad-bottom"></div>
  341. <div class="footer">
  342. <div class="container">
  343. <span class="pull-right">
  344. <a href="#top">Back to top</a>
  345. </span>
  346. <span>Generated by <strong>DocFX</strong></span>
  347. </div>
  348. </div>
  349. </footer>
  350. </div>
  351. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  352. <script type="text/javascript" src="../styles/docfx.js"></script>
  353. <script type="text/javascript" src="../styles/main.js"></script>
  354. </body>
  355. </html>