Windows Dev Center

ITransferSource::RenameItem method

Changes the name of an item, returning the IShellItem with the new name.

Syntax


HRESULT RenameItem(
  [in]  IShellItem            *psiSource,
  [in]  LPCWSTR               pszNewName,
  [in]  TRANSFER_SOURCE_FLAGS dwFlags,
  [out] IShellItem            **ppsiNewDest
);

Parameters

psiSource [in]

Type: IShellItem*

A pointer to the IShellItem object to be renamed.

pszNewName [in]

Type: LPCWSTR

A pointer to a null-terminated, Unicode string containing the new name.

dwFlags [in]

Type: TRANSFER_SOURCE_FLAGS

Flags that control the file operation. One or more of the TRANSFER_SOURCE_FLAGS constants.

ppsiNewDest [out]

Type: IShellItem**

When this method returns, contains the address of a pointer to the IShellItem object.

Return value

Type: HRESULT

Returns one of the following, or an error code.

Return codeDescription
COPYENGINE_S_YES

User responded "Yes" to the dialog.

COPYENGINE_S_USER_RETRY

User responded to retry the current action.

COPYENGINE_S_USER_IGNORED

User responded "No" to the dialog.

COPYENGINE_S_MERGE

User responded to merge folders.

COPYENGINE_S_USER_RETRY_WITH_NEW_NAME

User responded to retry the file with new name.

COPYENGINE_S_DONT_PROCESS_CHILDREN

Child items should not be processed.

COPYENGINE_S_PENDING

Error has been queued and will display later.

COPYENGINE_E_USER_CANCELLED

User canceled the current action.

COPYENGINE_E_REQUIRES_ELEVATION

Operation requires elevated privileges.

 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Shobjidl.h

IDL

Shobjidl.idl

 

 

Community Additions

ADD
Show:
© 2015 Microsoft