This documentation is archived and is not being maintained.

ISymbolDocument Interface

Represents a document referenced by a symbol store.

Namespace:  System.Diagnostics.SymbolStore
Assembly:  mscorlib (in mscorlib.dll)

public interface ISymbolDocument

The ISymbolDocument type exposes the following members.

Public propertyCheckSumAlgorithmIdGets the checksum algorithm identifier.
Public propertyDocumentTypeGets the type of the current document.
Public propertyHasEmbeddedSourceChecks whether the current document is stored in the symbol store.
Public propertyLanguageGets the language of the current document.
Public propertyLanguageVendorGets the language vendor of the current document.
Public propertySourceLengthGets the length, in bytes, of the embedded source.
Public propertyURLGets the URL of the current document.

Public methodFindClosestLineReturns the closest line that is a sequence point, given a line in the current document that might or might not be a sequence point.
Public methodGetCheckSumGets the checksum.
Public methodGetSourceRangeGets the embedded document source for the specified range.

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.


This interface is the managed counterpart of the ISymUnmanagedDocument interface, one of the unmanaged symbol store interfaces that provide an alternative way to read and write debug symbol information.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.