serialize_sheet_of_light_modelT_serialize_sheet_of_light_modelSerializeSheetOfLightModelSerializeSheetOfLightModel (Operator)

Name

serialize_sheet_of_light_modelT_serialize_sheet_of_light_modelSerializeSheetOfLightModelSerializeSheetOfLightModel — Serialize a sheet-of-light model.

Signature

serialize_sheet_of_light_model( : : SheetOfLightModelID : SerializedItemHandle)

Description

serialize_sheet_of_light_modelserialize_sheet_of_light_modelSerializeSheetOfLightModelSerializeSheetOfLightModelSerializeSheetOfLightModel serializes a sheet-of-light 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_sheet_of_light_modelwrite_sheet_of_light_modelWriteSheetOfLightModelWriteSheetOfLightModelWriteSheetOfLightModel is converted to a serialized item. The sheet-of-light model is defined by the handle SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelID. The serialized model is returned by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle and can be deserialized by deserialize_sheet_of_light_modeldeserialize_sheet_of_light_modelDeserializeSheetOfLightModelDeserializeSheetOfLightModelDeserializeSheetOfLightModel.

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

SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelID (input_control) sheet_of_light_model → (handle)

Handle of the sheet-of-light model.

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (output_control) serialized_item → (handle)

Handle of the serialized item.

Result

The operator serialize_sheet_of_light_modelserialize_sheet_of_light_modelSerializeSheetOfLightModelSerializeSheetOfLightModelSerializeSheetOfLightModel returns the value 2 (H_MSG_TRUE) if the passed handle of the sheet-of-light model is valid and if the model can be serialized into the serialized item. Otherwise, an exception is raised.