Updated documentation to reflect latest changes 3dd8d6c

Aptivi-Archives · Mar 25, 2024 · 97dacf7 · 97dacf7
1 parent 0c156f9
commit 97dacf7
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 14 deletions.
diff --git a/api/FileMagic.MagicHandler.html b/api/FileMagic.MagicHandler.html
@@ -102,7 +102,7 @@ <h3 id="methods">Methods
     <a href="https://github.com/Aptivi/FileMagic/new/main/apiSpec/new?filename=FileMagic_MagicHandler_GetMagicCustomType_System_String_FileMagic_Native_Interop_MagicFlags_FileMagic_Native_Interop_MagicParameters_System_Int32_.md&amp;value=---%0Auid%3A%20FileMagic.MagicHandler.GetMagicCustomType(System.String%2CFileMagic.Native.Interop.MagicFlags%2CFileMagic.Native.Interop.MagicParameters%2CSystem.Int32)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L100">View Source</a>
+    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L114">View Source</a>
   </span>
   <a id="FileMagic_MagicHandler_GetMagicCustomType_" data-uid="FileMagic.MagicHandler.GetMagicCustomType*"></a>
   <h4 id="FileMagic_MagicHandler_GetMagicCustomType_System_String_FileMagic_Native_Interop_MagicFlags_FileMagic_Native_Interop_MagicParameters_System_Int32_" data-uid="FileMagic.MagicHandler.GetMagicCustomType(System.String,FileMagic.Native.Interop.MagicFlags,FileMagic.Native.Interop.MagicParameters,System.Int32)">GetMagicCustomType(string, MagicFlags, MagicParameters, int)</h4>
@@ -169,7 +169,7 @@ <h5 class="returns">Returns</h5>
     <a href="https://github.com/Aptivi/FileMagic/new/main/apiSpec/new?filename=FileMagic_MagicHandler_GetMagicCustomType_System_String_System_String_FileMagic_Native_Interop_MagicFlags_FileMagic_Native_Interop_MagicParameters_System_Int32_.md&amp;value=---%0Auid%3A%20FileMagic.MagicHandler.GetMagicCustomType(System.String%2CSystem.String%2CFileMagic.Native.Interop.MagicFlags%2CFileMagic.Native.Interop.MagicParameters%2CSystem.Int32)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L111">View Source</a>
+    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L125">View Source</a>
   </span>
   <a id="FileMagic_MagicHandler_GetMagicCustomType_" data-uid="FileMagic.MagicHandler.GetMagicCustomType*"></a>
   <h4 id="FileMagic_MagicHandler_GetMagicCustomType_System_String_System_String_FileMagic_Native_Interop_MagicFlags_FileMagic_Native_Interop_MagicParameters_System_Int32_" data-uid="FileMagic.MagicHandler.GetMagicCustomType(System.String,System.String,FileMagic.Native.Interop.MagicFlags,FileMagic.Native.Interop.MagicParameters,System.Int32)">GetMagicCustomType(string, string, MagicFlags, MagicParameters, int)</h4>
@@ -242,7 +242,7 @@ <h5 class="returns">Returns</h5>
     <a href="https://github.com/Aptivi/FileMagic/new/main/apiSpec/new?filename=FileMagic_MagicHandler_GetMagicInfo_System_String_FileMagic_Native_Interop_MagicParameters_System_Int32_.md&amp;value=---%0Auid%3A%20FileMagic.MagicHandler.GetMagicInfo(System.String%2CFileMagic.Native.Interop.MagicParameters%2CSystem.Int32)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L42">View Source</a>
+    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L56">View Source</a>
   </span>
   <a id="FileMagic_MagicHandler_GetMagicInfo_" data-uid="FileMagic.MagicHandler.GetMagicInfo*"></a>
   <h4 id="FileMagic_MagicHandler_GetMagicInfo_System_String_FileMagic_Native_Interop_MagicParameters_System_Int32_" data-uid="FileMagic.MagicHandler.GetMagicInfo(System.String,FileMagic.Native.Interop.MagicParameters,System.Int32)">GetMagicInfo(string, MagicParameters, int)</h4>
