Skip to content

read_encrypted_itemReadEncryptedItemReadEncryptedItemread_encrypted_itemT_read_encrypted_item🔗

Short description🔗

read_encrypted_itemReadEncryptedItemReadEncryptedItemread_encrypted_itemT_read_encrypted_item — Read an encrypted item from a file.

Signature🔗

read_encrypted_item( filename.read FileName, out encrypted_item EncryptedItemHandle )void ReadEncryptedItem( const HTuple& FileName, HTuple* EncryptedItemHandle )static void HOperatorSet.ReadEncryptedItem( HTuple fileName, out HTuple encryptedItemHandle )def read_encrypted_item( file_name: str ) -> HHandle

Herror T_read_encrypted_item( 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)

public HEncryptedItem( string fileName )

void HEncryptedItem::ReadEncryptedItem( const HString& FileName )

void HEncryptedItem::ReadEncryptedItem( const char* FileName )

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

void HEncryptedItem.ReadEncryptedItem( string fileName )

Description🔗

The operator read_encrypted_itemReadEncryptedItem reads the file FileNamefileNamefile_name and creates a new encrypted item in EncryptedItemHandleencryptedItemHandleencrypted_item_handle that is an identical copy of the saved item. The file FileNamefileNamefile_name must have been created by the operator write_encrypted_itemWriteEncryptedItem.

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

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 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🔗

FileNamefileNamefile_name (input_control) filename.read → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the file.

Default: 'encrypted_item.henc'"encrypted_item.henc"
File extension: .bin

EncryptedItemHandleencryptedItemHandleencrypted_item_handle (output_control) encrypted_item → (handle)HTuple (HHandle)HEncryptedItem, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the encrypted item.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible successors

decrypt_serialized_itemDecryptSerializedItem

See also

write_encrypted_itemWriteEncryptedItem, encrypt_serialized_itemEncryptSerializedItem

Module🔗

Foundation