overview
<p>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 <ac:link><ri:page ri:content-title="LogRegisterSource" /></ac:link>, the previous settings are restored.</p>
functiondefinition
<ac:structured-macro ac:name="code"><ac:parameter ac:name="language">cpp</ac:parameter><ac:plain-text-body><![CDATA[BOOL LogReleaseHandle(
LogHandle hSource
);]]></ac:plain-text-body></ac:structured-macro>
parameters
<p><ac:structured-macro ac:name="vardef"><ac:parameter ac:name="Name">hSource</ac:parameter><ac:parameter ac:name="Linked">true</ac:parameter><ac:parameter ac:name="Type">LogHandle</ac:parameter><ac:parameter ac:name="Style">Parameter</ac:parameter><ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter><ac:rich-text-body><p>The log handle of the log source that you wish to release </p></ac:rich-text-body></ac:structured-macro></p>
returnvalue
<p><ac:structured-macro ac:name="returnvalue"><ac:parameter ac:name="Type">BOOL</ac:parameter><ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter><ac:rich-text-body><p>TRUE = successfully deactivated the log source. FALSE = failed</p></ac:rich-text-body></ac:structured-macro></p>
remarkscontent
<p>A typical scenario for using LogReleaseHandle over <ac:link><ri:page ri:content-title="LogUnregisterSource" /></ac:link> 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.</p><p>To completely remove a log source and all it's settings, call <ac:link><ri:page ri:content-title="LogUnregisterSource" /></ac:link></p>
examplescontent
None
seealsocontent
<p><ac:link><ri:page ri:content-title="LogRegisterSource" /></ac:link></p><p><ac:link><ri:page ri:content-title="LogUnregisterSource" /></ac:link></p>