StartSession(AgentConfiguration,IMessageSourceProvider,String) Method

In This Topic

Attempt to activate the agent.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Shared Sub StartSession( _
   ByVal configuration As AgentConfiguration, _
   ByVal sourceProvider As IMessageSourceProvider, _
   ByVal reason As String _
)

public static void StartSession( 
   AgentConfiguration configuration,
   IMessageSourceProvider sourceProvider,
   string reason
)

Parameters

configuration: The Agent configuration to use instead of any configuration in the app.config file.
sourceProvider: An IMessageSourceProvider object which supplies the source information about this log message.
reason: A caption for the reason the session is starting, or null.

Remarks

If the agent is already active this call has no effect. When starting, the agent will raise an Initializing event which can be canceled. If it cancels then the session has not been started. All calls to the agent are safe whether it has been activated or not.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

Log Class
Log Members
Overload List

Send Feedback