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.

308 lines
15 KiB

4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
  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 LogPrinter
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class LogPrinter
  11. ">
  12. <meta name="generator" content="docfx 2.59.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 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.LogPrinter">
  75. <h1 id="IPA_Logging_LogPrinter" data-uid="IPA.Logging.LogPrinter" class="text-break">Class LogPrinter
  76. </h1>
  77. <div class="markdown level0 summary"><p>The log printer&apos;s base class.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><span class="xref">System.Object</span></div>
  83. <div class="level1"><span class="xref">LogPrinter</span></div>
  84. <div class="level2"><a class="xref" href="IPA.Logging.Printers.ColoredConsolePrinter.html">ColoredConsolePrinter</a></div>
  85. <div class="level2"><a class="xref" href="IPA.Logging.Printers.ColorlessConsolePrinter.html">ColorlessConsolePrinter</a></div>
  86. <div class="level2"><a class="xref" href="IPA.Logging.Printers.GZFilePrinter.html">GZFilePrinter</a></div>
  87. </div>
  88. <div class="inheritedMembers">
  89. <h5>Inherited Members</h5>
  90. <div>
  91. <span class="xref">System.Object.ToString()</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.Equals(System.Object)</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.GetHashCode()</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Object.GetType()</span>
  107. </div>
  108. <div>
  109. <span class="xref">System.Object.MemberwiseClone()</span>
  110. </div>
  111. </div>
  112. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Logging.html">IPA.Logging</a></h6>
  113. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  114. <h5 id="IPA_Logging_LogPrinter_syntax">Syntax</h5>
  115. <div class="codewrapper">
  116. <pre><code class="lang-csharp hljs">public abstract class LogPrinter</code></pre>
  117. </div>
  118. <h3 id="properties">Properties
  119. </h3>
  120. <span class="small pull-right mobile-hide">
  121. <span class="divider">|</span>
  122. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_LogPrinter_Filter.md&amp;value=---%0Auid%3A%20IPA.Logging.LogPrinter.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>
  123. </span>
  124. <span class="small pull-right mobile-hide">
  125. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a81bad951faa2996c93ab866290a8f11e87270ce/IPA.Loader/Logging/LogPrinter.cs/#L15">View Source</a>
  126. </span>
  127. <a id="IPA_Logging_LogPrinter_Filter_" data-uid="IPA.Logging.LogPrinter.Filter*"></a>
  128. <h4 id="IPA_Logging_LogPrinter_Filter" data-uid="IPA.Logging.LogPrinter.Filter">Filter</h4>
  129. <div class="markdown level1 summary"><p>Provides a filter for which log levels to allow through.</p>
  130. </div>
  131. <div class="markdown level1 conceptual"></div>
  132. <h5 class="decalaration">Declaration</h5>
  133. <div class="codewrapper">
  134. <pre><code class="lang-csharp hljs">public abstract Logger.LogLevel Filter { get; set; }</code></pre>
  135. </div>
  136. <h5 class="propertyValue">Property Value</h5>
  137. <table class="table table-bordered table-striped table-condensed">
  138. <thead>
  139. <tr>
  140. <th>Type</th>
  141. <th>Description</th>
  142. </tr>
  143. </thead>
  144. <tbody>
  145. <tr>
  146. <td><a class="xref" href="IPA.Logging.Logger.LogLevel.html">Logger.LogLevel</a></td>
  147. <td><p>the level to filter to</p>
  148. </td>
  149. </tr>
  150. </tbody>
  151. </table>
  152. <h3 id="methods">Methods
  153. </h3>
  154. <span class="small pull-right mobile-hide">
  155. <span class="divider">|</span>
  156. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_LogPrinter_EndPrint.md&amp;value=---%0Auid%3A%20IPA.Logging.LogPrinter.EndPrint%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>
  157. </span>
  158. <span class="small pull-right mobile-hide">
  159. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a81bad951faa2996c93ab866290a8f11e87270ce/IPA.Loader/Logging/LogPrinter.cs/#L36">View Source</a>
  160. </span>
  161. <a id="IPA_Logging_LogPrinter_EndPrint_" data-uid="IPA.Logging.LogPrinter.EndPrint*"></a>
  162. <h4 id="IPA_Logging_LogPrinter_EndPrint" data-uid="IPA.Logging.LogPrinter.EndPrint">EndPrint()</h4>
  163. <div class="markdown level1 summary"><p>Called after the last print in a group. May be called multiple times.
  164. Use this to dispose file handles and the like.</p>
  165. </div>
  166. <div class="markdown level1 conceptual"></div>
  167. <h5 class="decalaration">Declaration</h5>
  168. <div class="codewrapper">
  169. <pre><code class="lang-csharp hljs">public virtual void EndPrint()</code></pre>
  170. </div>
  171. <span class="small pull-right mobile-hide">
  172. <span class="divider">|</span>
  173. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_LogPrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_.md&amp;value=---%0Auid%3A%20IPA.Logging.LogPrinter.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>
  174. </span>
  175. <span class="small pull-right mobile-hide">
  176. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a81bad951faa2996c93ab866290a8f11e87270ce/IPA.Loader/Logging/LogPrinter.cs/#L24">View Source</a>
  177. </span>
  178. <a id="IPA_Logging_LogPrinter_Print_" data-uid="IPA.Logging.LogPrinter.Print*"></a>
  179. <h4 id="IPA_Logging_LogPrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_" data-uid="IPA.Logging.LogPrinter.Print(IPA.Logging.Logger.Level,System.DateTime,System.String,System.String)">Print(Logger.Level, DateTime, String, String)</h4>
  180. <div class="markdown level1 summary"><p>Prints a provided message from a given log at the specified time.</p>
  181. </div>
  182. <div class="markdown level1 conceptual"></div>
  183. <h5 class="decalaration">Declaration</h5>
  184. <div class="codewrapper">
  185. <pre><code class="lang-csharp hljs">public abstract void Print(Logger.Level level, DateTime time, string logName, string message)</code></pre>
  186. </div>
  187. <h5 class="parameters">Parameters</h5>
  188. <table class="table table-bordered table-striped table-condensed">
  189. <thead>
  190. <tr>
  191. <th>Type</th>
  192. <th>Name</th>
  193. <th>Description</th>
  194. </tr>
  195. </thead>
  196. <tbody>
  197. <tr>
  198. <td><a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a></td>
  199. <td><span class="parametername">level</span></td>
  200. <td><p>the log level</p>
  201. </td>
  202. </tr>
  203. <tr>
  204. <td><span class="xref">System.DateTime</span></td>
  205. <td><span class="parametername">time</span></td>
  206. <td><p>the time the message was composed</p>
  207. </td>
  208. </tr>
  209. <tr>
  210. <td><span class="xref">System.String</span></td>
  211. <td><span class="parametername">logName</span></td>
  212. <td><p>the name of the log that created this message</p>
  213. </td>
  214. </tr>
  215. <tr>
  216. <td><span class="xref">System.String</span></td>
  217. <td><span class="parametername">message</span></td>
  218. <td><p>the message</p>
  219. </td>
  220. </tr>
  221. </tbody>
  222. </table>
  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_LogPrinter_StartPrint.md&amp;value=---%0Auid%3A%20IPA.Logging.LogPrinter.StartPrint%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/a81bad951faa2996c93ab866290a8f11e87270ce/IPA.Loader/Logging/LogPrinter.cs/#L30">View Source</a>
  229. </span>
  230. <a id="IPA_Logging_LogPrinter_StartPrint_" data-uid="IPA.Logging.LogPrinter.StartPrint*"></a>
  231. <h4 id="IPA_Logging_LogPrinter_StartPrint" data-uid="IPA.Logging.LogPrinter.StartPrint">StartPrint()</h4>
  232. <div class="markdown level1 summary"><p>Called before the first print in a group. May be called multiple times.
  233. Use this to create file handles and the like.</p>
  234. </div>
  235. <div class="markdown level1 conceptual"></div>
  236. <h5 class="decalaration">Declaration</h5>
  237. <div class="codewrapper">
  238. <pre><code class="lang-csharp hljs">public virtual void StartPrint()</code></pre>
  239. </div>
  240. <h3 id="extensionmethods">Extension Methods</h3>
  241. <div>
  242. <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>
  243. </div>
  244. <div>
  245. <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>
  246. </div>
  247. <div>
  248. <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>
  249. </div>
  250. <div>
  251. <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>
  252. </div>
  253. <div>
  254. <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>
  255. </div>
  256. </article>
  257. </div>
  258. <div class="hidden-sm col-md-2" role="complementary">
  259. <div class="sideaffix">
  260. <div class="contribution">
  261. <ul class="nav">
  262. <li>
  263. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_LogPrinter.md&amp;value=---%0Auid%3A%20IPA.Logging.LogPrinter%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>
  264. </li>
  265. <li>
  266. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a81bad951faa2996c93ab866290a8f11e87270ce/IPA.Loader/Logging/LogPrinter.cs/#L9" class="contribution-link">View Source</a>
  267. </li>
  268. </ul>
  269. </div>
  270. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  271. <h5>In This Article</h5>
  272. <div></div>
  273. </nav>
  274. </div>
  275. </div>
  276. </div>
  277. </div>
  278. <footer>
  279. <div class="grad-bottom"></div>
  280. <div class="footer">
  281. <div class="container">
  282. <span class="pull-right">
  283. <a href="#top">Back to top</a>
  284. </span>
  285. <span>Generated by <strong>DocFX</strong></span>
  286. </div>
  287. </div>
  288. </footer>
  289. </div>
  290. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  291. <script type="text/javascript" src="../styles/docfx.js"></script>
  292. <script type="text/javascript" src="../styles/main.js"></script>
  293. </body>
  294. </html>