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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="ISymbolReader" FullName="System.Diagnostics.SymbolStore.ISymbolReader">
   3   <TypeSignature Maintainer="auto" Language="C#" Value="public interface ISymbolReader" />
   4   <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ISymbolReader" />
   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 interface provides access to documents, methods, and variables.</para>
  23       <block subset="none" type="note">
  24         <para>This interface is the managed counterpart of the ISymUnmanagedReader interface, one of the unmanaged symbol store interfaces that provide an alternative 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 symbol reader for managed code.</para>
  30     </summary>
  31   </Docs>
  32   <Members>
  33     <Member MemberName="GetDocument">
  34       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.ISymbolDocument GetDocument (string url, Guid language, Guid languageVendor, Guid documentType);" />
  35       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Diagnostics.SymbolStore.ISymbolDocument GetDocument(string url, valuetype System.Guid language, valuetype System.Guid languageVendor, valuetype System.Guid documentType) cil managed" />
  36       <MemberType>Method</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.Diagnostics.SymbolStore.ISymbolDocument</ReturnType>
  44       </ReturnValue>
  45       <Parameters>
  46         <Parameter Name="url" Type="System.String" />
  47         <Parameter Name="language" Type="System.Guid" />
  48         <Parameter Name="languageVendor" Type="System.Guid" />
  49         <Parameter Name="documentType" Type="System.Guid" />
  50       </Parameters>
  51       <Docs>
  52         <remarks>To be added</remarks>
  53         <summary>
  54           <attribution license="cc4" from="Microsoft" modified="false" />
  55           <para>Gets a document specified by the language, vendor, and type.</para>
  56         </summary>
  57         <returns>
  58           <attribution license="cc4" from="Microsoft" modified="false" />
  59           <para>The specified document.</para>
  60         </returns>
  61         <param name="url">
  62           <attribution license="cc4" from="Microsoft" modified="false" />The URL that identifies the document. </param>
  63         <param name="language">
  64           <attribution license="cc4" from="Microsoft" modified="false" />The document language. You can specify this parameter as <see cref="F:System.Guid.Empty" />. </param>
  65         <param name="languageVendor">
  66           <attribution license="cc4" from="Microsoft" modified="false" />The identity of the vendor for the document language. You can specify this parameter as <see cref="F:System.Guid.Empty" />.</param>
  67         <param name="documentType">
  68           <attribution license="cc4" from="Microsoft" modified="false" />The type of the document. You can specify this parameter as <see cref="F:System.Guid.Empty" />.</param>
  69       </Docs>
  70     </Member>
  71     <Member MemberName="GetDocuments">
  72       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.ISymbolDocument[] GetDocuments ();" />
  73       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Diagnostics.SymbolStore.ISymbolDocument[] GetDocuments() cil managed" />
  74       <MemberType>Method</MemberType>
  75       <AssemblyInfo>
  76         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  77         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  78         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  79       </AssemblyInfo>
  80       <ReturnValue>
  81         <ReturnType>System.Diagnostics.SymbolStore.ISymbolDocument[]</ReturnType>
  82       </ReturnValue>
  83       <Parameters />
  84       <Docs>
  85         <remarks>To be added</remarks>
  86         <summary>
  87           <attribution license="cc4" from="Microsoft" modified="false" />
  88           <para>Gets an array of all documents defined in the symbol store.</para>
  89         </summary>
  90         <returns>
  91           <attribution license="cc4" from="Microsoft" modified="false" />
  92           <para>An array of all documents defined in the symbol store.</para>
  93         </returns>
  94       </Docs>
  95     </Member>
  96     <Member MemberName="GetGlobalVariables">
  97       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.ISymbolVariable[] GetGlobalVariables ();" />
  98       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Diagnostics.SymbolStore.ISymbolVariable[] GetGlobalVariables() cil managed" />
  99       <MemberType>Method</MemberType>
 100       <AssemblyInfo>
 101         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 102         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 103         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 104       </AssemblyInfo>
 105       <ReturnValue>
 106         <ReturnType>System.Diagnostics.SymbolStore.ISymbolVariable[]</ReturnType>
 107       </ReturnValue>
 108       <Parameters />
 109       <Docs>
 110         <remarks>To be added</remarks>
 111         <summary>
 112           <attribution license="cc4" from="Microsoft" modified="false" />
 113           <para>Gets all global variables in the module.</para>
 114         </summary>
 115         <returns>
 116           <attribution license="cc4" from="Microsoft" modified="false" />
 117           <para>An array of all variables in the module.</para>
 118         </returns>
 119       </Docs>
 120     </Member>
 121     <Member MemberName="GetMethod">
 122       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.ISymbolMethod GetMethod (System.Diagnostics.SymbolStore.SymbolToken method);" />
 123       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Diagnostics.SymbolStore.ISymbolMethod GetMethod(valuetype System.Diagnostics.SymbolStore.SymbolToken method) cil managed" />
 124       <MemberType>Method</MemberType>
 125       <AssemblyInfo>
 126         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 127         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 128         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 129       </AssemblyInfo>
 130       <ReturnValue>
 131         <ReturnType>System.Diagnostics.SymbolStore.ISymbolMethod</ReturnType>
 132       </ReturnValue>
 133       <Parameters>
 134         <Parameter Name="method" Type="System.Diagnostics.SymbolStore.SymbolToken" />
 135       </Parameters>
 136       <Docs>
 137         <remarks>To be added</remarks>
 138         <summary>
 139           <attribution license="cc4" from="Microsoft" modified="false" />
 140           <para>Gets a symbol reader method object when given the identifier of a method.</para>
 141         </summary>
 142         <returns>
 143           <attribution license="cc4" from="Microsoft" modified="false" />
 144           <para>The symbol reader method object for the specified method identifier.</para>
 145         </returns>
 146         <param name="method">
 147           <attribution license="cc4" from="Microsoft" modified="false" />The metadata token of the method. </param>
 148       </Docs>
 149     </Member>
 150     <Member MemberName="GetMethod">
 151       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.ISymbolMethod GetMethod (System.Diagnostics.SymbolStore.SymbolToken method, int version);" />
 152       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Diagnostics.SymbolStore.ISymbolMethod GetMethod(valuetype System.Diagnostics.SymbolStore.SymbolToken method, int32 version) cil managed" />
 153       <MemberType>Method</MemberType>
 154       <AssemblyInfo>
 155         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 156         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 157         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 158       </AssemblyInfo>
 159       <ReturnValue>
 160         <ReturnType>System.Diagnostics.SymbolStore.ISymbolMethod</ReturnType>
 161       </ReturnValue>
 162       <Parameters>
 163         <Parameter Name="method" Type="System.Diagnostics.SymbolStore.SymbolToken" />
 164         <Parameter Name="version" Type="System.Int32" />
 165       </Parameters>
 166       <Docs>
 167         <remarks>To be added</remarks>
 168         <summary>
 169           <attribution license="cc4" from="Microsoft" modified="false" />
 170           <para>Gets a symbol reader method object when given the identifier of a method and its edit and continue version.</para>
 171         </summary>
 172         <returns>
 173           <attribution license="cc4" from="Microsoft" modified="false" />
 174           <para>The symbol reader method object for the specified method identifier.</para>
 175         </returns>
 176         <param name="method">
 177           <attribution license="cc4" from="Microsoft" modified="false" />The metadata token of the method. </param>
 178         <param name="version">
 179           <attribution license="cc4" from="Microsoft" modified="false" />The edit and continue version of the method. </param>
 180       </Docs>
 181     </Member>
 182     <Member MemberName="GetMethodFromDocumentPosition">
 183       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.ISymbolMethod GetMethodFromDocumentPosition (System.Diagnostics.SymbolStore.ISymbolDocument document, int line, int column);" />
 184       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Diagnostics.SymbolStore.ISymbolMethod GetMethodFromDocumentPosition(class System.Diagnostics.SymbolStore.ISymbolDocument document, int32 line, int32 column) cil managed" />
 185       <MemberType>Method</MemberType>
 186       <AssemblyInfo>
 187         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 188         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 189         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 190       </AssemblyInfo>
 191       <ReturnValue>
 192         <ReturnType>System.Diagnostics.SymbolStore.ISymbolMethod</ReturnType>
 193       </ReturnValue>
 194       <Parameters>
 195         <Parameter Name="document" Type="System.Diagnostics.SymbolStore.ISymbolDocument" />
 196         <Parameter Name="line" Type="System.Int32" />
 197         <Parameter Name="column" Type="System.Int32" />
 198       </Parameters>
 199       <Docs>
 200         <remarks>To be added</remarks>
 201         <summary>
 202           <attribution license="cc4" from="Microsoft" modified="false" />
 203           <para>Gets a symbol reader method object that contains a specified position in a document.</para>
 204         </summary>
 205         <returns>
 206           <attribution license="cc4" from="Microsoft" modified="false" />
 207           <para>The reader method object for the specified position in the document.</para>
 208         </returns>
 209         <param name="document">
 210           <attribution license="cc4" from="Microsoft" modified="false" />The document in which the method is located. </param>
 211         <param name="line">
 212           <attribution license="cc4" from="Microsoft" modified="false" />The position of the line within the document. The lines are numbered, beginning with 1. </param>
 213         <param name="column">
 214           <attribution license="cc4" from="Microsoft" modified="false" />The position of column within the document. The columns are numbered, beginning with 1. </param>
 215       </Docs>
 216     </Member>
 217     <Member MemberName="GetNamespaces">
 218       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.ISymbolNamespace[] GetNamespaces ();" />
 219       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Diagnostics.SymbolStore.ISymbolNamespace[] GetNamespaces() cil managed" />
 220       <MemberType>Method</MemberType>
 221       <AssemblyInfo>
 222         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 223         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 224         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 225       </AssemblyInfo>
 226       <ReturnValue>
 227         <ReturnType>System.Diagnostics.SymbolStore.ISymbolNamespace[]</ReturnType>
 228       </ReturnValue>
 229       <Parameters />
 230       <Docs>
 231         <remarks>To be added</remarks>
 232         <summary>
 233           <attribution license="cc4" from="Microsoft" modified="false" />
 234           <para>Gets the namespaces that are defined in the global scope within the current symbol store.</para>
 235         </summary>
 236         <returns>
 237           <attribution license="cc4" from="Microsoft" modified="false" />
 238           <para>The namespaces defined in the global scope within the current symbol store.</para>
 239         </returns>
 240       </Docs>
 241     </Member>
 242     <Member MemberName="GetSymAttribute">
 243       <MemberSignature Language="C#" Value="public byte[] GetSymAttribute (System.Diagnostics.SymbolStore.SymbolToken parent, string name);" />
 244       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance unsigned int8[] GetSymAttribute(valuetype System.Diagnostics.SymbolStore.SymbolToken parent, string name) cil managed" />
 245       <MemberType>Method</MemberType>
 246       <AssemblyInfo>
 247         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 248         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 249         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 250       </AssemblyInfo>
 251       <ReturnValue>
 252         <ReturnType>System.Byte[]</ReturnType>
 253       </ReturnValue>
 254       <Parameters>
 255         <Parameter Name="parent" Type="System.Diagnostics.SymbolStore.SymbolToken" />
 256         <Parameter Name="name" Type="System.String" />
 257       </Parameters>
 258       <Docs>
 259         <remarks>
 260           <attribution license="cc4" from="Microsoft" modified="false" />
 261           <para>This attribute is only associated with symbolic information and is not a metadata custom attribute.</para>
 262         </remarks>
 263         <summary>
 264           <attribution license="cc4" from="Microsoft" modified="false" />
 265           <para>Gets an attribute value when given the attribute name.</para>
 266         </summary>
 267         <returns>
 268           <attribution license="cc4" from="Microsoft" modified="false" />
 269           <para>The value of the attribute.</para>
 270         </returns>
 271         <param name="parent">
 272           <attribution license="cc4" from="Microsoft" modified="false" />The metadata token for the object for which the attribute is requested. </param>
 273         <param name="name">
 274           <attribution license="cc4" from="Microsoft" modified="false" />The attribute name. </param>
 275       </Docs>
 276     </Member>
 277     <Member MemberName="GetVariables">
 278       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.ISymbolVariable[] GetVariables (System.Diagnostics.SymbolStore.SymbolToken parent);" />
 279       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Diagnostics.SymbolStore.ISymbolVariable[] GetVariables(valuetype System.Diagnostics.SymbolStore.SymbolToken parent) cil managed" />
 280       <MemberType>Method</MemberType>
 281       <AssemblyInfo>
 282         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 283         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 284         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 285       </AssemblyInfo>
 286       <ReturnValue>
 287         <ReturnType>System.Diagnostics.SymbolStore.ISymbolVariable[]</ReturnType>
 288       </ReturnValue>
 289       <Parameters>
 290         <Parameter Name="parent" Type="System.Diagnostics.SymbolStore.SymbolToken" />
 291       </Parameters>
 292       <Docs>
 293         <remarks>To be added</remarks>
 294         <summary>
 295           <attribution license="cc4" from="Microsoft" modified="false" />
 296           <para>Gets the variables that are not local when given the parent.</para>
 297         </summary>
 298         <returns>
 299           <attribution license="cc4" from="Microsoft" modified="false" />
 300           <para>An array of variables for the parent.</para>
 301         </returns>
 302         <param name="parent">
 303           <attribution license="cc4" from="Microsoft" modified="false" />The metadata token for the type for which the variables are requested. </param>
 304       </Docs>
 305     </Member>
 306     <Member MemberName="UserEntryPoint">
 307       <MemberSignature Language="C#" Value="public System.Diagnostics.SymbolStore.SymbolToken UserEntryPoint { get; }" />
 308       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Diagnostics.SymbolStore.SymbolToken UserEntryPoint" />
 309       <MemberType>Property</MemberType>
 310       <AssemblyInfo>
 311         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 312         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 313         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 314       </AssemblyInfo>
 315       <ReturnValue>
 316         <ReturnType>System.Diagnostics.SymbolStore.SymbolToken</ReturnType>
 317       </ReturnValue>
 318       <Docs>
 319         <value>To be added: an object of type 'SymbolToken'</value>
 320         <remarks>
 321           <attribution license="cc4" from="Microsoft" modified="false" />
 322           <para>This is normally your main method, rather than compiler-generated stubs before the main method.</para>
 323         </remarks>
 324         <summary>
 325           <attribution license="cc4" from="Microsoft" modified="false" />
 326           <para>Gets the metadata token for the method that was specified as the user entry point for the module, if any.</para>
 327         </summary>
 328       </Docs>
 329     </Member>
 330   </Members>
 331 </Type>