Click or drag to resize

IFolderSearchByQueryAsync Method

IT Hit WebDAV Classes Reference
Returns array of IHierarchyItem corresponding to searchQuery.

Namespace:  ITHit.WebDAV.Client
Assembly:  ITHit.WebDAV.Client (in ITHit.WebDAV.Client.dll) Version: 6.0.4052-Beta
Syntax
Task<IHierarchyItem[]> SearchByQueryAsync(
	SearchQuery searchQuery,
	PropertyName[] names = null,
	IDictionary<string, string> headers = null,
	CancellationToken cancellationToken = null
)

Parameters

searchQuery
Type: ITHit.WebDAV.ClientSearchQuery
Search query.
names (Optional)
Type: ITHit.WebDAV.ClientPropertyName
Search query.
headers (Optional)
Type: System.Collections.GenericIDictionaryString, String
Request headers.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
Propagates notification that operations should be canceled.

Return Value

Type: TaskIHierarchyItem
Items corresponding to requested search query.
Exceptions
ExceptionCondition
UnauthorizedExceptionIncorrect credentials provided or insufficient permissions to access the requested item.
NotFoundExceptionThe requested folder doesn't exist on the server.
ForbiddenExceptionThe server refused to fulfill the request.
WebDavExceptionUnexpected error occurred.
Examples
string license = "<?xml version='1.0' encoding='utf...
WebDavSession session = new WebDavSession(license);
session.Credentials = new NetworkCredential("User1", "pwd");

SearchQuery oSearchQuery = new SearchQuery("Note%");

//By default WebDAV Ajax Client search by DisplayName property.
//You can add other properties to this list.
oSearchQuery.LikeProperties.Add(new PropertyName("creator-displayname", "DAV:"));
oSearchQuery.LikeProperties.Add(new PropertyName("comment", "DAV:"));

// Disable search by file content
oSearchQuery.EnableContains = false;

IFolder folder = await session.GetFolderAsync(new Uri("https://server/Products/"));
IHierarchyItem[] items = await folder.SearchByQueryAsync(oSearchQuery);

foreach(IHierarchyItem item in items){
   Console.WriteLine(item.DisplayName.ToString());
}
See Also