decrypt_serialized_itemT_decrypt_serialized_itemDecryptSerializedItemDecryptSerializedItemdecrypt_serialized_item (Operator)
Name
decrypt_serialized_itemT_decrypt_serialized_itemDecryptSerializedItemDecryptSerializedItemdecrypt_serialized_item — Decrypt an encrypted item.
Signature
Description
The operator decrypt_serialized_itemdecrypt_serialized_itemDecryptSerializedItemDecryptSerializedItemdecrypt_serialized_item decrypts the encrypted item
EncryptedItemHandleEncryptedItemHandleEncryptedItemHandleencryptedItemHandleencrypted_item_handle to the serialized item
SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle using the secret in the dictionary
DecryptionParamDecryptionParamDecryptionParamdecryptionParamdecryption_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
EncryptedItemHandleEncryptedItemHandleEncryptedItemHandleencryptedItemHandleencrypted_item_handle (input_control) encrypted_item → HEncryptedItem, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Encrypted item handle.
DecryptionParamDecryptionParamDecryptionParamdecryptionParamdecryption_param (input_control) dict → HDict, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Parameters for the decryption.
Default:
[]
SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (output_control) serialized_item → HSerializedItem, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Serialized item handle.
Result
The operator decrypt_serialized_itemdecrypt_serialized_itemDecryptSerializedItemDecryptSerializedItemdecrypt_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_itemEncryptSerializedItemEncryptSerializedItemencrypt_serialized_item,
read_encrypted_itemread_encrypted_itemReadEncryptedItemReadEncryptedItemread_encrypted_item
Possible Successors
deserialize_handledeserialize_handleDeserializeHandleDeserializeHandledeserialize_handle
Module
Foundation