TElPGPDecryptingStream.OnPassphrase event

TElPGPDecryptingStream.OnPassphrase

This event is fired to request user's password.

Declaration

[C#]
event TSBPGPPassphraseEvent OnPassphrase;
delegate void TSBPGPPassphraseEvent(Object Sender, ref string Passphrase, ref bool Cancel);

[VB.NET]
Event OnPassphrase As TSBPGPPassphraseEvent
Delegate Sub TSBPGPPassphraseEvent(ByVal Sender As Object, ByRef Passphrase As String, ByRef Cancel As Boolean)

[Pascal]
property OnPassphrase : TSBPGPPassphraseEvent;
TSBPGPPassphraseEvent = procedure(Sender: TObject; var Passphrase: string; var Cancel : boolean) of object;

[C++]
    void get_OnPassphrase(TSBPGPPassphraseEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnPassphrase(TSBPGPPassphraseEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBPGPPassphraseEvent)(void * _ObjectData, TObjectHandle Sender, char * pcPassphrase, int32_t &szPassphrase, int8_t &Cancel);

[PHP]
    TSBPGPPassphraseEvent|callable|NULL get_OnPassphrase()
    void set_OnPassphrase(TSBPGPPassphraseEvent|callable|NULL $Value)
    callable TSBPGPPassphraseEvent(TObject $Sender, string &$Passphrase, bool &$Cancel)

[Java]
    TSBPGPPassphraseEvent getOnPassphrase();
    void setOnPassphrase(TSBPGPPassphraseEvent Value);
    TSBPGPPassphraseEvent.Callback OnPassphrase = new TSBPGPPassphraseEvent.Callback() {
        public void TSBPGPPassphraseEventCallback(TObject Sender, TSBString Passphrase, TSBBoolean Cancel) {
            //...
        }
    }

Parameters

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 TElPGPDecryptingStream to request the password if one was used for encryption.