Método IFileOperation::RenameItem (shobjidl_core.h)

Declara um único item que deve receber um novo nome de exibição.

Sintaxe

HRESULT RenameItem(
  [in] IShellItem                 *psiItem,
  [in] LPCWSTR                    pszNewName,
  [in] IFileOperationProgressSink *pfopsItem
);

Parâmetros

[in] psiItem

Tipo: IShellItem*

Ponteiro para um IShellItem que especifica o item de origem.

[in] pszNewName

Tipo: LPCWSTR

Ponteiro para o novo nome de exibição do item. Essa é uma cadeia de caracteres Unicode terminada em nulo.

[in] pfopsItem

Tipo: IFileOperationProgressSink*

Ponteiro para um objeto IFileOperationProgressSink a ser usado para status e notificações de falha. Se você chamar IFileOperation::Advise para a operação geral, as status de progresso e as notificações de erro para a operação de renomeação serão incluídas lá, portanto, defina esse parâmetro como NULL.

Valor retornado

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Esse método não renomeia o item, apenas declara o item a ser renomeado. Para renomear um objeto, você deve fazer pelo menos a sequência de chamadas detalhada aqui:

1. Chame IFileOperation::RenameItem para declarar o novo nome.
2. Chame IFileOperation::P erformOperations para iniciar a operação de renomeação.

Requisitos

Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	shobjidl_core.h (inclua Shobjidl.h)

Confira também

Ifileoperation

IFileOperation::RenameItems

PostRenameItem

PreRenameItem