TElSSHPublicKeyServer.OnRemove event

TElSSHPublicKeyServer.OnRemove

This event is fired when the client has sent request for a key removing.

Declaration

[C#]
event TSBSSHPublicKeyRemoveEvent OnRemove;
delegate void TSBSSHPublicKeyRemoveEvent(Object Sender, TElSSHKey Key, ref int ErrorCode, ref string Comment);

[VB.NET]
Event OnRemove As TSBSSHPublicKeyRemoveEvent
Delegate Sub TSBSSHPublicKeyRemoveEvent(ByVal Sender As Object, ByVal Key As TElSSHKey, ByRef ErrorCode As Integer, ByRef Comment As String)

[Pascal]
property OnRemove: TSBSSHPublicKeyRemoveEvent;
TSBSSHPublicKeyRemoveEvent = procedure(Sender: TObject; Key: TElSSHKey; var ErrorCode: integer; var Comment : string) of object;

[C++]
    void get_OnRemove(TSBSSHPublicKeyRemoveEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnRemove(TSBSSHPublicKeyRemoveEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBSSHPublicKeyRemoveEvent)(void * _ObjectData, TObjectHandle Sender, TElSSHKeyHandle Key, int32_t &ErrorCode, char * pcComment, int32_t &szComment);

[PHP]
    TSBSSHPublicKeyRemoveEvent|callable|NULL get_OnRemove()
    void set_OnRemove(TSBSSHPublicKeyRemoveEvent|callable|NULL $Value)
    callable TSBSSHPublicKeyRemoveEvent(TObject $Sender, TElSSHKey $Key, integer &$ErrorCode, string &$Comment)

[Java]
    TSBSSHPublicKeyRemoveEvent getOnRemove();
    void setOnRemove(TSBSSHPublicKeyRemoveEvent Value);
    TSBSSHPublicKeyRemoveEvent.Callback OnRemove = new TSBSSHPublicKeyRemoveEvent.Callback() {
        public void TSBSSHPublicKeyRemoveEventCallback(TObject Sender, TElSSHKey Key, TSBInteger ErrorCode, TSBString Comment) {
            //...
        }
    }

Parameters

Key - key to be removed
ErrorCode - operation success code. Has to be inserted inside handler.
Comment - text comment. Has to be inserted inside handler.
pcComment - text comment. Has to be inserted inside handler.
szComment - the length of pcComment.

ErrorCode values

Definition		Value
SSH_PUBLICKEY_SUCCESS		0 (0x00)
SSH_PUBLICKEY_ACCESS_DENIED		1 (0x01)
SSH_PUBLICKEY_STORAGE_EXCEEDED		2 (0x02)
SSH_PUBLICKEY_VERSION_NOT_SUPPORTED		3 (0x03)
SSH_PUBLICKEY_KEY_NOT_FOUND		4 (0x04)
SSH_PUBLICKEY_KEY_NOT_SUPPORTED		5 (0x05)
SSH_PUBLICKEY_KEY_ALREADY_PRESENT		6 (0x06)
SSH_PUBLICKEY_GENERAL_FAILURE		7 (0x07)
SSH_PUBLICKEY_REQUEST_NOT_SUPPORTED		8 (0x08)
SSH_PUBLICKEY_ATTRIBUTE_NOT_SUPPORTED		9 (0x09)

Description

This event is fired when client sent the request for public key removing. Server has to remove the key or to reject the removing and return error in the ErrorCode parameter.