@@ -303,7 +303,7 @@ <h5 class="returns">Returns</h5>
     <a href="https://github.com/Aptivi/FileMagic/new/main/apiSpec/new?filename=FileMagic_MagicHandler_GetMagicInfo_System_String_System_String_FileMagic_Native_Interop_MagicParameters_System_Int32_.md&amp;value=---%0Auid%3A%20FileMagic.MagicHandler.GetMagicInfo(System.String%2CSystem.String%2CFileMagic.Native.Interop.MagicParameters%2CSystem.Int32)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L52">View Source</a>
+    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L66">View Source</a>
   </span>
   <a id="FileMagic_MagicHandler_GetMagicInfo_" data-uid="FileMagic.MagicHandler.GetMagicInfo*"></a>
   <h4 id="FileMagic_MagicHandler_GetMagicInfo_System_String_System_String_FileMagic_Native_Interop_MagicParameters_System_Int32_" data-uid="FileMagic.MagicHandler.GetMagicInfo(System.String,System.String,FileMagic.Native.Interop.MagicParameters,System.Int32)">GetMagicInfo(string, string, MagicParameters, int)</h4>
@@ -370,7 +370,7 @@ <h5 class="returns">Returns</h5>
     <a href="https://github.com/Aptivi/FileMagic/new/main/apiSpec/new?filename=FileMagic_MagicHandler_GetMagicMimeInfo_System_String_FileMagic_Native_Interop_MagicParameters_System_Int32_.md&amp;value=---%0Auid%3A%20FileMagic.MagicHandler.GetMagicMimeInfo(System.String%2CFileMagic.Native.Interop.MagicParameters%2CSystem.Int32)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L61">View Source</a>
+    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L75">View Source</a>
   </span>
   <a id="FileMagic_MagicHandler_GetMagicMimeInfo_" data-uid="FileMagic.MagicHandler.GetMagicMimeInfo*"></a>
   <h4 id="FileMagic_MagicHandler_GetMagicMimeInfo_System_String_FileMagic_Native_Interop_MagicParameters_System_Int32_" data-uid="FileMagic.MagicHandler.GetMagicMimeInfo(System.String,FileMagic.Native.Interop.MagicParameters,System.Int32)">GetMagicMimeInfo(string, MagicParameters, int)</h4>
@@ -431,7 +431,7 @@ <h5 class="returns">Returns</h5>
     <a href="https://github.com/Aptivi/FileMagic/new/main/apiSpec/new?filename=FileMagic_MagicHandler_GetMagicMimeInfo_System_String_System_String_FileMagic_Native_Interop_MagicParameters_System_Int32_.md&amp;value=---%0Auid%3A%20FileMagic.MagicHandler.GetMagicMimeInfo(System.String%2CSystem.String%2CFileMagic.Native.Interop.MagicParameters%2CSystem.Int32)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L71">View Source</a>
+    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L85">View Source</a>
   </span>
   <a id="FileMagic_MagicHandler_GetMagicMimeInfo_" data-uid="FileMagic.MagicHandler.GetMagicMimeInfo*"></a>
   <h4 id="FileMagic_MagicHandler_GetMagicMimeInfo_System_String_System_String_FileMagic_Native_Interop_MagicParameters_System_Int32_" data-uid="FileMagic.MagicHandler.GetMagicMimeInfo(System.String,System.String,FileMagic.Native.Interop.MagicParameters,System.Int32)">GetMagicMimeInfo(string, string, MagicParameters, int)</h4>
@@ -498,7 +498,7 @@ <h5 class="returns">Returns</h5>
     <a href="https://github.com/Aptivi/FileMagic/new/main/apiSpec/new?filename=FileMagic_MagicHandler_GetMagicMimeType_System_String_FileMagic_Native_Interop_MagicParameters_System_Int32_.md&amp;value=---%0Auid%3A%20FileMagic.MagicHandler.GetMagicMimeType(System.String%2CFileMagic.Native.Interop.MagicParameters%2CSystem.Int32)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L80">View Source</a>
