serialize_templateT_serialize_templateSerializeTemplateSerializeTemplate (Operator)

Name

serialize_templateT_serialize_templateSerializeTemplateSerializeTemplate — Serialize a template.

Warning

serialize_templateserialize_templateSerializeTemplateSerializeTemplateSerializeTemplate is obsolete and is only provided for reasons of backward compatibility. New applications should use the shape-based or NCC-based operators instead.

Signature

serialize_template( : : TemplateID : SerializedItemHandle)

Description

serialize_templateserialize_templateSerializeTemplateSerializeTemplateSerializeTemplate serializes the data of a template (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_templatewrite_templateWriteTemplateWriteTemplateWriteTemplate is converted to a serialized item. The template is defined by the handle TemplateIDTemplateIDTemplateIDTemplateIDtemplateID. The serialized template is returned by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle and can be deserialized by deserialize_templatedeserialize_templateDeserializeTemplateDeserializeTemplateDeserializeTemplate.

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

TemplateIDTemplateIDTemplateIDTemplateIDtemplateID (input_control) template → (handle)

Handle of the template.

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (output_control) serialized_item → (handle)

Handle of the serialized item.

Result

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

Possible Predecessors

create_templatecreate_templateCreateTemplateCreateTemplateCreateTemplate, create_template_rotcreate_template_rotCreateTemplateRotCreateTemplateRotCreateTemplateRot

Possible Successors

fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItem, send_serialized_itemsend_serialized_itemSendSerializedItemSendSerializedItemSendSerializedItem, deserialize_templatedeserialize_templateDeserializeTemplateDeserializeTemplateDeserializeTemplate

Module

Matching

Operators