Export (0) Print
Expand All

SymDocument Class

Represents a document referenced by a symbol store.

System.Object
  System.Diagnostics.SymbolStore.SymDocumentBase
    System.Diagnostics.SymbolStore.SymDocument

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

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

The SymDocument type exposes the following members.

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

  NameDescription
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.
Top

  NameDescription
Public method{dtor}Releases the resources held by the current instance. (Inherited from SymDocumentBase.)
Public methodDispose()Releases the resources used by the current instance of the SymDocument class.
Protected methodDispose(Boolean)Infrastructure. Called by the Dispose() and Finalize() methods to release the managed and unmanaged resources used by the current instance of the SymDocument class.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeInfrastructure. Releases 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.)
Top

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.

NoteNote

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.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 3.5 SP1

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft