Type: System.Diagnostics.SymbolStore.ISymbolReader

System.Diagnostics.SymbolStore.ISymbolReader Interface

Assembly: Mscorlib.dll
Namespace: System.Diagnostics.SymbolStore

Summary: Represents a symbol reader for managed code.

C# Syntax:


        public interface ISymbolReader

Remarks

The interface provides access to documents, methods, and variables.

System.Diagnostics.SymbolStore.ISymbolReader Member List:

Public Properties

UserEntryPoint

Read-only

Gets the metadata token for the method that was specified as the user entry point for the module, if any.

Public Methods

GetDocument	Gets a document specified by the language, vendor, and type.
GetDocuments	Gets an array of all documents defined in the symbol store.
GetGlobalVariables	Gets all global variables in the module.
GetMethod	Overloaded: `GetMethod(SymbolToken method)` Gets a symbol reader method object when given the identifier of a method.
GetMethod	Overloaded: `GetMethod(SymbolToken method, int version)` Gets a symbol reader method object when given the identifier of a method and its edit and continue version.
GetMethodFromDocumentPosition	Gets a symbol reader method object that contains a specified position in a document.
GetNamespaces	Gets the namespaces that are defined in the global scope within the current symbol store.
GetSymAttribute	Gets an attribute value when given the attribute name.
GetVariables	Gets the variables that are not local when given the parent.

System.Diagnostics.SymbolStore.ISymbolReader Member Details

Property: UserEntryPoint (read-only)

Summary: Gets the metadata token for the method that was specified as the user entry point for the module, if any.

C# Syntax:


            SymbolToken UserEntryPoint {get;}

Remarks

This is normally your main method, rather than compiler-generated stubs before the main method.

Return to top

Method: GetDocument(
   string url,
   Guid language,
   Guid languageVendor,
   Guid documentType
)

Summary: Gets a document specified by the language, vendor, and type.

C# Syntax:


            ISymbolDocument GetDocument(
   string url,
   Guid language,
   Guid languageVendor,
   Guid documentType
);

Parameters:

url

The URL that identifies the document.

language

The document language. You can specify this parameter as null.

languageVendor

The identity of the vendor for the document language. You can specify this parameter as null.

documentType

The type of the document. You can specify this parameter as null.

Return Value:: The specified document.

Return to top

Method: GetDocuments()

Summary: Gets an array of all documents defined in the symbol store.

C# Syntax:


            ISymbolDocument[] GetDocuments();

Return Value:: An array of all documents defined in the symbol store.

Return to top

Method: GetGlobalVariables()

Summary: Gets all global variables in the module.

C# Syntax:


            ISymbolVariable[] GetGlobalVariables();

Return Value:: An array of all variables in the module.

Return to top

Overloaded Method: GetMethod(
SymbolToken method
)

Summary: Gets a symbol reader method object when given the identifier of a method.

C# Syntax:


            ISymbolMethod GetMethod(
   SymbolToken method
);

Parameters:

method

The metadata token of the method.

Return Value:: The symbol reader method object for the specified method identifier.

Return to top

Overloaded Method: GetMethod(
SymbolToken method,
int version
)

Summary: Gets a symbol reader method object when given the identifier of a method and its edit and continue version.

C# Syntax:


            ISymbolMethod GetMethod(
   SymbolToken method,
   int version
);

Parameters:

method

The metadata token of the method.

version

The edit and continue version of the method.

Return Value:: The symbol reader method object for the specified method identifier.

Return to top

Method: GetMethodFromDocumentPosition(
   ISymbolDocument document,
   int line,
   int column
)

Summary: Gets a symbol reader method object that contains a specified position in a document.

C# Syntax:


            ISymbolMethod GetMethodFromDocumentPosition(
   ISymbolDocument document,
   int line,
   int column
);

Parameters:

document

The document in which the method is located.

line

The position of the line within the document. The lines are numbered, beginning with 1.

column

The position of column within the document. The columns are numbered, beginning with 1.

Return Value:: The reader method object for the specified position in the document.

Return to top

Method: GetNamespaces()

Summary: Gets the namespaces that are defined in the global scope within the current symbol store.

C# Syntax:


            ISymbolNamespace[] GetNamespaces();

Return Value:: The namespaces defined in the global scope within the current symbol store.

Return to top

Method: GetSymAttribute(
SymbolToken parent,
string name
)

Summary: Gets an attribute value when given the attribute name.

C# Syntax:


            byte[] GetSymAttribute(
   SymbolToken parent,
   string name
);

Parameters:

parent

The metadata token for the object for which the attribute is requested.

name

The attribute name.

Return Value:: The value of the attribute.

Remarks

This attribute is only associated with symbolic information and is not a metadata custom attribute.

Return to top

Method: GetVariables(
SymbolToken parent
)

Summary: Gets the variables that are not local when given the parent.

C# Syntax:


            ISymbolVariable[] GetVariables(
   SymbolToken parent
);

Parameters:

parent

The metadata token for the type for which the variables are requested.

Return Value:: An array of variables for the parent.