ListResources Method
Lists resources in a given folder.
Syntax
azurefile.listResources(folderPath, [callback])
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for this method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
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));