Método IStorage::RenameElement (objidl.h)

  • Artigo

O método RenameElement renomeia o subtorage ou fluxo especificado neste objeto de armazenamento.

Sintaxe

HRESULT RenameElement(
  [in] const OLECHAR *pwcsOldName,
  [in] const OLECHAR *pwcsNewName
);

Parâmetros

[in] pwcsOldName

Ponteiro para uma cadeia de caracteres Unicode terminada em nulo largo que contém o nome do substorage ou fluxo a ser alterado.

Nota O pwcsName, criado em CreateStorage ou CreateStream não deve exceder 31 caracteres de comprimento, sem incluir o terminador de cadeia de caracteres.
 

[in] pwcsNewName

Ponteiro para uma cadeia de caracteres unicode terminada em nulo largo que contém o novo nome para o substorage ou fluxo especificado.

Nota O pwcsName, criado em CreateStorage ou CreateStream não deve exceder 31 caracteres de comprimento, sem incluir o terminador de cadeia de caracteres.
 

Retornar valor

Esse método pode retornar um desses valores.

Código de retorno Descrição
S_OK O elemento foi renomeado com êxito.
E_PENDING Somente armazenamento assíncrono: parte ou todos os dados do elemento estão indisponíveis no momento.
STG_E_ACCESSDENIED O chamador não tem permissões suficientes para renomear o elemento.
STG_E_FILENOTFOUND O elemento com o nome antigo especificado não existe.
STG_E_FILEALREADYEXISTS O elemento especificado pelo novo nome já existe.
STG_E_INSUFFICIENTMEMORY O elemento não foi renomeado devido à falta de memória.
STG_E_INVALIDNAME Valor inválido para um dos nomes.
STG_E_INVALIDPOINTER O ponteiro especificado para o elemento não era válido.
STG_E_INVALIDPARAMETER Um dos parâmetros não era válido.
STG_E_REVERTED O objeto de armazenamento foi invalidado por uma operação de reverter acima dele na árvore de transações.
STG_E_TOOMANYOPENFILES O elemento não foi renomeado porque há muitos arquivos abertos.

Comentários

IStorage::RenameElement renomeia o substorage ou fluxo especificado neste objeto de armazenamento. Um elemento em um objeto de armazenamento não pode ser renomeado enquanto estiver aberto. A operação de renomeação está sujeita a confirmar as alterações se o armazenamento estiver aberto no modo transacionado.

Não há garantia de que o método IStorage::RenameElement funcione em memória baixa com objetos de armazenamento abertos no modo transacionado. Ele pode funcionar no modo direto.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows 2000 Server [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho objidl.h
Biblioteca Uuid.lib
DLL Ole32.dll

Confira também

IStorage – Implementação de arquivo composto