XEStore Class

Article
08/11/2014

The XEStore class is the base class for all metadata classes and runtime classes.

Inheritance Hierarchy

System.Object
Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
Microsoft.SqlServer.Management.XEvent.XEStore

Namespace: Microsoft.SqlServer.Management.XEvent
Assembly: Microsoft.SqlServer.Management.XEvent (in Microsoft.SqlServer.Management.XEvent.dll)

Syntax

'Declaration
Public NotInheritable Class XEStore _
    Inherits SfcInstance _
    Implements ISfcDomain, ISfcDomainLite, ISfcHasConnection
'Usage
Dim instance As XEStore

public sealed class XEStore : SfcInstance, 
    ISfcDomain, ISfcDomainLite, ISfcHasConnection

public ref class XEStore sealed : public SfcInstance, 
    ISfcDomain, ISfcDomainLite, ISfcHasConnection

[<SealedAttribute>]
type XEStore =  
    class 
        inherit SfcInstance 
        interface ISfcDomain 
        interface ISfcDomainLite 
        interface ISfcHasConnection 
    end

public final class XEStore extends SfcInstance implements ISfcDomain, ISfcDomainLite, ISfcHasConnection

The XEStore type exposes the following members.

Constructors

	Name	Description
	XEStore	Initializes a new instance of the XEStore class.

Top

Properties

	Name	Description
	AbstractIdentityKey	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	EtwClassicSyncTargetInfo	Gets the etw_classic_sync_target TargetInfo object.
	EventCounterTargetInfo	Gets the event counter target information.
	EventFileTargetInfo	Gets the event file target information.
	HistogramTargetInfo	Gets the histogram target information.
	IdentityKey	Gets an SfcKey for the XEStore object.
	Metadata	Returns metadata about the instance and its domain. (Inherited from SfcInstance.)
	Name	Gets the name of XEStore object.
	ObjectInfoSet	Gets the singleton reference to the XEStore.ObjectMetadata.
	Package0Package	Gets the package0 Package object.
	Packages	Gets the packages PackageCollection.
	PairMatchingTargetInfo	Gets the pair_matching TargetInfo object.
	Parent	Gets or sets the instance parent via the keychain. (Inherited from SfcInstance.)
	Properties	Returns a collection instance properties. (Inherited from SfcInstance.)
	RingBufferTargetInfo	Gets the ring_buffer TargetInfo object.
	RunningSessionCount	Gets the running session count.
	Sessions	Gets the sessions collection.
	SfcConnection	Gets or sets the SFC connection.
	State	Returns the state of the SfcInstance object. (Inherited from SfcInstance.)
	Urn	Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)

Top

Methods

	Name	Description
	CreateIdentityKey	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	CreateSession	Represents a wrapper for Session constructor that is used to avoid accidentally passing the wrong parent.
	CreateSessionFromTemplate	Creates a Session object from template file specified by the fileName parameter.
	Discover	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	Equals	(Inherited from Object.)
	FormatPredicateExpression	Gets the string representation of the predicate expression.
	GetChildCollection	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	GetDomain	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	GetHashCode	(Inherited from Object.)
	GetPropertySet	Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
	GetType	(Inherited from Object.)
	GetTypeMetadataImpl	Indicates the domains that override by returning the right TypeMetadata class directly. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	InitializeUIPropertyState	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	OnPropertyMetadataChanges	Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
	OnPropertyValueChanges	Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
	Refresh	Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
	ResetKey	Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
	SaveSessionToTemplate	Saves the session to template.
	Serialize	Serializes the instance to XML. (Inherited from SfcInstance.)
	ToString	The string identity of a policy store is the associated server name. (Overrides SfcInstance.ToString().)

Top

Events

	Name	Description
	PropertyChanged	CLS-compliant event for property changes. (Inherited from SfcInstance.)
	PropertyMetadataChanged	CLS-compliant event for property metadata changes. (Inherited from SfcInstance.)

Top

Explicit Interface Implementations

	Name	Description
	ISfcDomain.GetExecutionEngine	Gets the execution engine.
	ISfcDomain.GetKey	Gets the key object given an Urn fragment
	ISfcDomain.GetType	Gets the Type of a class, such as XEStore, Package, EventInfo, EventColumnInfo, or TargetInfo, from the name specified by the typeName parameter.
	ISfcDomain.GetTypeMetadata	Gets the type metadata of a class specified by the typeName parameter.
	ISfcDomain.UseSfcStateManagement	XEvent uses Sfc-provided state management.
	ISfcDomainLite.DomainInstanceName	Gets the name of the domain instance.
	ISfcDomainLite.DomainName	Gets the name of the domain.
	ISfcDomainLite.GetLogicalVersion	Returns the logical version of the domain.
	ISfcHasConnection.ConnectionContext	Gets the SfcConnectionContext.
	ISfcHasConnection.GetConnection()	Gets the current connection for a query.
	ISfcHasConnection.GetConnection(SfcObjectQueryMode)	Gets the current connection for a query.
	ISfcHasConnection.SetConnection	Sets the active connection.

Top

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.

Share via