mcs/class/corlib/Documentation/en/System.Reflection/ExceptionHandlingClause.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="ExceptionHandlingClause" FullName="System.Reflection.ExceptionHandlingClause">
   3   <TypeSignature Language="C#" Value="public class ExceptionHandlingClause" />
   4   <TypeSignature Language="ILAsm" Value=".class public sequential ansi beforefieldinit ExceptionHandlingClause extends System.Object" />
   5   <AssemblyInfo>
   6     <AssemblyName>mscorlib</AssemblyName>
   7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   8     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   9   </AssemblyInfo>
  10   <Base>
  11     <BaseTypeName>System.Object</BaseTypeName>
  12   </Base>
  13   <Interfaces />
  14   <Attributes>
  15     <Attribute>
  16       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
  17     </Attribute>
  18   </Attributes>
  19   <Docs>
  20     <since version=".NET 2.0" />
  21     <remarks>
  22       <attribution license="cc4" from="Microsoft" modified="false" />
  23       <para>The <see cref="T:System.Reflection.ExceptionHandlingClause" /> class provides information about the clauses in a try…catch…finally block (Try…Catch…Finally in Visual Basic). To get a list of exception-handling clauses in a method, obtain a <see cref="T:System.Reflection.MethodInfo" /> that represents the method. Use the <see cref="M:System.Reflection.MethodBase.GetMethodBody" /> method to obtain a <see cref="T:System.Reflection.MethodBody" /> object, and then use the <see cref="P:System.Reflection.MethodBody.ExceptionHandlingClauses" /> property to get the list of clauses.</para>
  24       <block subset="none" type="note">
  25         <para>Working with exception-handling clauses requires a thorough understanding of metadata and Microsoft intermediate language (MSIL) instruction formats. Information can be found in the Common Language Infrastructure (CLI) documentation, especially "Partition II: Metadata Definition and Semantics" and "Partition III: CIL Instruction Set". The documentation is available online; see <see cref="http://go.microsoft.com/fwlink/?LinkID=99212">ECMA C# and Common Language Infrastructure Standards</see> on MSDN and <see cref="http://go.microsoft.com/fwlink/?LinkID=65552">Standard ECMA-335 - Common Language Infrastructure (CLI)</see> on the Ecma International Web site.</para>
  26       </block>
  27     </remarks>
  28     <summary>
  29       <attribution license="cc4" from="Microsoft" modified="false" />
  30       <para>Represents a clause in a structured exception-handling block.</para>
  31     </summary>
  32   </Docs>
  33   <Members>
  34     <Member MemberName=".ctor">
  35       <MemberSignature Language="C#" Value="protected ExceptionHandlingClause ();" />
  36       <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
  37       <MemberType>Constructor</MemberType>
  38       <AssemblyInfo>
  39         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  40       </AssemblyInfo>
  41       <Parameters />
  42       <Docs>
  43         <remarks>
  44           <attribution license="cc4" from="Microsoft" modified="false" />
  45           <para>This constructor is invoked by derived classes during the construction of <see cref="T:System.Reflection.ExceptionHandlingClause" /> objects.</para>
  46         </remarks>
  47         <summary>
  48           <attribution license="cc4" from="Microsoft" modified="false" />
  49           <para>Initializes a new instance of the <see cref="T:System.Reflection.ExceptionHandlingClause" /> class.</para>
  50         </summary>
  51       </Docs>
  52     </Member>
  53     <Member MemberName="CatchType">
  54       <MemberSignature Language="C#" Value="public virtual Type CatchType { get; }" />
  55       <MemberSignature Language="ILAsm" Value=".property instance class System.Type CatchType" />
  56       <MemberType>Property</MemberType>
  57       <AssemblyInfo>
  58         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  59         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  60       </AssemblyInfo>
  61       <ReturnValue>
  62         <ReturnType>System.Type</ReturnType>
  63       </ReturnValue>
  64       <Docs>
  65         <value>To be added.</value>
  66         <since version=".NET 2.0" />
  67         <remarks>
  68           <attribution license="cc4" from="Microsoft" modified="false" />
  69           <block subset="none" type="note">
  70             <para>Working with exception-handling clauses requires a thorough understanding of metadata and Microsoft intermediate language (MSIL) instruction formats. Information can be found in the Common Language Infrastructure (CLI) documentation, especially "Partition II: Metadata Definition and Semantics" and "Partition III: CIL Instruction Set". The documentation is available online; see <see cref="http://go.microsoft.com/fwlink/?LinkID=99212">ECMA C# and Common Language Infrastructure Standards</see> on MSDN and <see cref="http://go.microsoft.com/fwlink/?LinkID=65552">Standard ECMA-335 - Common Language Infrastructure (CLI)</see> on the Ecma International Web site.</para>
  71           </block>
  72         </remarks>
  73         <summary>
  74           <attribution license="cc4" from="Microsoft" modified="false" />
  75           <para>Gets the type of exception handled by this clause.</para>
  76         </summary>
  77       </Docs>
  78     </Member>
  79     <Member MemberName="FilterOffset">
  80       <MemberSignature Language="C#" Value="public virtual int FilterOffset { get; }" />
  81       <MemberSignature Language="ILAsm" Value=".property instance int32 FilterOffset" />
  82       <MemberType>Property</MemberType>
  83       <AssemblyInfo>
  84         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  85         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  86       </AssemblyInfo>
  87       <ReturnValue>
  88         <ReturnType>System.Int32</ReturnType>
  89       </ReturnValue>
  90       <Docs>
  91         <value>To be added.</value>
  92         <since version=".NET 2.0" />
  93         <remarks>
  94           <attribution license="cc4" from="Microsoft" modified="false" />
  95           <para>A filter clause contains user-supplied Microsoft intermediate language (MSIL) that determines whether an exception is handled by this clause. For example, any clause containing the Visual Basic When keyword is a <see cref="F:System.Reflection.ExceptionHandlingClauseOptions.Filter" /> clause.</para>
  96           <block subset="none" type="note">
  97             <para>Working with exception-handling clauses requires a thorough understanding of metadata and MSIL instruction formats. Information can be found in the Common Language Infrastructure (CLI) documentation, especially "Partition II: Metadata Definition and Semantics" and "Partition III: CIL Instruction Set". The documentation is available online; see <see cref="http://go.microsoft.com/fwlink/?LinkID=99212">ECMA C# and Common Language Infrastructure Standards</see> on MSDN and <see cref="http://go.microsoft.com/fwlink/?LinkID=65552">Standard ECMA-335 - Common Language Infrastructure (CLI)</see> on the Ecma International Web site.</para>
  98           </block>
  99         </remarks>
 100         <summary>
 101           <attribution license="cc4" from="Microsoft" modified="false" />
 102           <para>Gets the offset within the method body, in bytes, of the user-supplied filter code.</para>
 103         </summary>
 104       </Docs>
 105     </Member>
 106     <Member MemberName="Flags">
 107       <MemberSignature Language="C#" Value="public virtual System.Reflection.ExceptionHandlingClauseOptions Flags { get; }" />
 108       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Reflection.ExceptionHandlingClauseOptions Flags" />
 109       <MemberType>Property</MemberType>
 110       <AssemblyInfo>
 111         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 112         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 113       </AssemblyInfo>
 114       <ReturnValue>
 115         <ReturnType>System.Reflection.ExceptionHandlingClauseOptions</ReturnType>
 116       </ReturnValue>
 117       <Docs>
 118         <value>To be added.</value>
 119         <since version=".NET 2.0" />
 120         <remarks>
 121           <attribution license="cc4" from="Microsoft" modified="false" />
 122           <block subset="none" type="note">
 123             <para>Working with exception-handling clauses requires a thorough understanding of metadata and Microsoft intermediate language (MSIL) instruction formats. Information can be found in the Common Language Infrastructure (CLI) documentation, especially "Partition II: Metadata Definition and Semantics" and "Partition III: CIL Instruction Set". The documentation is available online; see <see cref="http://go.microsoft.com/fwlink/?LinkID=99212">ECMA C# and Common Language Infrastructure Standards</see> on MSDN and <see cref="http://go.microsoft.com/fwlink/?LinkID=65552">Standard ECMA-335 - Common Language Infrastructure (CLI)</see> on the Ecma International Web site.</para>
 124           </block>
 125         </remarks>
 126         <summary>
 127           <attribution license="cc4" from="Microsoft" modified="false" />
 128           <para>Gets a value indicating whether this exception-handling clause is a finally clause, a type-filtered clause, or a user-filtered clause.</para>
 129         </summary>
 130       </Docs>
 131     </Member>
 132     <Member MemberName="HandlerLength">
 133       <MemberSignature Language="C#" Value="public virtual int HandlerLength { get; }" />
 134       <MemberSignature Language="ILAsm" Value=".property instance int32 HandlerLength" />
 135       <MemberType>Property</MemberType>
 136       <AssemblyInfo>
 137         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 138         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 139       </AssemblyInfo>
 140       <ReturnValue>
 141         <ReturnType>System.Int32</ReturnType>
 142       </ReturnValue>
 143       <Docs>
 144         <value>To be added.</value>
 145         <since version=".NET 2.0" />
 146         <remarks>
 147           <attribution license="cc4" from="Microsoft" modified="false" />
 148           <block subset="none" type="note">
 149             <para>Working with exception-handling clauses requires a thorough understanding of metadata and Microsoft intermediate language (MSIL) instruction formats. Information can be found in the Common Language Infrastructure (CLI) documentation, especially "Partition II: Metadata Definition and Semantics" and "Partition III: CIL Instruction Set". The documentation is available online; see <see cref="http://go.microsoft.com/fwlink/?LinkID=99212">ECMA C# and Common Language Infrastructure Standards</see> on MSDN and <see cref="http://go.microsoft.com/fwlink/?LinkID=65552">Standard ECMA-335 - Common Language Infrastructure (CLI)</see> on the Ecma International Web site.</para>
 150           </block>
 151         </remarks>
 152         <summary>
 153           <attribution license="cc4" from="Microsoft" modified="false" />
 154           <para>Gets the length, in bytes, of the body of this exception-handling clause.</para>
 155         </summary>
 156       </Docs>
 157     </Member>
 158     <Member MemberName="HandlerOffset">
 159       <MemberSignature Language="C#" Value="public virtual int HandlerOffset { get; }" />
 160       <MemberSignature Language="ILAsm" Value=".property instance int32 HandlerOffset" />
 161       <MemberType>Property</MemberType>
 162       <AssemblyInfo>
 163         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 164         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 165       </AssemblyInfo>
 166       <ReturnValue>
 167         <ReturnType>System.Int32</ReturnType>
 168       </ReturnValue>
 169       <Docs>
 170         <value>To be added.</value>
 171         <since version=".NET 2.0" />
 172         <remarks>
 173           <attribution license="cc4" from="Microsoft" modified="false" />
 174           <block subset="none" type="note">
 175             <para>Working with exception-handling clauses requires a thorough understanding of metadata and Microsoft intermediate language (MSIL) instruction formats. Information can be found in the Common Language Infrastructure (CLI) documentation, especially "Partition II: Metadata Definition and Semantics" and "Partition III: CIL Instruction Set". The documentation is available online; see <see cref="http://go.microsoft.com/fwlink/?LinkID=99212">ECMA C# and Common Language Infrastructure Standards</see> on MSDN and <see cref="http://go.microsoft.com/fwlink/?LinkID=65552">Standard ECMA-335 - Common Language Infrastructure (CLI)</see> on the Ecma International Web site.</para>
 176           </block>
 177         </remarks>
 178         <summary>
 179           <attribution license="cc4" from="Microsoft" modified="false" />
 180           <para>Gets the offset within the method body, in bytes, of this exception-handling clause.</para>
 181         </summary>
 182       </Docs>
 183     </Member>
 184     <Member MemberName="ToString">
 185       <MemberSignature Language="C#" Value="public override string ToString ();" />
 186       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
 187       <MemberType>Method</MemberType>
 188       <AssemblyInfo>
 189         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 190         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 191       </AssemblyInfo>
 192       <ReturnValue>
 193         <ReturnType>System.String</ReturnType>
 194       </ReturnValue>
 195       <Parameters />
 196       <Docs>
 197         <remarks>To be added.</remarks>
 198         <summary>
 199           <attribution license="cc4" from="Microsoft" modified="false" />
 200           <para>A string representation of the exception-handling clause.</para>
 201         </summary>
 202         <returns>
 203           <attribution license="cc4" from="Microsoft" modified="false" />
 204           <para>A string that lists appropriate property values for the filter clause type.</para>
 205         </returns>
 206       </Docs>
 207     </Member>
 208     <Member MemberName="TryLength">
 209       <MemberSignature Language="C#" Value="public virtual int TryLength { get; }" />
 210       <MemberSignature Language="ILAsm" Value=".property instance int32 TryLength" />
 211       <MemberType>Property</MemberType>
 212       <AssemblyInfo>
 213         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 214         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 215       </AssemblyInfo>
 216       <ReturnValue>
 217         <ReturnType>System.Int32</ReturnType>
 218       </ReturnValue>
 219       <Docs>
 220         <value>To be added.</value>
 221         <since version=".NET 2.0" />
 222         <remarks>
 223           <attribution license="cc4" from="Microsoft" modified="false" />
 224           <para>An integer that represents the total length, in bytes, of the try block that includes this exception-handling clause.</para>
 225           <block subset="none" type="note">
 226             <para>Working with exception-handling clauses requires a thorough understanding of metadata and Microsoft intermediate language (MSIL) instruction formats. Information can be found in the Common Language Infrastructure (CLI) documentation, especially "Partition II: Metadata Definition and Semantics" and "Partition III: CIL Instruction Set". The documentation is available online; see <see cref="http://go.microsoft.com/fwlink/?LinkID=99212">ECMA C# and Common Language Infrastructure Standards</see> on MSDN and <see cref="http://go.microsoft.com/fwlink/?LinkID=65552">Standard ECMA-335 - Common Language Infrastructure (CLI)</see> on the Ecma International Web site.</para>
 227           </block>
 228         </remarks>
 229         <summary>
 230           <attribution license="cc4" from="Microsoft" modified="false" />
 231           <para>The total length, in bytes, of the try block that includes this exception-handling clause.</para>
 232         </summary>
 233       </Docs>
 234     </Member>
 235     <Member MemberName="TryOffset">
 236       <MemberSignature Language="C#" Value="public virtual int TryOffset { get; }" />
 237       <MemberSignature Language="ILAsm" Value=".property instance int32 TryOffset" />
 238       <MemberType>Property</MemberType>
 239       <AssemblyInfo>
 240         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 241         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 242       </AssemblyInfo>
 243       <ReturnValue>
 244         <ReturnType>System.Int32</ReturnType>
 245       </ReturnValue>
 246       <Docs>
 247         <value>To be added.</value>
 248         <since version=".NET 2.0" />
 249         <remarks>
 250           <attribution license="cc4" from="Microsoft" modified="false" />
 251           <block subset="none" type="note">
 252             <para>Working with exception-handling clauses requires a thorough understanding of metadata and Microsoft intermediate language (MSIL) instruction formats. Information can be found in the Common Language Infrastructure (CLI) documentation, especially "Partition II: Metadata Definition and Semantics" and "Partition III: CIL Instruction Set". The documentation is available online; see <see cref="http://go.microsoft.com/fwlink/?LinkID=99212">ECMA C# and Common Language Infrastructure Standards</see> on MSDN and <see cref="http://go.microsoft.com/fwlink/?LinkID=65552">Standard ECMA-335 - Common Language Infrastructure (CLI)</see> on the Ecma International Web site.</para>
 253           </block>
 254         </remarks>
 255         <summary>
 256           <attribution license="cc4" from="Microsoft" modified="false" />
 257           <para>The offset within the method, in bytes, of the try block that includes this exception-handling clause.</para>
 258         </summary>
 259       </Docs>
 260     </Member>
 261   </Members>
 262 </Type>