ClassesClassesClassesClasses | | | | Operators

clear_surface_modelclear_surface_modelClearSurfaceModelclear_surface_modelClearSurfaceModelClearSurfaceModel (Operator)

Name

clear_surface_modelclear_surface_modelClearSurfaceModelclear_surface_modelClearSurfaceModelClearSurfaceModel — Free the memory of a surface model.

Signature

clear_surface_model( : : SurfaceModelID : )

Herror clear_surface_model(const Hlong SurfaceModelID)

Herror T_clear_surface_model(const Htuple SurfaceModelID)

Herror clear_surface_model(const HTuple& SurfaceModelID)

void ClearSurfaceModel(const HTuple& SurfaceModelID)

void HOperatorSetX.ClearSurfaceModel([in] VARIANT SurfaceModelID)

static void HOperatorSet.ClearSurfaceModel(HTuple surfaceModelID)

Description

The operator clear_surface_modelclear_surface_modelClearSurfaceModelclear_surface_modelClearSurfaceModelClearSurfaceModel frees the memory of a surface model that was created by read_surface_modelread_surface_modelReadSurfaceModelread_surface_modelReadSurfaceModelReadSurfaceModel or create_surface_modelcreate_surface_modelCreateSurfaceModelcreate_surface_modelCreateSurfaceModelCreateSurfaceModel. After calling clear_surface_modelclear_surface_modelClearSurfaceModelclear_surface_modelClearSurfaceModelClearSurfaceModel, the model can no longer be used. The handle SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID becomes invalid.

Parallelization

Parameters

SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID (input_control)  surface_model(-array) HSurfaceModel, HTupleHTupleHSurfaceModel, HTupleHSurfaceModelX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the surface model.

Result

If the handle of the model is valid, the operator clear_surface_modelclear_surface_modelClearSurfaceModelclear_surface_modelClearSurfaceModelClearSurfaceModel returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Possible Predecessors

read_surface_modelread_surface_modelReadSurfaceModelread_surface_modelReadSurfaceModelReadSurfaceModel, create_surface_modelcreate_surface_modelCreateSurfaceModelcreate_surface_modelCreateSurfaceModelCreateSurfaceModel

Alternatives

clear_all_surface_modelsclear_all_surface_modelsClearAllSurfaceModelsclear_all_surface_modelsClearAllSurfaceModelsClearAllSurfaceModels

See also

read_surface_modelread_surface_modelReadSurfaceModelread_surface_modelReadSurfaceModelReadSurfaceModel, create_surface_modelcreate_surface_modelCreateSurfaceModelcreate_surface_modelCreateSurfaceModelCreateSurfaceModel, clear_all_surface_modelsclear_all_surface_modelsClearAllSurfaceModelsclear_all_surface_modelsClearAllSurfaceModelsClearAllSurfaceModels

Module

3D Metrology


ClassesClassesClassesClasses | | | | Operators