IMDSPObject::Rename
.gif "banner art") |
The Rename method renames the associated object which can be a file or a folder.
Syntax
HRESULT Rename(LPWSTRpwszNewName,IWMDMProgress*pProgress);
Parameters
pwszNewName
[in] Pointer to a wide-character null-terminated string to receive a new name for the object. For information on how to use the LPWSTR variable type, see the Windows documentation.
pProgress
[in] Pointer to an application-implemented IWMDMProgress interface that enables the application to receive progress notification for lengthy renaming operations.
Return Values
The method returns an HRESULT. All the interface methods in Windows Media Device Manager can return any of the following classes of error codes:
- Standard COM error codes
- Windows error codes converted to HRESULT values
- Windows Media Device Manager error codes
For an extenstive list of possible error codes, see Error Codes.
Possible values include, but are not limited to, those in the following table.
| Return code | Description |
| S_OK | The method succeeded. |
| WMDM_E_BUSY | The media device is busy. |
| WMDM_E_INTERFACEDEAD | The file or folder was previously deleted. |
| WMDM_E_NOTSUPPORTED | Renaming is not supported by this storage device. |
| E_INVALIDARG | The pwszNewName parameter is an invalid or NULL pointer. |
| E_FAIL | An unspecified error occurred. |
Remarks
This method is optional. For more information, see Mandatory and Optional Interfaces.
Requirements
Header: Defined in mswmdm.h.
Library: mssachlp.lib
See Also