SymDocument Class

SymDocument Class

Represents a document referenced by a symbol store.


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

[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public class SymDocument : ISymbolDocument

The SymDocument type exposes the following members.

Public methodSymDocumentInitializes a new instance of the SymDocument class using the specified pointer to an unmanaged ISymUnmanagedDocument object.

Public propertyCheckSumAlgorithmIdThrows a NotSupportedException in all cases.
Public propertyDocumentTypeGets the type of the current document.
Public propertyHasEmbeddedSourceIndicates whether the source for 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 method{dtor}Infrastructure. Releases the resources held by the current instance.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeReleases unmanaged resources and performs other cleanup operations before the SymReader is reclaimed by garbage collection. (Overrides Object.Finalize().)
Public methodFindClosestLineReturns the line number of 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 methodGetCheckSumThrows a NotSupportedException in all cases.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetSourceRangeThrows a NotSupportedException in all cases.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUnmanagedGets a pointer to the unmanaged ISymUnmanagedDocument interface for this SymDocument instance.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

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.


The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

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

.NET Framework Client Profile

Supported in: 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

© 2016 Microsoft