MoveFile Method

Renames or moves a vault item.


int MoveFile(const QString& qsOldFileName, const QString& qsNewFileName, bool bOverwrite);


This method renames or moves a vault item (file, directory, symbolic link, or alternate stream) from the specified OldFileName to the specified NewFileName. For alternate streams, renaming is always possible, but moving them from one file to another is only allowed if the AllowMoveStreamsBetweenFiles configuration setting is enabled.

The values passed for OldFileName and NewFileName must both be vault-local absolute paths (including the item's old and new names, respectively) in the same vault.

The Overwrite parameter specifies what to do if a vault item with the specified NewFileName already exists. If Overwrite is true, and such an item exists, it will be overwritten by the item specified by OldFileName. But if such an item exists, and Overwrite is false, this method fails with an error.

Please note that the usual rules of deletion still apply for an item being overwritten. Notably, a non-empty directory cannot be overwritten.

Note: This method can only be called when Active is true, and cannot be called within events.

Error Handling

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 Callback Technologies, Inc. - All rights reserved.
CBFS Vault 2020 Qt Edition - Version 20.0 [Build 8145]