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.

262 lines
12 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>Interface IAntiMalware
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Interface IAntiMalware
  11. ">
  12. <meta name="generator" content="docfx 2.58.5.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.AntiMalware.IAntiMalware">
  75. <h1 id="IPA_AntiMalware_IAntiMalware" data-uid="IPA.AntiMalware.IAntiMalware" class="text-break">Interface IAntiMalware
  76. </h1>
  77. <div class="markdown level0 summary"><p>An Anti-Malware engine that can be used to scan and detect potentially harmful files.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.AntiMalware.html">IPA.AntiMalware</a></h6>
  81. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  82. <h5 id="IPA_AntiMalware_IAntiMalware_syntax">Syntax</h5>
  83. <div class="codewrapper">
  84. <pre><code class="lang-csharp hljs">public interface IAntiMalware</code></pre>
  85. </div>
  86. <h3 id="methods">Methods
  87. </h3>
  88. <span class="small pull-right mobile-hide">
  89. <span class="divider">|</span>
  90. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_AntiMalware_IAntiMalware_ScanData_System_Byte___System_String_.md&amp;value=---%0Auid%3A%20IPA.AntiMalware.IAntiMalware.ScanData(System.Byte%5B%5D%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>
  91. </span>
  92. <span class="small pull-right mobile-hide">
  93. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/cba705d31a1a1974ab18fab9c770adab517182d0/IPA.Loader/AntiMalware/IAntiMalware.cs/#L23">View Source</a>
  94. </span>
  95. <a id="IPA_AntiMalware_IAntiMalware_ScanData_" data-uid="IPA.AntiMalware.IAntiMalware.ScanData*"></a>
  96. <h4 id="IPA_AntiMalware_IAntiMalware_ScanData_System_Byte___System_String_" data-uid="IPA.AntiMalware.IAntiMalware.ScanData(System.Byte[],System.String)">ScanData(Byte[], String)</h4>
  97. <div class="markdown level1 summary"><p>Scans a particular in-memory blob for malware.</p>
  98. </div>
  99. <div class="markdown level1 conceptual"></div>
  100. <h5 class="decalaration">Declaration</h5>
  101. <div class="codewrapper">
  102. <pre><code class="lang-csharp hljs">ScanResult ScanData(byte[] data, string contentName = null)</code></pre>
  103. </div>
  104. <h5 class="parameters">Parameters</h5>
  105. <table class="table table-bordered table-striped table-condensed">
  106. <thead>
  107. <tr>
  108. <th>Type</th>
  109. <th>Name</th>
  110. <th>Description</th>
  111. </tr>
  112. </thead>
  113. <tbody>
  114. <tr>
  115. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.byte">Byte</a>[]</td>
  116. <td><span class="parametername">data</span></td>
  117. <td><p>The binary blob to scan.</p>
  118. </td>
  119. </tr>
  120. <tr>
  121. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  122. <td><span class="parametername">contentName</span></td>
  123. <td><p>The name of the content. If this is left <span class="xref">null</span>, one will be automatically generated.</p>
  124. </td>
  125. </tr>
  126. </tbody>
  127. </table>
  128. <h5 class="returns">Returns</h5>
  129. <table class="table table-bordered table-striped table-condensed">
  130. <thead>
  131. <tr>
  132. <th>Type</th>
  133. <th>Description</th>
  134. </tr>
  135. </thead>
  136. <tbody>
  137. <tr>
  138. <td><a class="xref" href="IPA.AntiMalware.ScanResult.html">ScanResult</a></td>
  139. <td><p>A <a class="xref" href="IPA.AntiMalware.ScanResult.html">ScanResult</a> indicating whether the file is safe or not.</p>
  140. </td>
  141. </tr>
  142. </tbody>
  143. </table>
  144. <span class="small pull-right mobile-hide">
  145. <span class="divider">|</span>
  146. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_AntiMalware_IAntiMalware_ScanFile_System_IO_FileInfo_.md&amp;value=---%0Auid%3A%20IPA.AntiMalware.IAntiMalware.ScanFile(System.IO.FileInfo)%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>
  147. </span>
  148. <span class="small pull-right mobile-hide">
  149. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/cba705d31a1a1974ab18fab9c770adab517182d0/IPA.Loader/AntiMalware/IAntiMalware.cs/#L16">View Source</a>
  150. </span>
  151. <a id="IPA_AntiMalware_IAntiMalware_ScanFile_" data-uid="IPA.AntiMalware.IAntiMalware.ScanFile*"></a>
  152. <h4 id="IPA_AntiMalware_IAntiMalware_ScanFile_System_IO_FileInfo_" data-uid="IPA.AntiMalware.IAntiMalware.ScanFile(System.IO.FileInfo)">ScanFile(FileInfo)</h4>
  153. <div class="markdown level1 summary"><p>Scans a particular file for malware.</p>
  154. </div>
  155. <div class="markdown level1 conceptual"></div>
  156. <h5 class="decalaration">Declaration</h5>
  157. <div class="codewrapper">
  158. <pre><code class="lang-csharp hljs">ScanResult ScanFile(FileInfo file)</code></pre>
  159. </div>
  160. <h5 class="parameters">Parameters</h5>
  161. <table class="table table-bordered table-striped table-condensed">
  162. <thead>
  163. <tr>
  164. <th>Type</th>
  165. <th>Name</th>
  166. <th>Description</th>
  167. </tr>
  168. </thead>
  169. <tbody>
  170. <tr>
  171. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a></td>
  172. <td><span class="parametername">file</span></td>
  173. <td><p>The file to scan.</p>
  174. </td>
  175. </tr>
  176. </tbody>
  177. </table>
  178. <h5 class="returns">Returns</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.AntiMalware.ScanResult.html">ScanResult</a></td>
  189. <td><p>A <a class="xref" href="IPA.AntiMalware.ScanResult.html">ScanResult</a> indicating whether the file is safe or not.</p>
  190. </td>
  191. </tr>
  192. </tbody>
  193. </table>
  194. <h3 id="extensionmethods">Extension Methods</h3>
  195. <div>
  196. <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>
  197. </div>
  198. <div>
  199. <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>
  200. </div>
  201. <div>
  202. <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>
  203. </div>
  204. <div>
  205. <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>
  206. </div>
  207. <div>
  208. <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>
  209. </div>
  210. </article>
  211. </div>
  212. <div class="hidden-sm col-md-2" role="complementary">
  213. <div class="sideaffix">
  214. <div class="contribution">
  215. <ul class="nav">
  216. <li>
  217. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_AntiMalware_IAntiMalware.md&amp;value=---%0Auid%3A%20IPA.AntiMalware.IAntiMalware%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>
  218. </li>
  219. <li>
  220. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/cba705d31a1a1974ab18fab9c770adab517182d0/IPA.Loader/AntiMalware/IAntiMalware.cs/#L9" class="contribution-link">View Source</a>
  221. </li>
  222. </ul>
  223. </div>
  224. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  225. <h5>In This Article</h5>
  226. <div></div>
  227. </nav>
  228. </div>
  229. </div>
  230. </div>
  231. </div>
  232. <footer>
  233. <div class="grad-bottom"></div>
  234. <div class="footer">
  235. <div class="container">
  236. <span class="pull-right">
  237. <a href="#top">Back to top</a>
  238. </span>
  239. <span>Generated by <strong>DocFX</strong></span>
  240. </div>
  241. </div>
  242. </footer>
  243. </div>
  244. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  245. <script type="text/javascript" src="../styles/docfx.js"></script>
  246. <script type="text/javascript" src="../styles/main.js"></script>
  247. </body>
  248. </html>