read_memory_blockT_read_memory_blockReadMemoryBlockReadMemoryBlockread_memory_block (Operator)
Name
read_memory_blockT_read_memory_blockReadMemoryBlockReadMemoryBlockread_memory_block — Read a memory block from a file.
Signature
def read_memory_block(file_name: str) -> HHandle
Description
The operator read_memory_blockread_memory_blockReadMemoryBlockReadMemoryBlockReadMemoryBlockread_memory_block reads the file FileNameFileNameFileNameFileNamefileNamefile_name and
creates a new memory block in MemoryBlockHandleMemoryBlockHandleMemoryBlockHandleMemoryBlockHandlememoryBlockHandlememory_block_handle that is an identical
copy of the bytes in the file.
The default HALCON file extension for memory block files is '.bin'.
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 returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.
Parameters
FileNameFileNameFileNameFileNamefileNamefile_name (input_control) filename.read → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the file.
Default:
'memory_block.bin'
"memory_block.bin"
"memory_block.bin"
"memory_block.bin"
"memory_block.bin"
"memory_block.bin"
File extension:
.bin
MemoryBlockHandleMemoryBlockHandleMemoryBlockHandleMemoryBlockHandlememoryBlockHandlememory_block_handle (output_control) memory_block → HMemoryBlock, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Memory block handle.
Result
The operator read_memory_blockread_memory_blockReadMemoryBlockReadMemoryBlockReadMemoryBlockread_memory_block returns the value 2 (
H_MSG_TRUE)
if the named
file was found and correctly read. Otherwise, an exception is raised.
Module
Foundation