Operator Reference

HALCON Operator Reference / System / Memory Block

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

read_memory_blockT_read_memory_blockReadMemoryBlockReadMemoryBlockread_memory_block (Operator)

read_memory_blockT_read_memory_blockReadMemoryBlockReadMemoryBlockread_memory_block — Read a memory block from a file.

Signature

read_memory_block( : : FileName : MemoryBlockHandle)

Herror T_read_memory_block(const Htuple FileName, Htuple* MemoryBlockHandle)

void ReadMemoryBlock(const HTuple& FileName, HTuple* MemoryBlockHandle)

void HMemoryBlock::HMemoryBlock(const HString& FileName)

void HMemoryBlock::HMemoryBlock(const char* FileName)

void HMemoryBlock::HMemoryBlock(const wchar_t* FileName)   ( Windows only)

void HMemoryBlock::ReadMemoryBlock(const HString& FileName)

void HMemoryBlock::ReadMemoryBlock(const char* FileName)

void HMemoryBlock::ReadMemoryBlock(const wchar_t* FileName)   ( Windows only)

static void HOperatorSet.ReadMemoryBlock(HTuple fileName, out HTuple memoryBlockHandle)

public HMemoryBlock(string fileName)

void HMemoryBlock.ReadMemoryBlock(string fileName)

def read_memory_block(file_name: str) -> HHandle

Description

The operator read_memory_blockread_memory_blockReadMemoryBlockReadMemoryBlockread_memory_block reads the file FileNameFileNameFileNamefileNamefile_name and creates a new memory block in MemoryBlockHandleMemoryBlockHandleMemoryBlockHandlememoryBlockHandlememory_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

FileNameFileNameFileNamefileNamefile_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"

File extension: .bin

MemoryBlockHandleMemoryBlockHandleMemoryBlockHandlememoryBlockHandlememory_block_handle (output_control)  memory_block → HMemoryBlock, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Memory block handle.

Result

The operator read_memory_blockread_memory_blockReadMemoryBlockReadMemoryBlockread_memory_block returns the value 2 ( H_MSG_TRUE) if the named file was found and correctly read. Otherwise, an exception is raised.

Possible Successors

get_memory_block_ptrget_memory_block_ptrGetMemoryBlockPtrGetMemoryBlockPtrget_memory_block_ptr, compare_memory_blockcompare_memory_blockCompareMemoryBlockCompareMemoryBlockcompare_memory_block, memory_block_to_imagememory_block_to_imageMemoryBlockToImageMemoryBlockToImagememory_block_to_image

See also

write_memory_blockwrite_memory_blockWriteMemoryBlockWriteMemoryBlockwrite_memory_block

Module

Foundation

---

ClassesClasses | | Operators