encrypt_serialized_itemT_encrypt_serialized_itemEncryptSerializedItemEncryptSerializedItemencrypt_serialized_item (Operator)
Name
encrypt_serialized_itemT_encrypt_serialized_itemEncryptSerializedItemEncryptSerializedItemencrypt_serialized_item — Encrypt a serialized item.
Signature
Description
The operator encrypt_serialized_itemencrypt_serialized_itemEncryptSerializedItemEncryptSerializedItemEncryptSerializedItemencrypt_serialized_item encrypts the serialized item
SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle to the encrypted item
EncryptedItemHandleEncryptedItemHandleEncryptedItemHandleEncryptedItemHandleencryptedItemHandleencrypted_item_handle using the secret in the dictionary
EncryptionParamEncryptionParamEncryptionParamEncryptionParamencryptionParamencryption_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
SerializedItemHandleSerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (input_control) serialized_item → HSerializedItem, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Serialized item handle.
EncryptionParamEncryptionParamEncryptionParamEncryptionParamencryptionParamencryption_param (input_control) dict → HDict, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Parameters for the encryption.
Default value: []
EncryptedItemHandleEncryptedItemHandleEncryptedItemHandleEncryptedItemHandleencryptedItemHandleencrypted_item_handle (output_control) encrypted_item → HEncryptedItem, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Encrypted item handle.
Result
The operator encrypt_serialized_itemencrypt_serialized_itemEncryptSerializedItemEncryptSerializedItemEncryptSerializedItemencrypt_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
serialize_handleserialize_handleSerializeHandleSerializeHandleSerializeHandleserialize_handle
Possible Successors
write_encrypted_itemwrite_encrypted_itemWriteEncryptedItemWriteEncryptedItemWriteEncryptedItemwrite_encrypted_item,
decrypt_serialized_itemdecrypt_serialized_itemDecryptSerializedItemDecryptSerializedItemDecryptSerializedItemdecrypt_serialized_item
Module
Foundation