write_encrypted_itemT_write_encrypted_itemWriteEncryptedItemWriteEncryptedItemwrite_encrypted_item (Operator)

Name

write_encrypted_itemT_write_encrypted_itemWriteEncryptedItemWriteEncryptedItemwrite_encrypted_item — Write an encrypted item to a file.

Signature

write_encrypted_item( : : EncryptedItemHandle, FileName : )

Description

The operator write_encrypted_itemwrite_encrypted_itemWriteEncryptedItemWriteEncryptedItemwrite_encrypted_item writes the encrypted item EncryptedItemHandleEncryptedItemHandleEncryptedItemHandleencryptedItemHandleencrypted_item_handle to the file FileNameFileNameFileNamefileNamefile_name. The item can be read again with read_encrypted_itemread_encrypted_itemReadEncryptedItemReadEncryptedItemread_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.

Parameters

EncryptedItemHandleEncryptedItemHandleEncryptedItemHandleencryptedItemHandleencrypted_item_handle (input_control) encrypted_item → (handle)

Handle of the encrypted item.

FileNameFileNameFileNamefileNamefile_name (input_control) filename.write → (string)

Name of the file.

Default: 'encrypted_item.henc' "encrypted_item.henc" "encrypted_item.henc" "encrypted_item.henc" "encrypted_item.henc"

File extension: .bin

Result

The operator write_encrypted_itemwrite_encrypted_itemWriteEncryptedItemWriteEncryptedItemwrite_encrypted_item 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.

Possible Predecessors

encrypt_serialized_itemencrypt_serialized_itemEncryptSerializedItemEncryptSerializedItemencrypt_serialized_item

Module

Foundation

Operators