DaNike
/
BeatSaber-IPA-Reloaded
mirror of https://github.com/bsmg/BeatSaber-IPA-Reloaded.git
1
1
Fork 0
Code Issues 0 Projects 0 Releases 78 Wiki Activity
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.
7 Commits
9 Branches
2.9 GiB
Tree: acab1b675b
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'acab1b675b'
${ noResults }
BeatSaber-IPA-Reloaded/api/IPA.Logging.Printers.Global...

322 lines
16 KiB
Raw Normal View History

i'm fuckin baaaaad -- Docs
5 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
Removed material DocFX template in favor of DarkFX -- Docs
5 years ago
i'm fuckin baaaaad -- Docs
5 years ago
​
​
​
​
Removed material DocFX template in favor of DarkFX -- Docs
5 years ago
i'm fuckin baaaaad -- Docs
5 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
 
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4.   
  5.   <head>
  6.     <meta charset="utf-8">
  7.     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  8.     <title>Class GlobalLogFilePrinter
  9.    </title>
  10.     <meta name="viewport" content="width=device-width">
  11.     <meta name="title" content="Class GlobalLogFilePrinter
  12.    ">
  13.     <meta name="generator" content="docfx 2.42.4.0">
  14.     
  15.     <link rel="shortcut icon" href="../favicon.ico">
  16.     <link rel="stylesheet" href="../styles/docfx.vendor.css">
  17.     <link rel="stylesheet" href="../styles/docfx.css">
  18.     <link rel="stylesheet" href="../styles/main.css">
  19.     <link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet">
  20.     <meta property="docfx:navrel" content="../toc.html">
  21.     <meta property="docfx:tocrel" content="toc.html">
  22.     
  23.     
  24.     
  25.   </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
  26.     <div id="wrapper">
  27.       <header>
  28.         
  29.         <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  30.           <div class="container">
  31.             <div class="navbar-header">
  32.               <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  33.                 <span class="sr-only">Toggle navigation</span>
  34.                 <span class="icon-bar"></span>
  35.                 <span class="icon-bar"></span>
  36.                 <span class="icon-bar"></span>
  37.               </button>
  38.               
  39.               <a class="navbar-brand" href="../index.html">
  40.                 <img id="logo" class="svg" src="../logo.svg" alt="">
  41.               </a>
  42.             </div>
  43.             <div class="collapse navbar-collapse" id="navbar">
  44.               <form class="navbar-form navbar-right" role="search" id="search">
  45.                 <div class="form-group">
  46.                   <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  47.                 </div>
  48.               </form>
  49.             </div>
  50.           </div>
  51.         </nav>
  52.         
  53.         <div class="subnav navbar navbar-default">
  54.           <div class="container hide-when-search" id="breadcrumb">
  55.             <ul class="breadcrumb">
  56.               <li></li>
  57.             </ul>
  58.           </div>
  59.         </div>
  60.       </header>
  61.       <div role="main" class="container body-content hide-when-search">
  62.         
  63.         <div class="sidenav hide-when-search">
  64.           <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  65.           <div class="sidetoggle collapse" id="sidetoggle">
  66.             <div id="sidetoc"></div>
  67.           </div>
  68.         </div>
  69.         <div class="article row grid-right">
  70.           <div class="col-md-10">
  71.             <article class="content wrap" id="_content" data-uid="IPA.Logging.Printers.GlobalLogFilePrinter">
  72.   
  73.   
  74.   <h1 id="IPA_Logging_Printers_GlobalLogFilePrinter" data-uid="IPA.Logging.Printers.GlobalLogFilePrinter" class="text-break">Class GlobalLogFilePrinter
  75.   </h1>
  76.   <div class="markdown level0 summary"><p>A printer for all messages to a unified log location.</p>
  77. </div>
  78.   <div class="markdown level0 conceptual"></div>
  79.   <div class="inheritance">
  80.     <h5>Inheritance</h5>
  81.     <div class="level0"><span class="xref">System.Object</span></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">GlobalLogFilePrinter</span></div>
  85.   </div>
  86.   <div classs="implements">
  87.     <h5>Implements</h5>
  88.     <div><span class="xref">System.IDisposable</span></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.       <span class="xref">System.Object.ToString()</span>
  109.     </div>
  110.     <div>
  111.       <span class="xref">System.Object.Equals(System.Object)</span>
  112.     </div>
  113.     <div>
  114.       <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  115.     </div>
  116.     <div>
  117.       <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  118.     </div>
  119.     <div>
  120.       <span class="xref">System.Object.GetHashCode()</span>
  121.     </div>
  122.     <div>
  123.       <span class="xref">System.Object.GetType()</span>
  124.     </div>
  125.     <div>
  126.       <span class="xref">System.Object.MemberwiseClone()</span>
  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_GlobalLogFilePrinter_syntax">Syntax</h5>
  132.   <div class="codewrapper">
  133.     <pre><code class="lang-csharp hljs">public class GlobalLogFilePrinter : GZFilePrinter, IDisposable</code></pre>
  134.   </div>
  135.   <h3 id="properties">Properties
  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/apiSpec/new?filename=IPA_Logging_Printers_GlobalLogFilePrinter_Filter.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.GlobalLogFilePrinter.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>
  140.   </span>
  141.   <span class="small pull-right mobile-hide">
  142.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Logging/Printers/GlobalLogFilePrinter.cs/#L15">View Source</a>
  143.   </span>
  144.   <a id="IPA_Logging_Printers_GlobalLogFilePrinter_Filter_" data-uid="IPA.Logging.Printers.GlobalLogFilePrinter.Filter*"></a>
  145.   <h4 id="IPA_Logging_Printers_GlobalLogFilePrinter_Filter" data-uid="IPA.Logging.Printers.GlobalLogFilePrinter.Filter">Filter</h4>
  146.   <div class="markdown level1 summary"><p>Provides a filter for this specific printer.</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 override Logger.LogLevel Filter { get; set; }</code></pre>
  152.   </div>
  153.   <h5 class="propertyValue">Property Value</h5>
  154.   <table class="table table-bordered table-striped table-condensed">
  155.     <thead>
  156.       <tr>
  157.         <th>Type</th>
  158.         <th>Description</th>
  159.       </tr>
  160.     </thead>
  161.     <tbody>
  162.       <tr>
  163.         <td><a class="xref" href="IPA.Logging.Logger.LogLevel.html">Logger.LogLevel</a></td>
  164.         <td><p>the filter level for this printer</p>
  165. </td>
  166.       </tr>
  167.     </tbody>
  168.   </table>
  169.   <h5 class="overrides">Overrides</h5>
  170.   <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Filter">LogPrinter.Filter</a></div>
  171.   <h3 id="methods">Methods
  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/apiSpec/new?filename=IPA_Logging_Printers_GlobalLogFilePrinter_GetFileInfo.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.GlobalLogFilePrinter.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>
  176.   </span>
  177.   <span class="small pull-right mobile-hide">
  178.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Logging/Printers/GlobalLogFilePrinter.cs/#L34">View Source</a>
  179.   </span>
  180.   <a id="IPA_Logging_Printers_GlobalLogFilePrinter_GetFileInfo_" data-uid="IPA.Logging.Printers.GlobalLogFilePrinter.GetFileInfo*"></a>
  181.   <h4 id="IPA_Logging_Printers_GlobalLogFilePrinter_GetFileInfo" data-uid="IPA.Logging.Printers.GlobalLogFilePrinter.GetFileInfo">GetFileInfo()</h4>
  182.   <div class="markdown level1 summary"><p>Gets the <span class="xref">System.IO.FileInfo</span> for the target file.</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">protected override FileInfo GetFileInfo()</code></pre>
  188.   </div>
  189.   <h5 class="returns">Returns</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><span class="xref">System.IO.FileInfo</span></td>
  200.         <td><p>the target file to write to</p>
  201. </td>
  202.       </tr>
  203.     </tbody>
  204.   </table>
  205.   <h5 class="overrides">Overrides</h5>
  206.   <div><a class="xref" href="IPA.Logging.Printers.GZFilePrinter.html#IPA_Logging_Printers_GZFilePrinter_GetFileInfo">GZFilePrinter.GetFileInfo()</a></div>
  207.   <span class="small pull-right mobile-hide">
  208.     <span class="divider">|</span>
  209.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Logging_Printers_GlobalLogFilePrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.GlobalLogFilePrinter.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>
  210.   </span>
  211.   <span class="small pull-right mobile-hide">
  212.     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Logging/Printers/GlobalLogFilePrinter.cs/#L24">View Source</a>
  213.   </span>
  214.   <a id="IPA_Logging_Printers_GlobalLogFilePrinter_Print_" data-uid="IPA.Logging.Printers.GlobalLogFilePrinter.Print*"></a>
  215.   <h4 id="IPA_Logging_Printers_GlobalLogFilePrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_" data-uid="IPA.Logging.Printers.GlobalLogFilePrinter.Print(IPA.Logging.Logger.Level,System.DateTime,System.String,System.String)">Print(Logger.Level, DateTime, String, String)</h4>
  216.   <div class="markdown level1 summary"><p>Prints an entry to the associated file.</p>
  217. </div>
  218.   <div class="markdown level1 conceptual"></div>
  219.   <h5 class="decalaration">Declaration</h5>
  220.   <div class="codewrapper">
  221.     <pre><code class="lang-csharp hljs">public override void Print(Logger.Level level, DateTime time, string logName, string message)</code></pre>
  222.   </div>
  223.   <h5 class="parameters">Parameters</h5>
  224.   <table class="table table-bordered table-striped table-condensed">
  225.     <thead>
  226.       <tr>
  227.         <th>Type</th>
  228.         <th>Name</th>
  229.         <th>Description</th>
  230.       </tr>
  231.     </thead>
  232.     <tbody>
  233.       <tr>
  234.         <td><a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a></td>
  235.         <td><span class="parametername">level</span></td>
  236.         <td><p>the <a class="xref" href="IPA.Logging.Logger.Level.html">Logger.Level</a> of the message</p>
  237. </td>
  238.       </tr>
  239.       <tr>
  240.         <td><span class="xref">System.DateTime</span></td>
  241.         <td><span class="parametername">time</span></td>
  242.         <td><p>the <span class="xref">System.DateTime</span> the message was recorded at</p>
  243. </td>
  244.       </tr>
  245.       <tr>
  246.         <td><span class="xref">System.String</span></td>
  247.         <td><span class="parametername">logName</span></td>
  248.         <td><p>the name of the log that sent the message</p>
  249. </td>
  250.       </tr>
  251.       <tr>
  252.         <td><span class="xref">System.String</span></td>
  253.         <td><span class="parametername">message</span></td>
  254.         <td><p>the message to print</p>
  255. </td>
  256.       </tr>
  257.     </tbody>
  258.   </table>
  259.   <h5 class="overrides">Overrides</h5>
  260.   <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>
  261.   <h3 id="implements">Implements</h3>
  262.   <div>
  263.       <span class="xref">System.IDisposable</span>
  264.   </div>
  265.   <h3 id="extensionmethods">Extension Methods</h3>
  266.   <div>
  267.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  268.   </div>
  269.   <div>
  270.       <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>
  271.   </div>
  272.   <div>
  273.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  274.   </div>
  275.   <div>
  276.       <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  277.   </div>
  278.   <div>
  279.       <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>
  280.   </div>
  281. </article>
  282.           </div>
  283.           
  284.           <div class="hidden-sm col-md-2" role="complementary">
  285.             <div class="sideaffix">
  286.               <div class="contribution">
  287.                 <ul class="nav">
  288.                   <li>
  289.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/apiSpec/new?filename=IPA_Logging_Printers_GlobalLogFilePrinter.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.GlobalLogFilePrinter%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>
  290.                   </li>
  291.                   <li>
  292.                     <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/master/IPA.Loader/Logging/Printers/GlobalLogFilePrinter.cs/#L9" class="contribution-link">View Source</a>
  293.                   </li>
  294.                 </ul>
  295.               </div>
  296.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  297.               <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  298.               </nav>
  299.             </div>
  300.           </div>
  301.         </div>
  302.       </div>
  303.       
  304.       <footer>
  305.         <div class="grad-bottom"></div>
  306.         <div class="footer">
  307.           <div class="container">
  308.             <span class="pull-right">
  309.               <a href="#top">Back to top</a>
  310.             </span>
  311.             
  312.             <span>Generated by <strong>DocFX</strong></span>
  313.           </div>
  314.         </div>
  315.       </footer>
  316.     </div>
  317.     
  318.     <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  319.     <script type="text/javascript" src="../styles/docfx.js"></script>
  320.     <script type="text/javascript" src="../styles/main.js"></script>
  321.   </body>
  322. </html>