CloseLogChannel Method

Closes a logchannel (if it was open), flushing pending file output of logmessages before.

[Visual Basic]
Public Shared Function CloseLogChannel( _
   ByVal LogChannelName As String _
) As Boolean

[C#]
public static bool CloseLogChannel( 
   string LogChannelName
);

[JScript]
public static function CloseLogChannel( 
   LogChannelName : String
) : boolean;

Parameters

LogChannelName

The name of the logchannel, as defined in the configuration file.

Remarks

Actions:

• closes the logchannel, flushing all if of its pending output (if it was open)

Return value:

• True after successful operation
  You get this return value too if the logchannel wasn’t open before the call.
• False if an error occurred

Notes:

• The standard logchannel ("StdLog") cannot be closed by calling CloseChannel. It will always be automatically by ITLogLib.Initialize and closed by ITLogLib.Deinitialize.
• Currently this method endlessly tries to flush the output and returns only after succeeding.
• A closed logchannel can be opened again. It will then append its output to the logfile used before closing.

See Also

ITLogLib Class  | ITLogLib Members  | ITLogLib.OpenLogChannel  | ITLogLib.Initialize  | ITLogLib.Deinitialize

(c) 2002-2004 iTech Software GmbH, Berlin. Version 2.4, Wed 07 Jul 2004.