Skip to content

clear_serialized_itemClearSerializedItemClearSerializedItemclear_serialized_itemT_clear_serialized_item🔗

Short description🔗

clear_serialized_itemClearSerializedItemClearSerializedItemclear_serialized_itemT_clear_serialized_item — Delete a serialized item.

Signature🔗

clear_serialized_item( serialized_item SerializedItemHandle )void ClearSerializedItem( const HTuple& SerializedItemHandle )static void HOperatorSet.ClearSerializedItem( HTuple serializedItemHandle )def clear_serialized_item( serialized_item_handle: MaybeSequence[HHandle] ) -> None

Herror T_clear_serialized_item( const Htuple SerializedItemHandle )

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

void HSerializedItem::ClearSerializedItem( ) const

static void HSerializedItem.ClearSerializedItem( HSerializedItem[] serializedItemHandle )

void HSerializedItem.ClearSerializedItem( )

Description🔗

clear_serialized_itemClearSerializedItem deletes a serialized item, which is passed by the handle SerializedItemHandleserializedItemHandleserialized_item_handle (see fwrite_serialized_itemFwriteSerializedItem 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_ptrGetSerializedItemPtr. After calling clear_serialized_itemClearSerializedItem, the handle of the serialized item becomes invalid.

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters🔗

SerializedItemHandleserializedItemHandleserialized_item_handle (input_control, state is modified) serialized_item(-array) → (handle)HTuple (HHandle)HSerializedItem, HTuple (IntPtr)MaybeSequence[HHandle]Htuple (handle)

Handle of the serialized item.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

fwrite_serialized_itemFwriteSerializedItem, receive_serialized_itemReceiveSerializedItem

Module🔗

Foundation