admin/pardeike-Harmony
1
0
Fork 0
mirror of https://github.com/pardeike/Harmony synced 2026-06-08 16:40:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e791fa3e229028c19dcef12845ef955239cb2c2b
pardeike-Harmony/docs/api/HarmonyLib.HarmonyException.html
T
pardeike-bot a274f8cb39 Update documentation [skip ci]
2020-07-27 07:59:35 +00:00

372 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class HarmonyException
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class HarmonyException
">
<meta name="generator" content="docfx 2.56.2.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="HarmonyLib.HarmonyException">
<h1 id="HarmonyLib_HarmonyException" data-uid="HarmonyLib.HarmonyException" class="text-break">Class HarmonyException
</h1>
<div class="markdown level0 summary"><p>Under Mono, HarmonyException wraps IL compile errors with detailed information about the failure</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">System.Exception</span></div>
<div class="level2"><span class="xref">HarmonyException</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.Runtime.Serialization.ISerializable</span></div>
<div><span class="xref">System.Runtime.InteropServices._Exception</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Exception.GetBaseException()</span>
</div>
<div>
<span class="xref">System.Exception.ToString()</span>
</div>
<div>
<span class="xref">System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)</span>
</div>
<div>
<span class="xref">System.Exception.GetType()</span>
</div>
<div>
<span class="xref">System.Exception.Message</span>
</div>
<div>
<span class="xref">System.Exception.Data</span>
</div>
<div>
<span class="xref">System.Exception.InnerException</span>
</div>
<div>
<span class="xref">System.Exception.TargetSite</span>
</div>
<div>
<span class="xref">System.Exception.StackTrace</span>
</div>
<div>
<span class="xref">System.Exception.HelpLink</span>
</div>
<div>
<span class="xref">System.Exception.Source</span>
</div>
<div>
<span class="xref">System.Exception.HResult</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="HarmonyLib.html">HarmonyLib</a></h6>
<h6><strong>Assembly</strong>: 0Harmony.dll</h6>
<h5 id="HarmonyLib_HarmonyException_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Serializable]
public class HarmonyException : Exception, ISerializable, _Exception</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_HarmonyException__ctor_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_.md&amp;value=---%0Auid%3A%20HarmonyLib.HarmonyException.%23ctor(System.Runtime.Serialization.SerializationInfo%2CSystem.Runtime.Serialization.StreamingContext)%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/HarmonyException.cs/#L24">View Source</a>
</span>
<a id="HarmonyLib_HarmonyException__ctor_" data-uid="HarmonyLib.HarmonyException.#ctor*"></a>
<h4 id="HarmonyLib_HarmonyException__ctor_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_" data-uid="HarmonyLib.HarmonyException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">HarmonyException(SerializationInfo, StreamingContext)</h4>
<div class="markdown level1 summary"><p>Default serialization constructor (not implemented)</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected HarmonyException(SerializationInfo serializationInfo, StreamingContext streamingContext)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Runtime.Serialization.SerializationInfo</span></td>
<td><span class="parametername">serializationInfo</span></td>
<td><p>The info</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Runtime.Serialization.StreamingContext</span></td>
<td><span class="parametername">streamingContext</span></td>
<td><p>The context</p>
</td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_HarmonyException_GetErrorIndex.md&amp;value=---%0Auid%3A%20HarmonyLib.HarmonyException.GetErrorIndex%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/HarmonyException.cs/#L78">View Source</a>
</span>
<a id="HarmonyLib_HarmonyException_GetErrorIndex_" data-uid="HarmonyLib.HarmonyException.GetErrorIndex*"></a>
<h4 id="HarmonyLib_HarmonyException_GetErrorIndex" data-uid="HarmonyLib.HarmonyException.GetErrorIndex">GetErrorIndex()</h4>
<div class="markdown level1 summary"><p>Get the index of the errornous IL instruction</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int GetErrorIndex()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><p>The index into the list of instructions or -1 if not found</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_HarmonyException_GetErrorOffset.md&amp;value=---%0Auid%3A%20HarmonyLib.HarmonyException.GetErrorOffset%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/HarmonyException.cs/#L70">View Source</a>
</span>
<a id="HarmonyLib_HarmonyException_GetErrorOffset_" data-uid="HarmonyLib.HarmonyException.GetErrorOffset*"></a>
<h4 id="HarmonyLib_HarmonyException_GetErrorOffset" data-uid="HarmonyLib.HarmonyException.GetErrorOffset">GetErrorOffset()</h4>
<div class="markdown level1 summary"><p>Get the error offset of the errornous IL instruction</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int GetErrorOffset()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><p>The offset</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_HarmonyException_GetInstructions.md&amp;value=---%0Auid%3A%20HarmonyLib.HarmonyException.GetInstructions%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/HarmonyException.cs/#L62">View Source</a>
</span>
<a id="HarmonyLib_HarmonyException_GetInstructions_" data-uid="HarmonyLib.HarmonyException.GetInstructions*"></a>
<h4 id="HarmonyLib_HarmonyException_GetInstructions" data-uid="HarmonyLib.HarmonyException.GetInstructions">GetInstructions()</h4>
<div class="markdown level1 summary"><p>Get a list of IL instructions without offsets</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;CodeInstruction&gt; GetInstructions()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.List</span>&lt;<a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a>&gt;</td>
<td><p>A list of <a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a></p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_HarmonyException_GetInstructionsWithOffsets.md&amp;value=---%0Auid%3A%20HarmonyLib.HarmonyException.GetInstructionsWithOffsets%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/HarmonyException.cs/#L54">View Source</a>
</span>
<a id="HarmonyLib_HarmonyException_GetInstructionsWithOffsets_" data-uid="HarmonyLib.HarmonyException.GetInstructionsWithOffsets*"></a>
<h4 id="HarmonyLib_HarmonyException_GetInstructionsWithOffsets" data-uid="HarmonyLib.HarmonyException.GetInstructionsWithOffsets">GetInstructionsWithOffsets()</h4>
<div class="markdown level1 summary"><p>Get a list of IL instructions in pairs of offset+code</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;KeyValuePair&lt;int, CodeInstruction&gt;&gt; GetInstructionsWithOffsets()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.List</span>&lt;<span class="xref">System.Collections.Generic.KeyValuePair</span>&lt;<span class="xref">System.Int32</span>, <a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a>&gt;&gt;</td>
<td><p>A list of key/value pairs which represent an offset and the code at that offset</p>
</td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.Runtime.Serialization.ISerializable</span>
</div>
<div>
<span class="xref">System.Runtime.InteropServices._Exception</span>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_HarmonyException.md&amp;value=---%0Auid%3A%20HarmonyLib.HarmonyException%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>
</li>
<li>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/HarmonyException.cs/#L10" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink