ListResources Method
Lists resources in a given folder.
Syntax
ANSI (Cross Platform) int ListResources(const char* lpszFolderPath); Unicode (Windows) INT ListResources(LPCWSTR lpszFolderPath);
- (void)listResources:(NSString*)folderPath;
#define MID_AZUREFILE_LISTRESOURCES 21 IPWORKSCLOUD_EXTERNAL int IPWORKSCLOUD_CALL IPWorksCloud_AzureFile_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
Remarks
This method lists the resources in the folder at the specified FolderPath in the share currently selected by Share.
Before calling this method, the Prefix property may be set in order to restrict the results to only the items whose names begin with a given string. The MaxResults configuration setting may also be used to limit the number of results returned.
Calling this method will fire the ResourceList event once for each resource, and will also populate the Resource* properties.
If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resource* properties.
Note that the server only returns the following resource properties when listing resources (use GetFileInfo or GetFolderInfo to retrieve all properties for a specific resource):
- ResourceName
- ResourcePath (populated by the class automatically)
- ResourceShare (populated by the class automatically)
- ResourceSize
- ResourceType
// ResourceList event handler. azurefile.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; azurefile.Share = "myshare"; do { azurefile.ListResources("/work_files/serious_business/cats"); for (int i = 0; i < azurefile.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(azurefile.ResourceMarker));
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.)