MoveItem Method

Moves an item to a different folder.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int MoveItem(const char* lpszItemId, const char* lpszParentId, const char* lpszNewName);

Unicode (Windows)
INT MoveItem(LPCWSTR lpszItemId, LPCWSTR lpszParentId, LPCWSTR lpszNewName);

- (void)moveItem:(NSString*)itemId :(NSString*)parentId :(NSString*)newName;

#define MID_SHAREFILE_MOVEITEM 28

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

Remarks

This method will move the item, specified by the ItemId string, and moves it to a new folder, specified by the ParentId. NewName specifies the new name of the item; if empty, the item's original name is used.

Note that the string root may be used as a ParentId 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

// Creates an item in a folder called Parent 1 and moves it to a folder called Parent 2 with the new name MovedTest.txt.
string ParentId1 = shareFile.CreateFolder("Parent 1", "home");
string ParentId2 = shareFile.CreateFolder("Parent 2", "home");
string ItemId = shareFile.UploadFile("Test.txt", ParentId1);

ShareFile.MoveItem(ItemId, ParentId2, "MovedTest.txt");

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