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.

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