serialize_templateserialize_templateSerializeTemplateserialize_templateSerializeTemplateSerializeTemplate (Operator)

Name

serialize_templateserialize_templateSerializeTemplateserialize_templateSerializeTemplateSerializeTemplate — Serialize a template.

Signature

serialize_template( : : TemplateID : SerializedItemHandle)

Description

serialize_templateserialize_templateSerializeTemplateserialize_templateSerializeTemplateSerializeTemplate serializes the data of a template (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItem for an introduction of the basic principle of serialization). The same data that is written in a file by write_templatewrite_templateWriteTemplatewrite_templateWriteTemplateWriteTemplate is converted to a serialized item. The template is defined by the handle TemplateIDTemplateIDTemplateIDTemplateIDTemplateIDtemplateID. The serialized template is returned by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle and can be deserialized by deserialize_templatedeserialize_templateDeserializeTemplatedeserialize_templateDeserializeTemplateDeserializeTemplate.

Parallelization

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

Parameters

TemplateIDTemplateIDTemplateIDTemplateIDTemplateIDtemplateID (input_control) template → (integer)

Handle of the template.

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (output_control) serialized_item → (integer)

Handle of the serialized item.

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

Possible Predecessors

create_templatecreate_templateCreateTemplatecreate_templateCreateTemplateCreateTemplate, create_template_rotcreate_template_rotCreateTemplateRotcreate_template_rotCreateTemplateRotCreateTemplateRot

Possible Successors

fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItem, send_serialized_itemsend_serialized_itemSendSerializedItemsend_serialized_itemSendSerializedItemSendSerializedItem, deserialize_templatedeserialize_templateDeserializeTemplatedeserialize_templateDeserializeTemplateDeserializeTemplate

Module

Matching

Operators