TElCardDAVOptions.OnSetAsAddressBook event

TElCardDAVOptions.OnSetAsAddressBook

This event is fired when a client requests to mark a collection as address book.

Declaration

[C#]
event TSBWebDAVSetAsAddressBookEvent OnSetAsAddressBook;
delegate void TSBWebDAVSetAsAddressBookEvent(Object Sender, string URL, TElWebDAVPrincipal Principal, ref bool Success);

[VB.NET]
Event OnSetAsAddressBook As TSBWebDAVSetAsAddressBookEvent
Delegate Sub TSBWebDAVSetAsAddressBookEvent(ByVal Sender As Object, ByVal URL As String, ByVal Principal As TElWebDAVPrincipal, ByRef Success As Boolean)

[Pascal]
property OnSetAsAddressBook : TSBWebDAVSetAsAddressBookEvent;
TSBWebDAVSetAsAddressBookEvent = procedure(Sender : TObject; const URL : string; Principal : TElWebDAVPrincipal; var Success : boolean) of object;

[C++]
    void get_OnSetAsAddressBook(TSBWebDAVSetAsAddressBookEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnSetAsAddressBook(TSBWebDAVSetAsAddressBookEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBWebDAVSetAsAddressBookEvent)(void * _ObjectData, TObjectHandle Sender, const char * pcURL, int32_t szURL, SBWebDAVServer_TElWebDAVPrincipalHandle Principal, int8_t &Success);

[PHP]
    TSBWebDAVSetAsAddressBookEvent|callable|NULL get_OnSetAsAddressBook()
    void set_OnSetAsAddressBook(TSBWebDAVSetAsAddressBookEvent|callable|NULL $Value)
    callable TSBWebDAVSetAsAddressBookEvent(TObject $Sender, string $URL, SBWebDAVServer_TElWebDAVPrincipal $Principal, bool &$Success)

[Java]
    TSBWebDAVSetAsAddressBookEvent getOnSetAsAddressBook();
    void setOnSetAsAddressBook(TSBWebDAVSetAsAddressBookEvent Value);
    TSBWebDAVSetAsAddressBookEvent.Callback OnSetAsAddressBook = new TSBWebDAVSetAsAddressBookEvent.Callback() {
        public void TSBWebDAVSetAsAddressBookEventCallback(TObject Sender, String URL, TElWebDAVPrincipal Principal, TSBBoolean Success) {
            //...
        }
    }

Parameters

Principal - the client who owns the collection.
Success - handler should set this parameter to true on succes, and to false on failure.
URL - the URL of the collection to be marked as address book.
pcURL - the URL of the collection to be marked as address book.
szURL - the length of pcURL in bytes.

Description

Event handler should mark the requested collection as address book and return true via the Success parameter. If, for some reason, the collection could not be marked as address book, the handler should return false.