IPWorks Cloud 2020 C++ Edition

Questions / Feedback?

ListResources Method

Lists resources.

Syntax

ANSI (Cross Platform)
int ListResources(const char* lpszFolderId);

Unicode (Windows)
INT ListResources(LPCWSTR lpszFolderId);
- (void)listResources:(NSString*)folderId;
#define MID_BOX_LISTRESOURCES 17

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

Remarks

This method lists resources within the folder specified by FolderId.

FolderId can be empty string to list resources in the root folder, or trash to list trashed resources.

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.

The MaxResults configuration setting can be used to control the maximum number of results to return at once.

// ResourceList event handler.
box.OnResourceList += (s, e) => {
  Console.WriteLine(e.Name);
};

do {
  box.ListResources("d:123456");

  for (int i = 0; i < box.Resources.Count; i++) {
    // Process resources here.
  }
} while (!string.IsNullOrEmpty(box.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.)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 C++ Edition - Version 20.0 [Build 8265]