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.

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