Search Method

Searches for resources.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int Search(const char* lpszFolderResource, const char* lpszQuery);

Unicode (Windows)
INT Search(LPCWSTR lpszFolderResource, LPCWSTR lpszQuery);

- (void)search:(NSString*)folderResource :(NSString*)query;

#define MID_DROPBOX_SEARCH 21

IPWORKSCLOUD_EXTERNAL int IPWORKSCLOUD_CALL IPWorksCloud_Dropbox_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method searches for resources matching Query within the specified FolderResource.

FolderResource must be a folder path, an Id-based, relative folder path, a folder resource Id, or empty string (in which case the current user's entire Dropbox is searched). The SearchCategories, SearchFileExtensions, SearchKind, and SearchNamesOnly properties may be used to further control the search options the server uses.

Calling this method will fire the ResourceList event once for each search result, and will also populate the Resource* properties.

If there are still more search results available to list when this method returns, the SearchMarker property will be populated. Continue to call this method until SearchMarker is empty to accumulate all pages of results in the Resource* properties.

The MaxSearchResults configuration setting can be used to control how many results are returned each time this method is called.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)