SymWriter Class

Represents a symbol writer for managed code.

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

[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public class SymWriter : SymWriterBase, ISymbolWriter, 

The SymWriter type exposes the following members.

Public methodSymWriter()Initializes a new instance of the SymWriter class.
Public methodSymWriter(Boolean)Initializes a new instance of the SymWriter class, specifying whether to create an underlying symbol writer.

Public method{dtor}Releases the resources held by the current instance. (Inherited from SymWriterBase.)
Public methodCloseCloses the SymWriter and commits the symbols to the symbol store.
Public methodCloseMethodCloses the current method.
Public methodCloseNamespaceCloses the most recent namespace.
Public methodCloseScopeCloses the current lexical scope.
Public methodDefineDocumentDefines a source document.
Public methodDefineFieldThrows a NotSupportedException in all cases.
Public methodDefineGlobalVariableThrows a NotSupportedException in all cases.
Public methodDefineLocalVariableDefines a single variable in the current lexical scope.
Public methodDefineParameterThrows a NotSupportedException in all cases.
Public methodDefineSequencePointsDefines a group of sequence points within the current method.
Public methodDispose()Releases the resources used by the current instance of the SymWriter 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 SymWriter class.
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 SymWriter is reclaimed by garbage collection. (Overrides Object.Finalize().)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetWriterGets the underlying unmanaged symbol writer.
Public methodInitializeSets the metadata emitter interface to associate with this writer.
Public methodInitWriterInitializes the symbol writer. This method should not be called directly; it is called by the constructor.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOpenMethodOpens a method in which to place symbol information.
Public methodOpenNamespaceOpens a new namespace.
Public methodOpenScopeOpens a new lexical scope in the current method.
Public methodSetMethodSourceRangeThrows a NotSupportedException in all cases.
Public methodSetScopeRangeDefines the offset range for the specified lexical scope.
Public methodSetSymAttributeDefines an attribute when given the attribute name and the attribute value.
Public methodSetUnderlyingWriterSets the underlying ISymUnmanagedWriter Interface (the corresponding unmanaged API) that a managed SymWriter uses to emit symbols.
Public methodSetUserEntryPointIdentifies the user-defined method as the entry point for the current module.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUsingNamespaceSpecifies that the given, fully qualified namespace name is used within the open lexical scope.

The SymWriter class provides methods that define documents, sequence points, lexical scopes, and variables.


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.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 3.5 SP1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft