clear_sheet_of_light_modelT_clear_sheet_of_light_modelClearSheetOfLightModelClearSheetOfLightModel (Operator)

Name

clear_sheet_of_light_modelT_clear_sheet_of_light_modelClearSheetOfLightModelClearSheetOfLightModel — Delete a sheet-of-light model and free the allocated memory.

Signature

clear_sheet_of_light_model( : : SheetOfLightModelID : )

Description

The operator clear_sheet_of_light_modelclear_sheet_of_light_modelClearSheetOfLightModelClearSheetOfLightModelClearSheetOfLightModel deletes a sheet-of-light model that was created by create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelCreateSheetOfLightModel. All memory used by the model is freed. The handle of the model is passed in SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelID. After the operator call it is invalid.

Execution Information

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

This operator modifies the state of the following input parameter:

SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelID

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelID (input_control, state is modified) sheet_of_light_model → (handle)

Handle of the sheet-of-light model.

Result

The operator clear_sheet_of_light_modelclear_sheet_of_light_modelClearSheetOfLightModelClearSheetOfLightModelClearSheetOfLightModel returns the value 2 (H_MSG_TRUE) if a valid handle is passed and the referred sheet-of-light model can be freed correctly. Otherwise, an exception will be raised.

Module

3D Metrology

Operators