Page tree
Skip to end of metadata
Go to start of metadata

Deactivates a log source from the logging system but maintains it's configuration settings so that if it is later activated with a call to LogRegisterSource, the previous settings are restored.

Syntax

Parameters

hSource
Type: LogHandle
The log handle of the log source that you wish to release 

Return Value

Type: BOOL
TRUE = successfully deactivated the log source. FALSE = failed

Remarks

A typical scenario for using LogReleaseHandle over LogUnregisterSource is if you are using the WinGate SDK to add your own services to WinGate. By using LogReleaseHandle when a user removes your service from the system, you maintain the previous settings so that if they later add your service back to their configuration, the previous settings are reloaded. This saves them the burden of reconfiguring the service from scratch.

To completely remove a log source and all it's settings, call LogUnregisterSource

Examples

None

See Also

LogRegisterSource

LogUnregisterSource