+    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L94">View Source</a>
   </span>
   <a id="FileMagic_MagicHandler_GetMagicMimeType_" data-uid="FileMagic.MagicHandler.GetMagicMimeType*"></a>
   <h4 id="FileMagic_MagicHandler_GetMagicMimeType_System_String_FileMagic_Native_Interop_MagicParameters_System_Int32_" data-uid="FileMagic.MagicHandler.GetMagicMimeType(System.String,FileMagic.Native.Interop.MagicParameters,System.Int32)">GetMagicMimeType(string, MagicParameters, int)</h4>
@@ -559,7 +559,7 @@ <h5 class="returns">Returns</h5>
     <a href="https://github.com/Aptivi/FileMagic/new/main/apiSpec/new?filename=FileMagic_MagicHandler_GetMagicMimeType_System_String_System_String_FileMagic_Native_Interop_MagicParameters_System_Int32_.md&amp;value=---%0Auid%3A%20FileMagic.MagicHandler.GetMagicMimeType(System.String%2CSystem.String%2CFileMagic.Native.Interop.MagicParameters%2CSystem.Int32)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L90">View Source</a>
+    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L104">View Source</a>
   </span>
   <a id="FileMagic_MagicHandler_GetMagicMimeType_" data-uid="FileMagic.MagicHandler.GetMagicMimeType*"></a>
   <h4 id="FileMagic_MagicHandler_GetMagicMimeType_System_String_System_String_FileMagic_Native_Interop_MagicParameters_System_Int32_" data-uid="FileMagic.MagicHandler.GetMagicMimeType(System.String,System.String,FileMagic.Native.Interop.MagicParameters,System.Int32)">GetMagicMimeType(string, string, MagicParameters, int)</h4>
@@ -621,6 +621,56 @@ <h5 class="returns">Returns</h5>
       </tr>
     </tbody>
   </table>
+  <span class="small pull-right mobile-hide">
+    <span class="divider">|</span>
+    <a href="https://github.com/Aptivi/FileMagic/new/main/apiSpec/new?filename=FileMagic_MagicHandler_GetMagicPaths_System_String_.md&amp;value=---%0Auid%3A%20FileMagic.MagicHandler.GetMagicPaths(System.String)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
+  </span>
+  <span class="small pull-right mobile-hide">
+    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L42">View Source</a>
+  </span>
+  <a id="FileMagic_MagicHandler_GetMagicPaths_" data-uid="FileMagic.MagicHandler.GetMagicPaths*"></a>
+  <h4 id="FileMagic_MagicHandler_GetMagicPaths_System_String_" data-uid="FileMagic.MagicHandler.GetMagicPaths(System.String)">GetMagicPaths(string)</h4>
+  <div class="markdown level1 summary"><p>Gets the file magic paths</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="declaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public static string[] GetMagicPaths(string magicPath = null)</code></pre>
+  </div>
+  <h5 class="parameters">Parameters</h5>
+  <table class="table table-bordered table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Name</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
+        <td><span class="parametername">magicPath</span></td>
+        <td><p>Magic path. If null, the libmagic library tries to find the magic database files.</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
+  <h5 class="returns">Returns</h5>
+  <table class="table table-bordered table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>[]</td>
+        <td><p>A colon separated list of magic locations</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
 
 </article>
           </div>
@@ -633,7 +683,7 @@ <h5 class="returns">Returns</h5>
                     <a href="https://github.com/Aptivi/FileMagic/new/main/apiSpec/new?filename=FileMagic_MagicHandler.md&amp;value=---%0Auid%3A%20FileMagic.MagicHandler%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
                   </li>
                   <li>
-                    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L31" class="contribution-link">View Source</a>
+                    <a href="https://github.com/Aptivi/FileMagic/blob/main/FileMagic/MagicHandler.cs/#L32" class="contribution-link">View Source</a>
                   </li>
                 </ul>
               </div>