TElSSHPublicKeyServer.OnList event

TElSSHPublicKeyServer.OnList

This event is fired when the client has sent request for keys listing

Declaration

[C#]
event TSBSSHPublicKeyListEvent OnList;
delegate void TSBSSHPublicKeyListEvent(Object Sender, ArrayList Keys, ArrayList Attributes, ref int ErrorCode, ref string Comment);

[VB.NET]
Event OnList As TSBSSHPublicKeyListEvent
Delegate Sub TSBSSHPublicKeyListEvent(ByVal Sender As Object, ByVal Keys As ArrayList, ByVal Attributes As ArrayList, ByRef ErrorCode As Integer, ByRef Comment As String)

[Pascal]
property OnList: TSBSSHPublicKeyListEvent;
TSBSSHPublicKeyListEvent = procedure(Sender: TObject; Keys: TList; Attributes : TList; var FreeObjects : boolean; var ErrorCode: integer; var Comment : string)

[C++]
    void get_OnList(TSBSSHPublicKeyListEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnList(TSBSSHPublicKeyListEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBSSHPublicKeyListEvent)(void * _ObjectData, TObjectHandle Sender, TListHandle Keys, TListHandle Attributes, int8_t &FreeObjects, int32_t &ErrorCode, char * pcComment, int32_t &szComment);

[PHP]
    TSBSSHPublicKeyListEvent|callable|NULL get_OnList()
    void set_OnList(TSBSSHPublicKeyListEvent|callable|NULL $Value)
    callable TSBSSHPublicKeyListEvent(TObject $Sender, TList $Keys, TList $Attributes, bool &$FreeObjects, integer &$ErrorCode, string &$Comment)

[Java]
    TSBSSHPublicKeyListEvent getOnList();
    void setOnList(TSBSSHPublicKeyListEvent Value);
    TSBSSHPublicKeyListEvent.Callback OnList = new TSBSSHPublicKeyListEvent.Callback() {
        public void TSBSSHPublicKeyListEventCallback(TObject arg0, ArrayList arg1, ArrayList arg2, TSBInteger arg3, TSBString arg4) {
            //...
        }
    }

Parameters

Keys - list object where the key objects should be put
Attributes - list object where key attributes can be put
FreeObjects - If True SBSSHPubKeyServer will destroy Keys and Attributes objects otherwise they have to be freed manually.
ErrorCode - error code. Has to be assigned inside handler.
Comment - text comment for the listing result.
pcComment - text comment for the listing result.
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 requests a public key listing. All client's public keys has to be placed to the Keys list in the event handler. Attributes for corresponding keys can be placed to the Attributes list but it is not necessary. If Attributes are used then indexes in two lists have to meet (attributes have the same index as corresponding key). Server has to set ErrorCodeand Comment values according to result of request processing.

Discuss this help topic in SecureBlackbox Forum