ITLogMsg::Cancel

 

bool Cancel();

 

Purpose:

§      Cancel the underlying logmessage -- destroy it without sending it for output to the logchannel.

 

Return value:

§      true if the logmessage was sent by this call

(That is, if ITLogMsg.WillBeLogged was true before the call.)

§      false otherwise

 

Notes:

§      After the operation ITLogMsg.WillBeLogged is always False.

§      The object can be reused by calling one of ITLogMsg.Create.

 

See also:

§      ITLogMsg.WillBeLogged

§      Creating ITLogMsg objects