ClassesClasses | | Operators

clear_serialized_itemT_clear_serialized_itemClearSerializedItemClearSerializedItem (Operator)

Name

clear_serialized_itemT_clear_serialized_itemClearSerializedItemClearSerializedItem — Delete a serialized item.

Signature

clear_serialized_item( : : SerializedItemHandle : )

Herror T_clear_serialized_item(const Htuple SerializedItemHandle)

void ClearSerializedItem(const HTuple& SerializedItemHandle)

static void HSerializedItem::ClearSerializedItem(const HSerializedItemArray& SerializedItemHandle)

void HSerializedItem::ClearSerializedItem() const

static void HOperatorSet.ClearSerializedItem(HTuple serializedItemHandle)

static void HSerializedItem.ClearSerializedItem(HSerializedItem[] serializedItemHandle)

void HSerializedItem.ClearSerializedItem()

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

Parameters

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (input_control)  serialized_item(-array) HSerializedItem, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the serialized item.

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


ClassesClasses | | Operators