Classe Session

Represents a row in sys.server_event_sessions and includes data from sys.dm_xe_sessions if running.

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.SqlServer.Management.XEvent
Assembly :  Microsoft.SqlServer.Management.XEvent (en Microsoft.SqlServer.Management.XEvent.dll)

Syntaxe

'Déclaration
Public NotInheritable Class Session _
    Inherits SfcInstance _
    Implements ISfcCreatable, ICreatable, ISfcAlterable, IAlterable,  _
    ISfcDroppable, IDroppable, ISfcValidate, ISfcDiscoverObject
'Utilisation
Dim instance As Session

public sealed class Session : SfcInstance, 
    ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, ISfcDroppable, 
    IDroppable, ISfcValidate, ISfcDiscoverObject

public ref class Session sealed : public SfcInstance, 
    ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, ISfcDroppable, 
    IDroppable, ISfcValidate, ISfcDiscoverObject

[<SealedAttribute>]
type Session =  
    class 
        inherit SfcInstance 
        interface ISfcCreatable 
        interface ICreatable 
        interface ISfcAlterable 
        interface IAlterable 
        interface ISfcDroppable 
        interface IDroppable 
        interface ISfcValidate 
        interface ISfcDiscoverObject 
    end

public final class Session extends SfcInstance implements ISfcCreatable, ICreatable, ISfcAlterable, IAlterable, ISfcDroppable, IDroppable, ISfcValidate, ISfcDiscoverObject

Le type Session expose les membres suivants.

Constructeurs

	Nom	Description
	Session()	Initializes a new instance of Session class.
	Session(XEStore, String)	Initializes a new instance of Session class.

Haut de la page

Propriétés

	Nom	Description
	AbstractIdentityKey	Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
	AutoStart	Gets or sets a value indicating whether the AutoStart object is active or not.
	EventRetentionMode	Gets or sets the EventRetentionMode object.
	Events	Gets the EventCollection of the session.
	ID	Gets the ID object.
	IdentityKey	Gets the identity key of the session.
	IsRunning	Gets a value indicating whether this session is running.
	MaxDispatchLatency	Gets or sets the maximum dispatch latency in seconds.
	MaxEventSize	Gets or sets the size in KB of the maximum event for the session.
	MaxMemory	Gets or sets the maximum memory in KB of the session.
	MemoryPartitionMode	Gets or sets the memory partition mode from an enumeration with options for perNode, perCpu, or none.
	Metadata	Returns metadata about the instance and its domain. (hérité de SfcInstance.)
	Name	Gets the name of the Session object.
	Parent	Gets or sets the parent XEStore object.
	Properties	Returns a collection instance properties. (hérité de SfcInstance.)
	StartTime	Gets the start time.
	State	Gets the state of the object used in Alter function in session.
	Targets	Gets the TargetCollection.
	TrackCausality	Gets or sets a Boolean value indicating whether the TrackCausality object is activated.
	Urn	Returns the uniform resource name of the SfcInstance object. (hérité de SfcInstance.)

Haut de la page

Méthodes

	Nom	Description
	AddEvent(String)	Adds a new Event object to the session from fully qualified event name.
	AddEvent(EventInfo)	Adds a new Event object to the session.
	AddTarget(String)	Adds a new Target object to the session.
	AddTarget(TargetInfo)	Adds a new Target object to the session.
	Alter	Alters the Session object on the server.
	Create	Creates the Session object on the server.
	CreateIdentityKey	Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
	Discover	Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
	Drop	Drops the Session object on the server.
	Equals	(hérité de Object.)
	GetChildCollection	Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
	GetDomain	Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
	GetHashCode	(hérité de Object.)
	GetObjectFactory	Gets the SQL Foundation Class object factory.
	GetPropertySet	Returns the set of properties for the SfcInstance object. (hérité de SfcInstance.)
	GetType	(hérité de Object.)
	GetTypeMetadataImpl	Indicates the domains that override by returning the right TypeMetadata class directly. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
	InitializeUIPropertyState	Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
	OnPropertyMetadataChanges	Invoked whenever the effective value of any SfcInstance metadata is updated. (hérité de SfcInstance.)
	OnPropertyValueChanges	Invoked whenever the effective value of any SfcInstance property is updated. (hérité de SfcInstance.)
	Refresh	Refreshes the object's properties by reading them from the server. (hérité de SfcInstance.)
	RemoveEvent	Removes the specified Event object from the session.
	RemoveTarget	Removes the Target object from the session.
	ResetKey	Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SfcInstance.)
	ScriptAlter	Gets the alteration ISfcScript for the session.
	ScriptCreate	Gets the creation ISfcScript for the session.
	ScriptDrop	Gets the drop ISfcScript for the session.
	Serialize	Serializes the instance to XML. (hérité de SfcInstance.)
	Start	Starts the Session object.
	Stop	Stops the Session object.
	ToString	Returns a string representation of the instance Urn. (hérité de SfcInstance.)
	Validate(String)	Validates the specified method name.
	Validate(String, array<Object[])	Validates the method specified by the name parameter.

Haut de la page

Événements

	Nom	Description
	PropertyChanged	CLS-compliant event for property changes. (hérité de SfcInstance.)
	PropertyMetadataChanged	CLS-compliant event for property metadata changes. (hérité de SfcInstance.)

Haut de la page

Champs

	Nom	Description
	DefaultDispatchLatency	Default dispatch latency is 30 seconds.
	DefaultMaxMemory	The maximum amount of memory by default is 4 MB.
	InfiniteDispatchLatency	0 indicates that dispatch latency is infinite.
	NotStarted	Session is currently not running.

Haut de la page

Implémentations d'interfaces explicites

	Nom	Description
	ISfcDiscoverObject.Discover	Discovers or alters dependency actions and events in the Session object.

Haut de la page

Notes

The Session object is the main object that user code interacts with.

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Management.XEvent