ListItems Method

Lists the files and folders within a folder.

Syntax

• C++
• Objective-C
• C

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

Unicode (Windows)
INT ListItems(LPCWSTR lpszFolderId);

- (void)listItems:(NSString*)folderId;

#define MID_SHAREFILE_LISTITEMS 23

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

Remarks

The method takes a string FolderId which represents the ID of the folder that the class will list from. Calling this method will fire the ItemList event once for each item, and will also populate the Item* properties (clearing any previously-held items in the process).

Note that the string root may be used as a FolderId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

string folderId = shareFile.Items[0].Id;
shareFile.ListItems(folderId)

// or

shareFile.ListItems("home");

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