Operator Reference

HALCON Operator Reference / System / Encrypted Item

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

ClassesClasses | | Operators

read_encrypted_itemT_read_encrypted_itemReadEncryptedItemReadEncryptedItemread_encrypted_item (Operator)

read_encrypted_itemT_read_encrypted_itemReadEncryptedItemReadEncryptedItemread_encrypted_item — Read an encrypted item from a file.

Signature

read_encrypted_item( : : FileName : EncryptedItemHandle)

Herror T_read_encrypted_item(const Htuple FileName, Htuple* EncryptedItemHandle)

void ReadEncryptedItem(const HTuple& FileName, HTuple* EncryptedItemHandle)

void HEncryptedItem::HEncryptedItem(const HString& FileName)

void HEncryptedItem::HEncryptedItem(const char* FileName)

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

void HEncryptedItem::ReadEncryptedItem(const HString& FileName)

void HEncryptedItem::ReadEncryptedItem(const char* FileName)

void HEncryptedItem::ReadEncryptedItem(const wchar_t* FileName)   ( Windows only)

static void HOperatorSet.ReadEncryptedItem(HTuple fileName, out HTuple encryptedItemHandle)

public HEncryptedItem(string fileName)

void HEncryptedItem.ReadEncryptedItem(string fileName)

def read_encrypted_item(file_name: str) -> HHandle

Description

The operator read_encrypted_itemread_encrypted_itemReadEncryptedItemReadEncryptedItemread_encrypted_item reads the file FileNameFileNameFileNamefileNamefile_name and creates a new encrypted item in EncryptedItemHandleEncryptedItemHandleEncryptedItemHandleencryptedItemHandleencrypted_item_handle that is an identical copy of the saved item. The file FileNameFileNameFileNamefileNamefile_name must have been created by the operator write_encrypted_itemwrite_encrypted_itemWriteEncryptedItemWriteEncryptedItemwrite_encrypted_item.

The default HALCON file extension for encrypted item is '.henc'.

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: 'encrypted_item.henc' "encrypted_item.henc" "encrypted_item.henc" "encrypted_item.henc" "encrypted_item.henc"

File extension: .bin

EncryptedItemHandleEncryptedItemHandleEncryptedItemHandleencryptedItemHandleencrypted_item_handle (output_control)  encrypted_item → HEncryptedItem, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the encrypted item.

Result

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

Possible Successors

decrypt_serialized_itemdecrypt_serialized_itemDecryptSerializedItemDecryptSerializedItemdecrypt_serialized_item

See also

write_encrypted_itemwrite_encrypted_itemWriteEncryptedItemWriteEncryptedItemwrite_encrypted_item, encrypt_serialized_itemencrypt_serialized_itemEncryptSerializedItemEncryptSerializedItemencrypt_serialized_item

Module

Foundation

---

ClassesClasses | | Operators