serialize_templateT_serialize_templateSerializeTemplateSerializeTemplateserialize_template (Operator)
Name
serialize_templateT_serialize_templateSerializeTemplateSerializeTemplateserialize_template — Serialize a template.
Warning
serialize_templateserialize_templateSerializeTemplateSerializeTemplateSerializeTemplateserialize_template is obsolete and is only provided for
reasons of backward compatibility. New applications should use the
shape-based or NCC-based operators instead.
Signature
def serialize_template(template_id: HHandle) -> HHandle
Description
serialize_templateserialize_templateSerializeTemplateSerializeTemplateSerializeTemplateserialize_template serializes the data of a template (see
fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item for an introduction of the basic
principle of serialization). The same data that is written in a
file by write_templatewrite_templateWriteTemplateWriteTemplateWriteTemplatewrite_template is converted to a serialized item.
The template is defined by the handle TemplateIDTemplateIDTemplateIDTemplateIDtemplateIDtemplate_id. The
serialized template is returned by the handle
SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle and can be deserialized by
deserialize_templatedeserialize_templateDeserializeTemplateDeserializeTemplateDeserializeTemplatedeserialize_template.
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
TemplateIDTemplateIDTemplateIDTemplateIDtemplateIDtemplate_id (input_control) template → HTemplate, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the template.
SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (output_control) serialized_item → HSerializedItem, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the serialized item.
Result
If the parameters are valid, the operator
serialize_templateserialize_templateSerializeTemplateSerializeTemplateSerializeTemplateserialize_template returns the value 2 (
H_MSG_TRUE)
. If
necessary, an exception is raised.
Possible Predecessors
create_templatecreate_templateCreateTemplateCreateTemplateCreateTemplatecreate_template,
create_template_rotcreate_template_rotCreateTemplateRotCreateTemplateRotCreateTemplateRotcreate_template_rot
Possible Successors
fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item,
send_serialized_itemsend_serialized_itemSendSerializedItemSendSerializedItemSendSerializedItemsend_serialized_item,
deserialize_templatedeserialize_templateDeserializeTemplateDeserializeTemplateDeserializeTemplatedeserialize_template
Module
Matching