decrypt_serialized_itemT_decrypt_serialized_itemDecryptSerializedItemDecryptSerializedItemdecrypt_serialized_item (Operator)

Name

decrypt_serialized_itemT_decrypt_serialized_itemDecryptSerializedItemDecryptSerializedItemdecrypt_serialized_item — Decrypt an encrypted item.

Signature

decrypt_serialized_item( : : EncryptedItemHandle, DecryptionParam : SerializedItemHandle)

Description

The operator decrypt_serialized_itemdecrypt_serialized_itemDecryptSerializedItemDecryptSerializedItemDecryptSerializedItemdecrypt_serialized_item decrypts the encrypted item EncryptedItemHandleEncryptedItemHandleEncryptedItemHandleEncryptedItemHandleencryptedItemHandleencrypted_item_handle to the serialized item SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle using the secret in the dictionary DecryptionParamDecryptionParamDecryptionParamDecryptionParamdecryptionParamdecryption_param. The secret must be passed in the form of a password string in the dictionary key 'password'.

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

EncryptedItemHandleEncryptedItemHandleEncryptedItemHandleEncryptedItemHandleencryptedItemHandleencrypted_item_handle (input_control) encrypted_item → (handle)

Encrypted item handle.

DecryptionParamDecryptionParamDecryptionParamDecryptionParamdecryptionParamdecryption_param (input_control) dict → (handle)

Parameters for the decryption.

Default value: []

SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (output_control) serialized_item → (handle)

Serialized item handle.

Result

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

Possible Predecessors

encrypt_serialized_itemencrypt_serialized_itemEncryptSerializedItemEncryptSerializedItemEncryptSerializedItemencrypt_serialized_item, read_encrypted_itemread_encrypted_itemReadEncryptedItemReadEncryptedItemReadEncryptedItemread_encrypted_item

Possible Successors

deserialize_handledeserialize_handleDeserializeHandleDeserializeHandleDeserializeHandledeserialize_handle

Module

Foundation

Operators