omniClientMove¶
Defined in OmniClient.h
-
OmniClientRequestId
omniClientMove
(char const *srcUrl, char const *dstUrl, void *userData, OmniClientMoveCallback callback, OmniClientCopyBehavior behavior, const char *message)¶ Move a thing from ‘srcUrl’ to ‘dstUrl’.
The thing can be anything that supports moving (files, folders, etc..)
If both src and dst are on the same server, this is done on the server. Otherwise, it is first copied from srcUrl to dstUrl, then deleted from srcUrl Note it is possible for the copy to succeed and the delete to fail. In this case the result will be the error code from the delete but ‘copied’ will be true.
If the result is ‘Ok’ but ‘copied’ is false, that means the move was done entirely on the server, so no local copy had to be made.
Destination folders will be created as needed. Returns
eOmniClientResult_ErrorAlreadyExists
if ‘dstUrl’ already exists unless you specify ‘behavior’ aseOmniClientCopy_Overwrite
Trailing slashes are ignored!
The message parameter is applied to the atomic checkpoint created of dstUrl after the move is complete.
Note
If this function is called after omniClientShutdown, kInvalidRequestId will be returned, and the callback will not be called.