clear_serialized_itemT_clear_serialized_itemClearSerializedItemClearSerializedItem (Operator)

Name

clear_serialized_itemT_clear_serialized_itemClearSerializedItemClearSerializedItem — Delete a serialized item.

Signature

Description

clear_serialized_itemclear_serialized_itemClearSerializedItemClearSerializedItemClearSerializedItem deletes a serialized item, which is passed by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItem for an introduction of the basics of serialization). If a serialized item is created only by a data pointer, it will not be deleted. Such a data pointer, that points to the beginning of serialized item can be created by the operator get_serialized_item_ptrget_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtrGetSerializedItemPtr. After calling clear_serialized_itemclear_serialized_itemClearSerializedItemClearSerializedItemClearSerializedItem, the handle of the serialized item becomes invalid.

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

Result

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

Possible Predecessors

fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemFwriteSerializedItem, receive_serialized_itemreceive_serialized_itemReceiveSerializedItemReceiveSerializedItemReceiveSerializedItem

Module

Foundation