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.

364 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 PluginSubLogPrinter
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class PluginSubLogPrinter
  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. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. </head>
  20. <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.PluginSubLogPrinter">
  63. <h1 id="IPA_Logging_Printers_PluginSubLogPrinter" data-uid="IPA.Logging.Printers.PluginSubLogPrinter" class="text-break">Class PluginSubLogPrinter
  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">PluginSubLogPrinter</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_PluginSubLogPrinter_syntax">Syntax</h5>
  121. <div class="codewrapper">
  122. <pre><code class="lang-csharp hljs">public class PluginSubLogPrinter : 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_PluginSubLogPrinter__ctor_System_String_System_String_.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.PluginSubLogPrinter.%23ctor(System.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>
  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/PluginSubLogPrinter.cs/#L37">View Source</a>
  132. </span>
  133. <a id="IPA_Logging_Printers_PluginSubLogPrinter__ctor_" data-uid="IPA.Logging.Printers.PluginSubLogPrinter.#ctor*"></a>
  134. <h4 id="IPA_Logging_Printers_PluginSubLogPrinter__ctor_System_String_System_String_" data-uid="IPA.Logging.Printers.PluginSubLogPrinter.#ctor(System.String,System.String)">PluginSubLogPrinter(String, 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 PluginSubLogPrinter(string mainname, 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">mainname</span></td>
  155. <td><p>the name of the main logger</p>
  156. </td>
  157. </tr>
  158. <tr>
  159. <td><span class="xref">System.String</span></td>
  160. <td><span class="parametername">name</span></td>
  161. <td><p>the name of the logger</p>
  162. </td>
  163. </tr>
  164. </tbody>
  165. </table>
  166. <h3 id="properties">Properties
  167. </h3>
  168. <span class="small pull-right mobile-hide">
  169. <span class="divider">|</span>
  170. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Logging_Printers_PluginSubLogPrinter_Filter.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.PluginSubLogPrinter.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>
  171. </span>
  172. <span class="small pull-right mobile-hide">
  173. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Logging/Printers/PluginSubLogPrinter.cs/#L15">View Source</a>
  174. </span>
  175. <a id="IPA_Logging_Printers_PluginSubLogPrinter_Filter_" data-uid="IPA.Logging.Printers.PluginSubLogPrinter.Filter*"></a>
  176. <h4 id="IPA_Logging_Printers_PluginSubLogPrinter_Filter" data-uid="IPA.Logging.Printers.PluginSubLogPrinter.Filter">Filter</h4>
  177. <div class="markdown level1 summary"><p>Provides a filter for this specific printer.</p>
  178. </div>
  179. <div class="markdown level1 conceptual"></div>
  180. <h5 class="decalaration">Declaration</h5>
  181. <div class="codewrapper">
  182. <pre><code class="lang-csharp hljs">public override Logger.LogLevel Filter { get; set; }</code></pre>
  183. </div>
  184. <h5 class="propertyValue">Property Value</h5>
  185. <table class="table table-bordered table-striped table-condensed">
  186. <thead>
  187. <tr>
  188. <th>Type</th>
  189. <th>Description</th>
  190. </tr>
  191. </thead>
  192. <tbody>
  193. <tr>
  194. <td><a class="xref" href="IPA.Logging.Logger.LogLevel.html">Logger.LogLevel</a></td>
  195. <td><p>the filter for this printer</p>
  196. </td>
  197. </tr>
  198. </tbody>
  199. </table>
  200. <h5 class="overrides">Overrides</h5>
  201. <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Filter">LogPrinter.Filter</a></div>
  202. <h3 id="methods">Methods
  203. </h3>
  204. <span class="small pull-right mobile-hide">
  205. <span class="divider">|</span>
  206. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Logging_Printers_PluginSubLogPrinter_GetFileInfo.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.PluginSubLogPrinter.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>
  207. </span>
  208. <span class="small pull-right mobile-hide">
  209. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Logging/Printers/PluginSubLogPrinter.cs/#L24">View Source</a>
  210. </span>
  211. <a id="IPA_Logging_Printers_PluginSubLogPrinter_GetFileInfo_" data-uid="IPA.Logging.Printers.PluginSubLogPrinter.GetFileInfo*"></a>
  212. <h4 id="IPA_Logging_Printers_PluginSubLogPrinter_GetFileInfo" data-uid="IPA.Logging.Printers.PluginSubLogPrinter.GetFileInfo">GetFileInfo()</h4>
  213. <div class="markdown level1 summary"><p>Gets the <span class="xref">System.IO.FileInfo</span> for the target file.</p>
  214. </div>
  215. <div class="markdown level1 conceptual"></div>
  216. <h5 class="decalaration">Declaration</h5>
  217. <div class="codewrapper">
  218. <pre><code class="lang-csharp hljs">protected override FileInfo GetFileInfo()</code></pre>
  219. </div>
  220. <h5 class="returns">Returns</h5>
  221. <table class="table table-bordered table-striped table-condensed">
  222. <thead>
  223. <tr>
  224. <th>Type</th>
  225. <th>Description</th>
  226. </tr>
  227. </thead>
  228. <tbody>
  229. <tr>
  230. <td><span class="xref">System.IO.FileInfo</span></td>
  231. <td><p>the file to write to</p>
  232. </td>
  233. </tr>
  234. </tbody>
  235. </table>
  236. <h5 class="overrides">Overrides</h5>
  237. <div><a class="xref" href="IPA.Logging.Printers.GZFilePrinter.html#IPA_Logging_Printers_GZFilePrinter_GetFileInfo">GZFilePrinter.GetFileInfo()</a></div>
  238. <span class="small pull-right mobile-hide">
  239. <span class="divider">|</span>
  240. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Logging_Printers_PluginSubLogPrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.PluginSubLogPrinter.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>
  241. </span>
  242. <span class="small pull-right mobile-hide">
  243. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Logging/Printers/PluginSubLogPrinter.cs/#L50">View Source</a>
  244. </span>
  245. <a id="IPA_Logging_Printers_PluginSubLogPrinter_Print_" data-uid="IPA.Logging.Printers.PluginSubLogPrinter.Print*"></a>
  246. <h4 id="IPA_Logging_Printers_PluginSubLogPrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_" data-uid="IPA.Logging.Printers.PluginSubLogPrinter.Print(IPA.Logging.Logger.Level,System.DateTime,System.String,System.String)">Print(Logger.Level, DateTime, String, String)</h4>
  247. <div class="markdown level1 summary"><p>Prints an entry to the associated file.</p>
  248. </div>
  249. <div class="markdown level1 conceptual"></div>
  250. <h5 class="decalaration">Declaration</h5>
  251. <div class="codewrapper">
  252. <pre><code class="lang-csharp hljs">public override void Print(Logger.Level level, DateTime time, string logName, string message)</code></pre>
  253. </div>
  254. <h5 class="parameters">Parameters</h5>
  255. <table class="table table-bordered table-striped table-condensed">
  256. <thead>
  257. <tr>
  258. <th>Type</th>
  259. <th>Name</th>
  260. <th>Description</th>
  261. </tr>
  262. </thead>
  263. <tbody>
  264. <tr>
  265. <td><a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a></td>
  266. <td><span class="parametername">level</span></td>
  267. <td><p>the <a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a> of the message</p>
  268. </td>
  269. </tr>
  270. <tr>
  271. <td><span class="xref">System.DateTime</span></td>
  272. <td><span class="parametername">time</span></td>
  273. <td><p>the <span class="xref">System.DateTime</span> the message was recorded at</p>
  274. </td>
  275. </tr>
  276. <tr>
  277. <td><span class="xref">System.String</span></td>
  278. <td><span class="parametername">logName</span></td>
  279. <td><p>the name of the log that sent the message</p>
  280. </td>
  281. </tr>
  282. <tr>
  283. <td><span class="xref">System.String</span></td>
  284. <td><span class="parametername">message</span></td>
  285. <td><p>the message to print</p>
  286. </td>
  287. </tr>
  288. </tbody>
  289. </table>
  290. <h5 class="overrides">Overrides</h5>
  291. <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>
  292. <h3 id="implements">Implements</h3>
  293. <div>
  294. <span class="xref">System.IDisposable</span>
  295. </div>
  296. <h3 id="extensionmethods">Extension Methods</h3>
  297. <div>
  298. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  299. </div>
  300. <div>
  301. <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>
  302. </div>
  303. <div>
  304. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  305. </div>
  306. <div>
  307. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  308. </div>
  309. <div>
  310. <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>
  311. </div>
  312. </article>
  313. </div>
  314. <div class="hidden-sm col-md-2" role="complementary">
  315. <div class="sideaffix">
  316. <div class="contribution">
  317. <ul class="nav">
  318. <li>
  319. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Logging_Printers_PluginSubLogPrinter.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.PluginSubLogPrinter%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>
  320. </li>
  321. <li>
  322. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Logging/Printers/PluginSubLogPrinter.cs/#L9" class="contribution-link">View Source</a>
  323. </li>
  324. </ul>
  325. </div>
  326. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  327. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  328. </nav>
  329. </div>
  330. </div>
  331. </div>
  332. </div>
  333. <footer>
  334. <div class="grad-bottom"></div>
  335. <div class="footer">
  336. <div class="container">
  337. <span class="pull-right">
  338. <a href="#top">Back to top</a>
  339. </span>
  340. <span>Generated by <strong>DocFX</strong></span>
  341. </div>
  342. </div>
  343. </footer>
  344. </div>
  345. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  346. <script type="text/javascript" src="../styles/docfx.js"></script>
  347. <script type="text/javascript" src="../styles/main.js"></script>
  348. </body>
  349. </html>