encrypt_serialized_itemEncryptSerializedItemEncryptSerializedItemencrypt_serialized_itemT_encrypt_serialized_item

HALCON ScriptCpp++.NETPythonC

Short description

encrypt_serialized_itemEncryptSerializedItemEncryptSerializedItemencrypt_serialized_itemT_encrypt_serialized_item — Encrypt a serialized item.

Signature

encrypt_serialized_item( serialized_item SerializedItemHandle, dict EncryptionParam, out encrypted_item EncryptedItemHandle )void EncryptSerializedItem( const HTuple& SerializedItemHandle, const HTuple& EncryptionParam, HTuple* EncryptedItemHandle )static void HOperatorSet.EncryptSerializedItem( HTuple serializedItemHandle, HTuple encryptionParam, out HTuple encryptedItemHandle )def encrypt_serialized_item( serialized_item_handle: HHandle, encryption_param: HHandle ) -> HHandle

Herror T_encrypt_serialized_item( const Htuple SerializedItemHandle, const Htuple EncryptionParam, Htuple* EncryptedItemHandle )

Description

The operator encrypt_serialized_itemEncryptSerializedItem encrypts the serialized item SerializedItemHandleserializedItemHandleserialized_item_handle to the encrypted item EncryptedItemHandleencryptedItemHandleencrypted_item_handle using the secret in the dictionary EncryptionParamencryptionParamencryption_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

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

Serialized item handle.

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

Parameters for the encryption.

Default: [][]

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

Encrypted item handle.

Result

The operator encrypt_serialized_itemEncryptSerializedItem 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

serialize_handleSerializeHandle

Possible successors

write_encrypted_itemWriteEncryptedItem, decrypt_serialized_itemDecryptSerializedItem

Module

Foundation