Operator Reference

close_all_bg_esticlose_all_bg_estiCloseAllBgEstiCloseAllBgEsticlose_all_bg_esti (Operator)

close_all_bg_esticlose_all_bg_estiCloseAllBgEstiCloseAllBgEsticlose_all_bg_esti — This operator is inoperable. It had the following function: Delete all background estimation data sets.

Warning

close_all_bg_esticlose_all_bg_estiCloseAllBgEstiCloseAllBgEsticlose_all_bg_esti is obsolete, inoperable, and is only provided for reasons of backward compatibility. New applications should not use close_all_bg_esticlose_all_bg_estiCloseAllBgEstiCloseAllBgEsticlose_all_bg_esti, the operator will be removed in future versions.

Signature

close_all_bg_esti( : : : )

Herror close_all_bg_esti()

Herror T_close_all_bg_esti()

void CloseAllBgEsti()

static void HMisc::CloseAllBgEsti()

static void HOperatorSet.CloseAllBgEsti()

static void HMisc.CloseAllBgEsti()

def close_all_bg_esti() -> None

Description

.

Attention

close_all_bg_esticlose_all_bg_estiCloseAllBgEstiCloseAllBgEsticlose_all_bg_esti exists solely for the purpose of implementing the “reset program” functionality in HDevelop. close_all_bg_esticlose_all_bg_estiCloseAllBgEstiCloseAllBgEsticlose_all_bg_esti must not be used in any application.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Result

If it is possible to close the background estimation data sets the operator close_all_bg_esticlose_all_bg_estiCloseAllBgEstiCloseAllBgEsticlose_all_bg_esti returns the value 2 ( H_MSG_TRUE) . Otherwise an exception is raised.

Module

Foundation