ClassesClassesClassesClasses | | | | Operators

clear_serialized_itemclear_serialized_itemClearSerializedItemclear_serialized_itemClearSerializedItemClearSerializedItem (Operator)

Name

clear_serialized_itemclear_serialized_itemClearSerializedItemclear_serialized_itemClearSerializedItemClearSerializedItem — Delete a serialized item.

Signature

clear_serialized_item( : : SerializedItemHandle : )

Herror clear_serialized_item(const Hlong SerializedItemHandle)

Herror T_clear_serialized_item(const Htuple SerializedItemHandle)

Herror clear_serialized_item(const HTuple& SerializedItemHandle)

void ClearSerializedItem(const HTuple& SerializedItemHandle)

void HOperatorSetX.ClearSerializedItem([in] VARIANT SerializedItemHandle)

static void HOperatorSet.ClearSerializedItem(HTuple serializedItemHandle)

Description

clear_serialized_itemclear_serialized_itemClearSerializedItemclear_serialized_itemClearSerializedItemClearSerializedItem deletes a serialized item, which is passed by the handle SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItem 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_ptrGetSerializedItemPtrget_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtr. After calling clear_serialized_itemclear_serialized_itemClearSerializedItemclear_serialized_itemClearSerializedItemClearSerializedItem, the handle of the serialized item becomes invalid.

Parallelization

Parameters

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (input_control)  serialized_item(-array) HSerializedItem, HTupleHTupleHSerializedItem, HTupleHSerializedItemX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the serialized item.

Result

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

Possible Predecessors

fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItem, receive_serialized_itemreceive_serialized_itemReceiveSerializedItemreceive_serialized_itemReceiveSerializedItemReceiveSerializedItem

Module

Foundation


ClassesClassesClassesClasses | | | | Operators