TElWebDAVClient.PrincipalPropertySearchFirst method

Discuss this help topic in SecureBlackbox Forum

TElWebDAVClient.PrincipalPropertySearchFirst

TElWebDAVClient See also

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

Initiates a search for a principal.

Declaration

[C#]
bool PrincipalPropertySearchFirst(ref Object Ctx, string URL, TElWebDAVPropertyInfoList MatchProperties, TElStringList Matches, TElWebDAVPropertyInfoList Properties, bool ApplyToPrincipalCollectionSet);

[VB.NET]
Function PrincipalPropertySearchFirst(ByRef Ctx As Object, ByVal URL As String, ByVal MatchProperties As TElWebDAVPropertyInfoList, ByVal Matches As TElStringList, ByVal Properties As TElWebDAVPropertyInfoList, ByVal ApplyToPrincipalCollectionSet As Boolean) As Boolean

[Pascal]
function PrincipalPropertySearchFirst(var Ctx : Pointer; const URL : string; MatchProperties : TElWebDAVPropertyInfoList; Matches : TElStringList; Properties : TElWebDAVPropertyInfoList; ApplyToPrincipalCollectionSet : boolean) : boolean;

[C++]
bool PrincipalPropertySearchFirst(void * &Ctx, const std::string &URL, TElWebDAVPropertyInfoList &MatchProperties, TElStringList &Matches, TElWebDAVPropertyInfoList &Properties, bool ApplyToPrincipalCollectionSet);
bool PrincipalPropertySearchFirst(void * &Ctx, const std::string &URL, TElWebDAVPropertyInfoList *MatchProperties, TElStringList *Matches, TElWebDAVPropertyInfoList *Properties, bool ApplyToPrincipalCollectionSet);

[PHP]
bool PrincipalPropertySearchFirst(TSBPointer|array of byte|string $Ctx, string $URL, TElWebDAVPropertyInfoList $MatchProperties, TElStringList $Matches, TElWebDAVPropertyInfoList $Properties, bool $ApplyToPrincipalCollectionSet)

[Java]
not available

Parameters

Ctx - the search handle is returned via this parameter. This handle should be passed to PrincipalPropertySearchNext.
URL - the URL of the resource.
MatchProperties - a set of properties returned by PrincipalSearchPropertySet.
Matches - property values to match.
Properties - properties which need to be returned for the matching principals.
ApplyToPrincipalCollectionSet - if set to true, the request is applied to each collection identified by the DAV:principal-collection-set property of the resource identified by the Request-URI.

Description

Use this method to initiate a search (and retrieve the first search result) for a principal. After this method is called, call PrincipalPropertySearchNext until it returns true to get all matching users.

See also: PrincipalPropertySearchNext PrincipalSearchPropertySet

Discuss this help topic in SecureBlackbox Forum