TElPGPWriter.OnKeyPassphrase event

TElPGPWriter.OnKeyPassphrase

This event is fired when the password for user's key must be asked.

Declaration

[C#]
event TSBPGPKeyPassphraseEvent OnKeyPassphrase;
delegate void TSBPGPKeyPassphraseEvent(Object Sender, TElPGPCustomSecretKey Key, ref string Passphrase, ref bool Cancel);

[VB.NET]
Event OnKeyPassphrase As TSBPGPKeyPassphraseEvent
Delegate Sub TSBPGPKeyPassphraseEvent(ByVal Sender As Object, ByVal Key As TElPGPCustomSecretKey, ByRef Passphrase As String, ByRef Cancel As Boolean)

[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 stops requesting the password even if the user has not entered correct password.
pcPassphrase - password.
szPassphrase - the length of pcPassphrase.

Description

This event is fired when the password must be specified for a key. The event is fired until correct password is entered or Cancel parameter is set to True.