/// <summary>
/// Executes in two distinct scenarios.
///
/// 1. If disposing is true, the method has been called directly
/// or indirectly by a user's code via the Dispose method.
/// Both managed and unmanaged resources can be disposed.
///
/// 2. If disposing is false, the method has been called by the
/// runtime from inside the finalizer and you should not reference (access)
/// other managed objects, as they already have been garbage collected.
/// Only unmanaged resources can be disposed.
/// </summary>
/// <param name="disposing"></param>
/// <remarks>
/// If any exceptions are thrown, that is fine.
/// If the method is being done in a finalizer, it will be ignored.
/// If it is thrown by client code calling Dispose,
/// it needs to be handled by fixing the bug.
///
/// If subclasses override this method, they should call the base implementation.
/// </remarks>
private void Dispose(bool disposing)
{
//Debug.WriteLineIf(!disposing, "****************** " + GetType().Name + " 'disposing' is false. ******************");
// Must not be run more than once.
if (m_isDisposed)
{
return;
}
if (disposing)
{
m_isInDispose = true;
// handle the case where the child is disposed of before the parent and not by the parent directly
if (m_OwningTask != null)
{
m_OwningTask.RemoveChildTaskReport(this); // break assocations before disposing
}
// Dispose managed resources here.
if (m_subTasks != null)
{
foreach (TaskReport task in m_subTasks)
{
task.Dispose();
}
}
Finish();
if (m_subTasks != null)
{
m_subTasks.Clear();
}
m_isInDispose = false;
}
// Dispose unmanaged resources here, whether disposing is true or false.
m_OwningTask = null;
m_currentError = null;
m_details = null;
m_description = null;
m_notificationMessage = null;
m_subTasks = null;
m_isDisposed = true;
}