IPWorks Cloud 2020 Kotlin Edition

Questions / Feedback?

ListResources Method

Lists resources in a given folder.

Syntax

public fun listResources(folderPath: String?)

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 Resources collection.

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 Resources collection.

Note that the server only returns the following resource fields when listing resources (use GetFileInfo or GetFolderInfo to retrieve all fields for a specific resource):

  • Name
  • Path (populated by the component automatically)
  • Share (populated by the component automatically)
  • Size
  • Type

// 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));

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Kotlin Edition - Version 20.0 [Build 7941]