Type: System.Diagnostics.SymbolStore.ISymbolDocument

System.Diagnostics.SymbolStore.ISymbolDocument Interface

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

Summary: Represents a document referenced by a symbol store.

C# Syntax:


        public interface ISymbolDocument

Remarks

A document is defined by a URL and a document type GUID. Using the document type GUID and the URL, you can locate the document. You can optionally store document source in the symbol store.

This interface also provides access to that source, if present.

System.Diagnostics.SymbolStore.ISymbolDocument Member List:

Public Properties

CheckSumAlgorithmId	Read-only Gets the checksum algorithm identifier.
DocumentType	Read-only Gets the type of the current document.
HasEmbeddedSource	Read-only Checks whether the current document is stored in the symbol store.
Language	Read-only Gets the language of the current document.
LanguageVendor	Read-only Gets the language vendor of the current document.
SourceLength	Read-only Gets the length, in bytes, of the embedded source.
URL	Read-only Gets the URL of the current document.

Public Methods

FindClosestLine	Returns the closest line that is a sequence point, given a line in the current document that might or might not be a sequence point.
GetCheckSum	Gets the checksum.
GetSourceRange	Gets the embedded document source for the specified range.

System.Diagnostics.SymbolStore.ISymbolDocument Member Details

Property: CheckSumAlgorithmId (read-only)

Summary: Gets the checksum algorithm identifier.

C# Syntax:


            Guid CheckSumAlgorithmId {get;}

Return to top

Property: DocumentType (read-only)

Summary: Gets the type of the current document.

C# Syntax:


            Guid DocumentType {get;}

Return to top

Property: HasEmbeddedSource (read-only)

Summary: Checks whether the current document is stored in the symbol store.

C# Syntax:


            bool HasEmbeddedSource {get;}

Return to top

Property: Language (read-only)

Summary: Gets the language of the current document.

C# Syntax:


            Guid Language {get;}

Return to top

Property: LanguageVendor (read-only)

Summary: Gets the language vendor of the current document.

C# Syntax:


            Guid LanguageVendor {get;}

Return to top

Property: SourceLength (read-only)

Summary: Gets the length, in bytes, of the embedded source.

C# Syntax:


            int SourceLength {get;}

Return Value:: The source length of the current document.

Return to top

Property: URL (read-only)

Summary: Gets the URL of the current document.

C# Syntax:


            string URL {get;}

Return Value:: The URL of the current document.

Return to top

Method: FindClosestLine(
int line
)

Summary: Returns the closest line that is a sequence point, given a line in the current document that might or might not be a sequence point.

C# Syntax:


            int FindClosestLine(
   int line
);

Parameters:

line

The specified line in the document.

Return Value:: The closest line that is a sequence point.

Return to top

Method: GetCheckSum()

Summary: Gets the checksum.

C# Syntax:


            byte[] GetCheckSum();

Return Value:: The checksum.

Return to top

Method: GetSourceRange(
   int startLine,
   int startColumn,
   int endLine,
   int endColumn
)

Summary: Gets the embedded document source for the specified range.

C# Syntax:


            byte[] GetSourceRange(
   int startLine,
   int startColumn,
   int endLine,
   int endColumn
);

Parameters:

startLine

The starting line in the current document.

startColumn

The starting column in the current document.

endLine

The ending line in the current document.

endColumn

The ending column in the current document.

Return Value:: The document source for the specified range.