SymDocument Class

Definition

Represents a document referenced by a symbol store.

public ref class SymDocument : System::Diagnostics::SymbolStore::SymDocumentBase, IDisposable, System::Diagnostics::SymbolStore::ISymbolDocument
[System.Runtime.InteropServices.ComVisible(true)]
public class SymDocument : System.Diagnostics.SymbolStore.SymDocumentBase, IDisposable, System.Diagnostics.SymbolStore.ISymbolDocument
type SymDocument = class
    inherit SymDocumentBase
    interface ISymbolDocument
    interface IDisposable
Public Class SymDocument
Inherits SymDocumentBase
Implements IDisposable, ISymbolDocument
Inheritance
SymDocument
Attributes
Implements

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.

Constructors

SymDocument(ISymUnmanagedDocument*)

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

SymDocument(ISymUnmanagedDocument*)

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

Properties

CheckSumAlgorithmId

Throws a NotSupportedException in all cases.

DocumentType

Gets the type of the current document.

HasEmbeddedSource

Indicates whether the source for the current document is stored in the symbol store.

Language

Gets the language of the current document.

LanguageVendor

Gets the language vendor of the current document.

SourceLength

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

URL

Gets the URL of the current document.

Methods

__dtor()

Releases the resources held by the current instance.

{dtor}()

Releases the resources held by the current instance.

Dispose()

Releases the resources used by the current instance of the SymDocument class.

Dispose(Boolean)

Called by the Dispose() and Finalize() methods to release the managed and unmanaged resources used by the current instance of the SymDocument class.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Finalize()

Releases unmanaged resources and performs other cleanup operations before the SymReader is reclaimed by garbage collection.

FindClosestLine(Int32)

Returns 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.

GetCheckSum()

Throws a NotSupportedException in all cases.

GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetSourceRange(Int32, Int32, Int32, Int32)

Throws a NotSupportedException in all cases.

GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetUnmanaged()

Gets a pointer to the unmanaged ISymUnmanagedDocument interface for this SymDocument instance.

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to