ClassesClasses | | Operators

clear_sheet_of_light_modelclear_sheet_of_light_modelClearSheetOfLightModelClearSheetOfLightModel (Operator)

Name

clear_sheet_of_light_modelclear_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)

void ClearSheetOfLightModel(const HTuple& SheetOfLightModelID)

static void HOperatorSet.ClearSheetOfLightModel(HTuple 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

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

SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelID (input_control, state is modified)  sheet_of_light_model HSheetOfLightModel, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

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.

See also

create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelCreateSheetOfLightModel

Module

3D Metrology


ClassesClasses | | Operators