IStorage::MoveElementTo
A version of this page is also available for
4/8/2010
This method copies or moves a substorage or stream object from this storage object to another storage object.
Syntax
HRESULT MoveElementTo(
const WCHAR* pwcsName,
IStorage* pstgDest,
LPWSTR pwcsNewName,
DWORD grfFlags
);
Parameters
- pwcsName
[in] Pointer to a wide character string that contains the name of the element in this storage object to be moved or copied.
- pstgDest
[in] IStorage pointer to the destination storage object.
- pwcsNewName
[in] Pointer to a wide character string that contains the new name for the element in its new storage object.
- grfFlags
[in] Specifies whether the operation should be a move (STGMOVE_MOVE) or a copy (STGMOVE_COPY). See the STGMOVE enumeration.
Return Value
The following table shows the return values for this method.
| Value | Description |
|---|---|
S_OK |
The storage object was successfully copied or moved. |
E_PENDING |
Asynchronous Storage only: Part or all of the element's data is currently unavailable. For more information see the IFillLockBytes interface and Asynchronous Storage. |
STG_E_ACCESSDENIED |
The destination storage object is a child of the source storage object. |
STG_E_FILENOTFOUND |
The element with the specified name does not exist. |
STG_E_FILEALREADYEXISTS |
The specified file already exists. |
STG_E_INSUFFICIENTMEMORY |
The copy or move was not completed due to a lack of memory. |
STG_E_INVALIDFLAG |
The value for the grfFlags parameter is not valid. |
STG_E_INVALIDNAME |
Invalid value for pwcsName. |
STG_E_INVALIDPOINTER |
The pointer specified for the storage object was invalid. |
STG_E_INVALIDPARAMETER |
One of the parameters was invalid. |
STG_E_REVERTED |
The storage object has been invalidated by a revert operation above it in the transaction tree. |
STG_E_TOOMANYOPENFILES |
The copy or move was not completed because there are too many open files. |
Remarks
Invoking the IStorage::MoveElementTo method is typically the same as invoking the IStorage::CopyTo method on the indicated element and then removing the source element. In this case, the MoveElementTo method uses only the publicly available functions of the destination storage object to carry out the move.
If the source and destination storage objects have special knowledge about each other's implementation, they could, for example, be different instances of the sameimplementation, this method can be implemented more efficiently.
Before calling this method, the element to be moved must be closed, and the destination storage must be open.
To determine whether the platform supports this interface, see Determining Supported COM APIs.
Requirements
| Header | objidl.h, objidl.idl |
| Library | ole32.lib, uuid.lib |
| Windows Embedded CE | Windows CE 2.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |