TElSimplePGPMIMEMessage.OnKeyPassphrase property

TElSimplePGPMIMEMessage.OnKeyPassphrase

This event is fired when a password for the key is required.

Declaration

[C#]
not available

[VB.NET]
not available

[Pascal]
property OnKeyPassphrase : TSBPGPKeyPassphraseEvent;
TSBPGPKeyPassphraseEvent = procedure(Sender: TObject; Key : TElPGPCustomSecretKey; var Passphrase: string; var Cancel: boolean) of object;

[C++]
    void get_OnKeyPassphrase(TSBPGPKeyPassphraseEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnKeyPassphrase(TSBPGPKeyPassphraseEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBPGPKeyPassphraseEvent)(void * _ObjectData, TObjectHandle Sender, TElPGPCustomSecretKeyHandle Key, char * pcPassphrase, int32_t &szPassphrase, int8_t &Cancel);

[PHP]
    TSBPGPKeyPassphraseEvent|callable|NULL get_OnKeyPassphrase()
    void set_OnKeyPassphrase(TSBPGPKeyPassphraseEvent|callable|NULL $Value)
    callable TSBPGPKeyPassphraseEvent(TObject $Sender, TElPGPCustomSecretKey $Key, string &$Passphrase, bool &$Cancel)

[Java]
    TSBPGPKeyPassphraseEvent getOnKeyPassphrase();
    void setOnKeyPassphrase(TSBPGPKeyPassphraseEvent Value);
    TSBPGPKeyPassphraseEvent.Callback OnKeyPassphrase = new TSBPGPKeyPassphraseEvent.Callback() {
        public void TSBPGPKeyPassphraseEventCallback(TObject Sender, TElPGPCustomSecretKey Key, TSBString Passphrase, TSBBoolean Cancel) {
            //...
        }
    }

Parameters

Key - key which needs password.
Passphrase - password.
Cancel - True if the password can't be provided and processing must be cancelled.
pcPassphrase - password.
szPassphrase - the length of pcPassphrase.

Description

This event is fired by TElSimplePGPMIMEMessage when it needs a password to access a secret key. The event is fired until correct password is passed or Cancel parameter is set to True.
If the data contains multiple keys, OnKeyPassphrase is called for each key in a loop until the password for some key is provided correctly. For each key OnKeyPassphrase is called in a loop until the password is provided correctly or Cancel is set to True. If the password is provided correctly, then both loops are stopped and the key for which the password has been provided is used. If Cancel is set to True, OnKeyPassphrase is not called for the particular key, and processing advances to the next key.