SymDocument Class

.NET Framework (current version)

Other Versions

Represents a document referenced by a symbol store.

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

Inheritance Hierarchy

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

Syntax

C++

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

Properties

	Name	Description
	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

	Name	Description
	{dtor}()	Releases the resources held by the current instance. (Inherited from SymDocumentBase.)
	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()	This API supports the product infrastructure and is not intended to be used directly from your code. Releases unmanaged resources and performs other cleanup operations before the SymReader is reclaimed by garbage collection.(Overrides Object::Finalize().)
	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.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

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.

Version Information

.NET Framework
Available since 1.1

Thread Safety

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