serialize_surface_modelT_serialize_surface_modelSerializeSurfaceModelSerializeSurfaceModel (Operator)

Name

serialize_surface_modelT_serialize_surface_modelSerializeSurfaceModelSerializeSurfaceModel — Serialize a surface_model.

Signature

serialize_surface_model( : : SurfaceModelID : SerializedItemHandle)

Description

serialize_surface_modelserialize_surface_modelSerializeSurfaceModelSerializeSurfaceModelSerializeSurfaceModel serializes the data of a surface model (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItem for an introduction of the basic principle of serialization). The same data that is written in a file by write_surface_modelwrite_surface_modelWriteSurfaceModelWriteSurfaceModelWriteSurfaceModel is converted to a serialized item. The surface model is defined by the handle SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID. The serialized surface model is returned by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle and can be deserialized by deserialize_surface_modeldeserialize_surface_modelDeserializeSurfaceModelDeserializeSurfaceModelDeserializeSurfaceModel.

Execution Information

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

Parameters

SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID (input_control) surface_model → (handle)

Handle of the surface model.

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (output_control) serialized_item → (handle)

Handle of the serialized item.

Result

If the parameters are valid, the operator serialize_surface_modelserialize_surface_modelSerializeSurfaceModelSerializeSurfaceModelSerializeSurfaceModel returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.