mcs/class/corlib/Documentation/en/System.Diagnostics.SymbolStore/ISymbolScope.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="ISymbolScope" FullName="System.Diagnostics.SymbolStore.ISymbolScope">
   3   <TypeSignature Maintainer="auto" Language="C#" Value="public interface ISymbolScope" />
   4   <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ISymbolScope" />
   5   <AssemblyInfo>
   6     <AssemblyName>mscorlib</AssemblyName>
   7     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
   8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  10     <AssemblyVersion>4.0.0.0</AssemblyVersion>
  11   </AssemblyInfo>
  12   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  13   <Interfaces />
  14   <Attributes>
  15     <Attribute>
  16       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
  17     </Attribute>
  18   </Attributes>
  19   <Docs>
  20     <remarks>
  21       <attribution license="cc4" from="Microsoft" modified="false" />
  22       <para>The <see cref="T:System.Diagnostics.SymbolStore.ISymbolScope" /> interface also provides access to all locals defined within the current scope.</para>
  23       <block subset="none" type="note">
  24         <para>This interface is the managed counterpart of the <unmanagedCodeEntityReference>ISymUnmanagedScope</unmanagedCodeEntityReference> interface, which is one of the unmanaged symbol store interfaces that provide an alternate way to read and write debug symbol information.</para>
  25       </block>
  26     </remarks>
  27     <summary>
  28       <attribution license="cc4" from="Microsoft" modified="false" />
  29       <para>Represents a lexical scope within <see cref="T:System.Diagnostics.SymbolStore.ISymbolMethod" />, providing access to the start and end offsets of the scope, as well as its child and parent scopes.</para>
  30     </summary>
  31   </Docs>
  32   <Members>
  33     <Member MemberName="EndOffset">
  34       <MemberSignature Language="C#" Value="public int EndOffset { get; }" />
  35       <MemberSignature Language="ILAsm" Value=".property instance int32 EndOffset" />
  36       <MemberType>Property</MemberType>
  37       <AssemblyInfo>
  38         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  39         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  40         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  41       </AssemblyInfo>
  42       <ReturnValue>
  43         <ReturnType>System.Int32</ReturnType>
  44       </ReturnValue>
  45       <Docs>
  46         <value>To be added: an object of type 'int'</value>
  47         <remarks>To be added</remarks>
  48         <summary>
  49           <attribution license="cc4" from="Microsoft" modified="false" />
  50           <para>Gets the end offset of the current lexical scope.</para>
  51         </summary>
  52       </Docs>
  53     </Member>
  54     <Member MemberName="GetChildren">
  55       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.ISymbolScope[] GetChildren ();" />
  56       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Diagnostics.SymbolStore.ISymbolScope[] GetChildren() cil managed" />
  57       <MemberType>Method</MemberType>
  58       <AssemblyInfo>
  59         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  60         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  61         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  62       </AssemblyInfo>
  63       <ReturnValue>
  64         <ReturnType>System.Diagnostics.SymbolStore.ISymbolScope[]</ReturnType>
  65       </ReturnValue>
  66       <Parameters />
  67       <Docs>
  68         <remarks>To be added</remarks>
  69         <summary>
  70           <attribution license="cc4" from="Microsoft" modified="false" />
  71           <para>Gets the child lexical scopes of the current lexical scope.</para>
  72         </summary>
  73         <returns>
  74           <attribution license="cc4" from="Microsoft" modified="false" />
  75           <para>The child lexical scopes that of the current lexical scope.</para>
  76         </returns>
  77       </Docs>
  78     </Member>
  79     <Member MemberName="GetLocals">
  80       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.ISymbolVariable[] GetLocals ();" />
  81       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Diagnostics.SymbolStore.ISymbolVariable[] GetLocals() cil managed" />
  82       <MemberType>Method</MemberType>
  83       <AssemblyInfo>
  84         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  85         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  86         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  87       </AssemblyInfo>
  88       <ReturnValue>
  89         <ReturnType>System.Diagnostics.SymbolStore.ISymbolVariable[]</ReturnType>
  90       </ReturnValue>
  91       <Parameters />
  92       <Docs>
  93         <remarks>
  94           <attribution license="cc4" from="Microsoft" modified="false" />
  95           <para>The local variables are returned in no particular order. If a local variable changes its address within the current scope, that variable is returned multiple times, each with a different offset range.</para>
  96         </remarks>
  97         <summary>
  98           <attribution license="cc4" from="Microsoft" modified="false" />
  99           <para>Gets the local variables within the current lexical scope.</para>
 100         </summary>
 101         <returns>
 102           <attribution license="cc4" from="Microsoft" modified="false" />
 103           <para>The local variables within the current lexical scope.</para>
 104         </returns>
 105       </Docs>
 106     </Member>
 107     <Member MemberName="GetNamespaces">
 108       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.ISymbolNamespace[] GetNamespaces ();" />
 109       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Diagnostics.SymbolStore.ISymbolNamespace[] GetNamespaces() cil managed" />
 110       <MemberType>Method</MemberType>
 111       <AssemblyInfo>
 112         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 113         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 114         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 115       </AssemblyInfo>
 116       <ReturnValue>
 117         <ReturnType>System.Diagnostics.SymbolStore.ISymbolNamespace[]</ReturnType>
 118       </ReturnValue>
 119       <Parameters />
 120       <Docs>
 121         <remarks>To be added</remarks>
 122         <summary>
 123           <attribution license="cc4" from="Microsoft" modified="false" />
 124           <para>Gets the namespaces that are used within the current scope.</para>
 125         </summary>
 126         <returns>
 127           <attribution license="cc4" from="Microsoft" modified="false" />
 128           <para>The namespaces that are used within the current scope.</para>
 129         </returns>
 130       </Docs>
 131     </Member>
 132     <Member MemberName="Method">
 133       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.ISymbolMethod Method { get; }" />
 134       <MemberSignature Language="ILAsm" Value=".property instance class System.Diagnostics.SymbolStore.ISymbolMethod Method" />
 135       <MemberType>Property</MemberType>
 136       <AssemblyInfo>
 137         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 138         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 139         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 140       </AssemblyInfo>
 141       <ReturnValue>
 142         <ReturnType>System.Diagnostics.SymbolStore.ISymbolMethod</ReturnType>
 143       </ReturnValue>
 144       <Docs>
 145         <value>To be added: an object of type 'ISymbolMethod'</value>
 146         <remarks>To be added</remarks>
 147         <summary>
 148           <attribution license="cc4" from="Microsoft" modified="false" />
 149           <para>Gets the method that contains the current lexical scope.</para>
 150         </summary>
 151       </Docs>
 152     </Member>
 153     <Member MemberName="Parent">
 154       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.ISymbolScope Parent { get; }" />
 155       <MemberSignature Language="ILAsm" Value=".property instance class System.Diagnostics.SymbolStore.ISymbolScope Parent" />
 156       <MemberType>Property</MemberType>
 157       <AssemblyInfo>
 158         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 159         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 160         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 161       </AssemblyInfo>
 162       <ReturnValue>
 163         <ReturnType>System.Diagnostics.SymbolStore.ISymbolScope</ReturnType>
 164       </ReturnValue>
 165       <Docs>
 166         <value>To be added: an object of type 'ISymbolScope'</value>
 167         <remarks>To be added</remarks>
 168         <summary>
 169           <attribution license="cc4" from="Microsoft" modified="false" />
 170           <para>Gets the parent lexical scope of the current scope.</para>
 171         </summary>
 172       </Docs>
 173     </Member>
 174     <Member MemberName="StartOffset">
 175       <MemberSignature Language="C#" Value="public int StartOffset { get; }" />
 176       <MemberSignature Language="ILAsm" Value=".property instance int32 StartOffset" />
 177       <MemberType>Property</MemberType>
 178       <AssemblyInfo>
 179         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 180         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 181         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 182       </AssemblyInfo>
 183       <ReturnValue>
 184         <ReturnType>System.Int32</ReturnType>
 185       </ReturnValue>
 186       <Docs>
 187         <value>To be added: an object of type 'int'</value>
 188         <remarks>To be added</remarks>
 189         <summary>
 190           <attribution license="cc4" from="Microsoft" modified="false" />
 191           <para>Gets the start offset of the current lexical scope.</para>
 192         </summary>
 193       </Docs>
 194     </Member>
 195   </Members>
 196 </Type>