BaseXEStore.CreateSessionFromTemplate(String, String) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Management.XEvent

Assembly:: Microsoft.SqlServer.Management.XEvent.dll

Package:: Microsoft.SqlServer.SqlManagementObjects v150.18208.0

Package:: Microsoft.SqlServer.SqlManagementObjects v160.2004021.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates a session from template.

public virtual Microsoft.SqlServer.Management.XEvent.Session CreateSessionFromTemplate (string sessionName, string fileName);

abstract member CreateSessionFromTemplate : string * string -> Microsoft.SqlServer.Management.XEvent.Session
override this.CreateSessionFromTemplate : string * string -> Microsoft.SqlServer.Management.XEvent.Session

Public Overridable Function CreateSessionFromTemplate (sessionName As String, fileName As String) As Session

Parameters

sessionName: String

Name of the session.

fileName: String

Name of the file.

Returns

Session

A new Session.

Exceptions

UnauthorizedAccessException

The template file can't be accessed.

XmlException

The template file is malformed.

XmlSchemaValidationException

The template file doesn't conform to the schema.

XEventException

Parameters are wrong or failed to create session.

Applies to