Skip to content

write_encrypted_itemWriteEncryptedItemWriteEncryptedItemwrite_encrypted_itemT_write_encrypted_item🔗

Short description🔗

write_encrypted_itemWriteEncryptedItemWriteEncryptedItemwrite_encrypted_itemT_write_encrypted_item — Write an encrypted item to a file.

Signature🔗

write_encrypted_item( encrypted_item EncryptedItemHandle, filename.write FileName )void WriteEncryptedItem( const HTuple& EncryptedItemHandle, const HTuple& FileName )static void HOperatorSet.WriteEncryptedItem( HTuple encryptedItemHandle, HTuple fileName )def write_encrypted_item( encrypted_item_handle: HHandle, file_name: str ) -> None

Herror T_write_encrypted_item( const Htuple EncryptedItemHandle, const Htuple FileName )

Description🔗

The operator write_encrypted_itemWriteEncryptedItem writes the encrypted item EncryptedItemHandleencryptedItemHandleencrypted_item_handle to the file FileNamefileNamefile_name. The item can be read again with read_encrypted_itemReadEncryptedItem.

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.

Parameters🔗

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

Handle of the encrypted item.

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

Name of the file.

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

Result🔗

The operator write_encrypted_itemWriteEncryptedItem returns the value 2 (H_MSG_TRUE) if the passed handle is valid and if the encrypted item can be written into the named file. Otherwise, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

encrypt_serialized_itemEncryptSerializedItem

See also

read_encrypted_itemReadEncryptedItem, decrypt_serialized_itemDecryptSerializedItem

Module🔗

Foundation