ListShares Method

Lists shares in the file storage account.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int ListShares();

Unicode (Windows)
INT ListShares();

- (void)listShares;

#define MID_AZUREFILE_LISTSHARES 22

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 shares in the file storage account specified by the Account property.

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 ShareList event once for each share, and will also populate the Share* properties.

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

Note that the server does not return the shares' ShareSpaceUsed property when listing shares; use GetShareInfo to retrieve all properties for a specific share.

// ShareList event handler.
azurefile.OnShareList += (s, e) => {
  Console.WriteLine(e.Name);
};

do {
  azurefile.ListShares();

  for (int i = 0; i < azurefile.Shares.Count; i++) {
    // Process shares here.
  }
} while (!string.IsNullOrEmpty(azurefile.ShareMarker));

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.)