RenameFile Method
Renames the file.
Syntax
ANSI (Cross Platform) int RenameFile(const char* lpszNewName); Unicode (Windows) INT RenameFile(LPCWSTR lpszNewName);
- (void)renameFile:(NSString*)newName;
#define MID_CLOUDSTORAGE_RENAMEFILE 9 IPWORKSCLOUD_EXTERNAL int IPWORKSCLOUD_CALL IPWorksCloud_CloudStorage_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
Remarks
This method renames an existing file on the server. The NewName parameter specifies the new name of the file.
cloudstorage.RemotePath = "/MyFolder"; cloudstorage.RemoteFile = "file.txt"; cloudstorage.RenameFile("newfile.txt");
Note: RenameFile is not supported when ServiceProvider is set to one of the following:
- spAmazonS3 (0)
- spAzureBlob (6)
- spDigitalOcean (8)
- spGoogleStorage (9)
- spAzureFile (11)
- spBackblazeB2 (12)
- spIBMStorage (13)
- spLinode (14)
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.)