decrypt_serialized_itemDecryptSerializedItemDecryptSerializedItemdecrypt_serialized_itemT_decrypt_serialized_item

HALCON ScriptCpp++.NETPythonC

Short description

decrypt_serialized_itemDecryptSerializedItemDecryptSerializedItemdecrypt_serialized_itemT_decrypt_serialized_item — Decrypt an encrypted item.

Signature

decrypt_serialized_item( encrypted_item EncryptedItemHandle, dict DecryptionParam, out serialized_item SerializedItemHandle )void DecryptSerializedItem( const HTuple& EncryptedItemHandle, const HTuple& DecryptionParam, HTuple* SerializedItemHandle )static void HOperatorSet.DecryptSerializedItem( HTuple encryptedItemHandle, HTuple decryptionParam, out HTuple serializedItemHandle )def decrypt_serialized_item( encrypted_item_handle: HHandle, decryption_param: HHandle ) -> HHandle

Herror T_decrypt_serialized_item( const Htuple EncryptedItemHandle, const Htuple DecryptionParam, Htuple* SerializedItemHandle )

Description

The operator decrypt_serialized_itemDecryptSerializedItem decrypts the encrypted item EncryptedItemHandleencryptedItemHandleencrypted_item_handle to the serialized item SerializedItemHandleserializedItemHandleserialized_item_handle using the secret in the dictionary DecryptionParamdecryptionParamdecryption_param. The secret must be passed in the form of a password string in the dictionary key ‘password’.

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

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

Encrypted item handle.

DecryptionParamdecryptionParamdecryption_param (input_control) dict → (handle)HTuple (HHandle)HDict, HTuple (IntPtr)HHandleHtuple (handle)

Parameters for the decryption.

Default: [][]

SerializedItemHandleserializedItemHandleserialized_item_handle (output_control) serialized_item → (handle)HTuple (HHandle)HSerializedItem, HTuple (IntPtr)HHandleHtuple (handle)

Serialized item handle.

Result

The operator decrypt_serialized_itemDecryptSerializedItem returns the value 2 (H_MSG_TRUE) if the passed handles and the parameters are valid. Otherwise, an exception is raised.

Combinations with other operators

Combinations

Possible predecessors

encrypt_serialized_itemEncryptSerializedItem, read_encrypted_itemReadEncryptedItem

Possible successors

deserialize_handleDeserializeHandle

Module

Foundation