ClassesClassesClassesClasses | | | | Operators

clear_sheet_of_light_modelclear_sheet_of_light_modelClearSheetOfLightModelclear_sheet_of_light_modelClearSheetOfLightModelClearSheetOfLightModel (Operator)

Name

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

Signature

clear_sheet_of_light_model( : : SheetOfLightModelID : )

Herror clear_sheet_of_light_model(const Hlong SheetOfLightModelID)

Herror T_clear_sheet_of_light_model(const Htuple SheetOfLightModelID)

Herror clear_sheet_of_light_model(const HTuple& SheetOfLightModelID)

void ClearSheetOfLightModel(const HTuple& SheetOfLightModelID)

void HOperatorSetX.ClearSheetOfLightModel([in] VARIANT SheetOfLightModelID)

static void HOperatorSet.ClearSheetOfLightModel(HTuple sheetOfLightModelID)

Description

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

Attention

This operator changes the data in the handle. Therefore one and the same sheet-of-light model cannot be used concurrently in different threads when using this operator. If you want to use the same handle in multiple threads you have to synchronize the threads to assure that they do not access the same handle simultaneously. Different sheet-of-light models can be used independently and safely in different threads.

Parallelization

Parameters

SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelID (input_control)  sheet_of_light_model HSheetOfLightModel, HTupleHTupleHSheetOfLightModel, HTupleHSheetOfLightModelX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the sheet-of-light model.

Result

The operator clear_sheet_of_light_modelclear_sheet_of_light_modelClearSheetOfLightModelclear_sheet_of_light_modelClearSheetOfLightModelClearSheetOfLightModel 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.

See also

create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModel

Module

3D Metrology


ClassesClassesClassesClasses | | | | Operators