ClassesClassesClassesClasses | | | | Operators

clear_training_componentsclear_training_componentsClearTrainingComponentsclear_training_componentsClearTrainingComponentsClearTrainingComponents (Operator)

Name

clear_training_componentsclear_training_componentsClearTrainingComponentsclear_training_componentsClearTrainingComponentsClearTrainingComponents — Free the memory of a component training result.

Signature

clear_training_components( : : ComponentTrainingID : )

Herror clear_training_components(const Hlong ComponentTrainingID)

Herror T_clear_training_components(const Htuple ComponentTrainingID)

Herror clear_training_components(const HTuple& ComponentTrainingID)

void ClearTrainingComponents(const HTuple& ComponentTrainingID)

void HOperatorSetX.ClearTrainingComponents([in] VARIANT ComponentTrainingID)

static void HOperatorSet.ClearTrainingComponents(HTuple componentTrainingID)

Description

The operator clear_training_componentsclear_training_componentsClearTrainingComponentsclear_training_componentsClearTrainingComponentsClearTrainingComponents frees the memory of a training result that was created by train_model_componentstrain_model_componentsTrainModelComponentstrain_model_componentsTrainModelComponentsTrainModelComponents. After calling clear_training_componentsclear_training_componentsClearTrainingComponentsclear_training_componentsClearTrainingComponentsClearTrainingComponents, the training result can no longer be used. The handle ComponentTrainingIDComponentTrainingIDComponentTrainingIDComponentTrainingIDComponentTrainingIDcomponentTrainingID becomes invalid.

Parallelization

This operator modifies the state of the following input parameter:

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

ComponentTrainingIDComponentTrainingIDComponentTrainingIDComponentTrainingIDComponentTrainingIDcomponentTrainingID (input_control, state is modified)  component_training HComponentTraining, HTupleHTupleHComponentTraining, HTupleHComponentTrainingX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the training result.

Result

If the handle of the training result is valid, the operator clear_training_componentsclear_training_componentsClearTrainingComponentsclear_training_componentsClearTrainingComponentsClearTrainingComponents returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

train_model_componentstrain_model_componentsTrainModelComponentstrain_model_componentsTrainModelComponentsTrainModelComponents, write_training_componentswrite_training_componentsWriteTrainingComponentswrite_training_componentsWriteTrainingComponentsWriteTrainingComponents

Module

Matching


ClassesClassesClassesClasses | | | | Operators