Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Saves the session to template.
Namespace: Microsoft.SqlServer.Management.XEvent
Assembly: Microsoft.SqlServer.Management.XEvent (in Microsoft.SqlServer.Management.XEvent.dll)
Syntax
'Declaration
Public Shared Sub SaveSessionToTemplate ( _
session As Session, _
fileName As String, _
overwrite As Boolean _
)
'Usage
Dim session As Session
Dim fileName As String
Dim overwrite As Boolean
XEStore.SaveSessionToTemplate(session, _
fileName, overwrite)
public static void SaveSessionToTemplate(
Session session,
string fileName,
bool overwrite
)
public:
static void SaveSessionToTemplate(
Session^ session,
String^ fileName,
bool overwrite
)
static member SaveSessionToTemplate :
session:Session *
fileName:string *
overwrite:bool -> unit
public static function SaveSessionToTemplate(
session : Session,
fileName : String,
overwrite : boolean
)
Parameters
- session
Type: Microsoft.SqlServer.Management.XEvent.Session
The Session object.
- fileName
Type: System.String
A string value that specifies the name of the file.
- overwrite
Type: System.Boolean
Boolean value; if True, overwrite file.
Exceptions
Exception | Condition |
---|---|
IOException | The fileName includes an incorrect or invalid syntax for file name, directory name, or volume label syntax. |
XEventException | Parameters are wrong or failed to save session. |