ClassesClassesClassesClasses | | | | Operators

fread_serialized_itemfread_serialized_itemFreadSerializedItemfread_serialized_itemFreadSerializedItemFreadSerializedItem (Operator)

Name

fread_serialized_itemfread_serialized_itemFreadSerializedItemfread_serialized_itemFreadSerializedItemFreadSerializedItem — Read a serialized item from a file.

Signature

fread_serialized_item( : : FileHandle : SerializedItemHandle)

Herror fread_serialized_item(const Hlong FileHandle, Hlong* SerializedItemHandle)

Herror T_fread_serialized_item(const Htuple FileHandle, Htuple* SerializedItemHandle)

Herror fread_serialized_item(const HTuple& FileHandle, Hlong* SerializedItemHandle)

void HSerializedItem::FreadSerializedItem(const HFile& FileHandle)

void FreadSerializedItem(const HTuple& FileHandle, HTuple* SerializedItemHandle)

void HSerializedItem::FreadSerializedItem(const HFile& FileHandle)

void HOperatorSetX.FreadSerializedItem(
[in] VARIANT FileHandle, [out] VARIANT* SerializedItemHandle)

void HSerializedItemX.FreadSerializedItem([in] IHFileX* FileHandle)

static void HOperatorSet.FreadSerializedItem(HTuple fileHandle, out HTuple serializedItemHandle)

void HSerializedItem.FreadSerializedItem(HFile fileHandle)

Description

fread_serialized_itemfread_serialized_itemFreadSerializedItemfread_serialized_itemFreadSerializedItemFreadSerializedItem reads a serialized item, that was written by fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItem from the current input file with the file handle FileHandleFileHandleFileHandleFileHandleFileHandlefileHandle (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItem for an introduction of the basics of serialization). For this, a serialized item is created and the values read from file are stored in the serialized item. The operator returns the handle of the serialized item in the parameter SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle. The file can be opened by the operator open_fileopen_fileOpenFileopen_fileOpenFileOpenFile. Note that the file must be open in binary format. For reading more than on item from one file the operator fread_serialized_itemfread_serialized_itemFreadSerializedItemfread_serialized_itemFreadSerializedItemFreadSerializedItem must be called several times.

Parallelization

Parameters

FileHandleFileHandleFileHandleFileHandleFileHandlefileHandle (input_control)  file HFile, HTupleHTupleHFile, HTupleHFileX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

File handle.

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandle (output_control)  serialized_item HSerializedItem, HTupleHTupleHSerializedItem, HTupleHSerializedItemX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the serialized item.

Result

If the parameters are valid, the operator fread_serialized_itemfread_serialized_itemFreadSerializedItemfread_serialized_itemFreadSerializedItemFreadSerializedItem returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised. The error code 9581 indicates that the end of file is reached before a serialized item could be read.

Possible Predecessors

open_fileopen_fileOpenFileopen_fileOpenFileOpenFile, fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItem

Possible Successors

close_fileclose_fileCloseFileclose_fileCloseFileCloseFile, get_serialized_item_ptrget_serialized_item_ptrGetSerializedItemPtrget_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtr, deserialize_shape_modeldeserialize_shape_modelDeserializeShapeModeldeserialize_shape_modelDeserializeShapeModelDeserializeShapeModel, deserialize_ncc_modeldeserialize_ncc_modelDeserializeNccModeldeserialize_ncc_modelDeserializeNccModelDeserializeNccModel

Module

Foundation


ClassesClassesClassesClasses | | | | Operators