TElWebDAVACLOptions.OnGetPrivilegeDescription event

TElWebDAVACLOptions.OnGetPrivilegeDescription

This event is fired when a privilege description is requested.

Declaration

[C#]
event TSBWebDAVGetPrivilegeDescriptionEvent OnGetPrivilegeDescription;
delegate void TSBWebDAVGetPrivilegeDescriptionEvent(Object Sender, short Privilege, ref string Description, ref string Language);

[VB.NET]
Event OnGetPrivilegeDescription As TSBWebDAVGetPrivilegeDescriptionEvent
Delegate Sub TSBWebDAVGetPrivilegeDescriptionEvent(ByVal Sender As Object, ByVal Privilege As Short, ByRef Description As String, ByRef Language As String)

[Pascal]
property OnGetPrivilegeDescription : TSBWebDAVGetPrivilegeDescriptionEvent;
TSBWebDAVGetPrivilegeDescriptionEvent = procedure(Sender : TObject; Privilege : SmallInt; var Description, Language : string) of object;

[C++]
    void get_OnGetPrivilegeDescription(TSBWebDAVGetPrivilegeDescriptionEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnGetPrivilegeDescription(TSBWebDAVGetPrivilegeDescriptionEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBWebDAVGetPrivilegeDescriptionEvent)(void * _ObjectData, TObjectHandle Sender, int16_t Privilege, char * pcDescription, int32_t &szDescription, char * pcLanguage, int32_t &szLanguage);

[PHP]
    TSBWebDAVGetPrivilegeDescriptionEvent|callable|NULL get_OnGetPrivilegeDescription()
    void set_OnGetPrivilegeDescription(TSBWebDAVGetPrivilegeDescriptionEvent|callable|NULL $Value)
    callable TSBWebDAVGetPrivilegeDescriptionEvent(TObject $Sender, integer $Privilege, string &$Description, string &$Language)

[Java]
    TSBWebDAVGetPrivilegeDescriptionEvent getOnGetPrivilegeDescription();
    void setOnGetPrivilegeDescription(TSBWebDAVGetPrivilegeDescriptionEvent Value);
    TSBWebDAVGetPrivilegeDescriptionEvent.Callback OnGetPrivilegeDescription = new TSBWebDAVGetPrivilegeDescriptionEvent.Callback() {
        public void TSBWebDAVGetPrivilegeDescriptionEventCallback(TObject Sender, short Privilege, TSBString Description, TSBString Language) {
            //...
        }
    }

Parameters

Privilege - the privilege for which which the description is requested.
Description - human-readable description of the privilege should be provided via this parameter.
pcDescription - human-readable description of the privilege should be provided via this parameter.
szDescription - the length of pcDescription in bytes.
Language - specifies the language in which the Description is given.
pcLanguage - specifies the language in which the Description is given.
szLanguage - the length of pcLanguage in bytes.

Possible privileges

[.NET] [C++]	[Pascal]	Description
wdpWriteProps = 1	wdpWriteProps	'write-properties'
wdpWriteContent = 2	wdpWriteContent	'write-content'
wdpWriteACL = 4	wdpWriteACL	'write-acl'
wdpBind = 8	wdpBind	'bind'
wdpUnbind = 16	wdpUnbind	'unbind'
wdpReadACL = 32	wdpReadACL	'read-acl'
wdpReadCurrUserPrivilegeSet = 64	wdpReadCurrUserPrivilegeSet	'read-current-user-privilege-set'
wdpUnlock = 128	wdpUnlock	'unlock'
wdpCalReadFreeBusy = 256	wdpCalReadFreeBusy

Aggregated privileges

[.NET] [C++]	[Pascal]	Description
wdpRead	wdpRead	wdpReadACL \| wdpReadCurrUserPrivilegeSet \| wdpCalReadFreeBusy
wdpWrite	wdpWrite	wdpWriteProps \| wdpWriteContent \| wdpWriteACL \| wdpBind \| wdpUnbind
wdpAll	wdpAll	wdpRead \| wdpWrite \| wdpUnlock

Description

The event handler should provide the description and specify the language in which this description is given.