TElSSHPublicKeyServer.OnAdd event

TElSSHPublicKeyServer.OnAdd

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

Declaration

[C#]
event TSBSSHPublicKeyAddEvent OnAdd;
delegate void TSBSSHPublicKeyAddEvent(Object Sender, TElSSHKey Key, TElSSHPublicKeyAttributes Attributes, bool Overwrite, ref int ErrorCode, ref string Comment);

[VB.NET]
Event OnAdd As TSBSSHPublicKeyAddEvent
Delegate Sub TSBSSHPublicKeyAddEvent(ByVal Sender As Object, ByVal Key As TElSSHKey, ByVal Attributes As TElSSHPublicKeyAttributes, ByVal Overwrite As Boolean, ByRef ErrorCode As Integer, ByRef Comment As String)

[Pascal]
property OnAdd: TSBSSHPublicKeyAddEvent;
TSBSSHPublicKeyAddEvent = procedure(Sender: TObject; Key: TElSSHKey; Attributes : TElSSHPublicKeyAttributes; Overwrite: boolean; var ErrorCode: integer; var Comment : string) of object;

[C++]
    void get_OnAdd(TSBSSHPublicKeyAddEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnAdd(TSBSSHPublicKeyAddEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBSSHPublicKeyAddEvent)(void * _ObjectData, TObjectHandle Sender, TElSSHKeyHandle Key, TElSSHPublicKeyAttributesHandle Attributes, int8_t Overwrite, int32_t &ErrorCode, char * pcComment, int32_t &szComment);

[PHP]
    TSBSSHPublicKeyAddEvent|callable|NULL get_OnAdd()
    void set_OnAdd(TSBSSHPublicKeyAddEvent|callable|NULL $Value)
    callable TSBSSHPublicKeyAddEvent(TObject $Sender, TElSSHKey $Key, TElSSHPublicKeyAttributes $Attributes, bool $Overwrite, integer &$ErrorCode, string &$Comment)

[Java]
    TSBSSHPublicKeyAddEvent getOnAdd();
    void setOnAdd(TSBSSHPublicKeyAddEvent Value);
    TSBSSHPublicKeyAddEvent.Callback OnAdd = new TSBSSHPublicKeyAddEvent.Callback() {
        public void TSBSSHPublicKeyAddEventCallback(TObject Sender, TElSSHKey Key, TElSSHPublicKeyAttributes Attributes, boolean Overwrite, TSBInteger ErrorCode, TSBString Comment) {
            //...
        }
    }

Parameters

Key - key - candidate to be added
Attributes - key attributes (version 2 only)
Overwrite - specifies if key attributes will be overwritten if the key is already present in the storage
ErrorCode - operation success code. Has to be assigned inside event 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 adding. Server has to add the key or to reject the adding in the event handler. It also has to set ErrorCode and Comment values values inside an event handler according to key adding result.