Discuss this help topic in SecureBlackbox Forum

TElSSHPublicKeyServer.OnListAttributes

TElSSHPublicKeyServer     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


This event is fired when the client has sent request for supported key attributes list (only version 2 or higher).

Declaration

[C#/Java]
    event TSBSSHPublicKeyListAttributesEvent OnListAttributes;
    delegate void TSBSSHPublicKeyListAttributesEvent(Object Sender, TElStringList Names, TElBits Compulsories, ref int ErrorCode, ref string Comment);

[VB.NET]
    Event OnListAttributes As TSBSSHPublicKeyListAttributesEvent
    Delegate Sub TSBSSHPublicKeyListAttributesEvent(ByVal Sender As Object, ByVal Names As TElStringList, ByVal Compulsories As TElBits, ByRef ErrorCode As Integer, ByRef Comment As String)

[Pascal]
    property OnListAttributes: TSBSSHPublicKeyListAttributesEvent;
    TSBSSHPublicKeyListAttributesEvent = procedure(Sender: TObject; Names : TStringList; Compulsories : TBits; var ErrorCode: integer; var Comment : string) of object;

[C++]
    void get_OnListAttributes(TSBSSHPublicKeyListAttributesEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnListAttributes(TSBSSHPublicKeyListAttributesEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBSSHPublicKeyListAttributesEvent)(void * _ObjectData, TObjectHandle Sender, TStringListHandle Names, TBitsHandle Compulsories, int32_t &ErrorCode, char * pcComment, int32_t &szComment);

[PHP]
    TSBSSHPublicKeyListAttributesEvent|callable|NULL get_OnListAttributes()
    void set_OnListAttributes(TSBSSHPublicKeyListAttributesEvent|callable|NULL $Value)
    callable TSBSSHPublicKeyListAttributesEvent(TObject $Sender, TStringList $Names, TBits $Compulsories, integer &$ErrorCode, string &$Comment)

Parameters

  • Names - list object for names of supports attributes
  • Compulsories - list object where attributes compulsories can be written. This list is optional.
  • FreeObjects - If True SBSSHPubKeyServer will free Keys and Attributes objects otherwise they have to be freed manually.
  • ErrorCode - error code. Has to be inserted inside handler.
  • Comment - text comment for the error code.
  • pcComment - text comment for the error code.
  • szComment - the length of pcComment.

ErrorCode values


Description

    This event is fired when client sent the request for supported key attributes listing. User (i.e., you) has to assign ErrorCode and Comment values inside an event handleraccording to result of request processing. It can also specify corresponding compulsories in the Compulsories list. Server has to set ErrorCodeand Comment values appropriate to the operation success in the handler.

See also:     OnList     OnAttributeSupported    

Discuss this help topic in SecureBlackbox Forum