IProfAdmin::RenameProfile

Aplica-se a: Outlook 2013 | Outlook 2016

Atribui um novo nome a um perfil.

HRESULT RenameProfile(
  LPSTR lpszOldProfileName,
  LPSTR lpszOldPassword,
  LPSTR lpszNewProfileName,
  ULONG_PTR ulUIParam,
  ULONG ulFlags
);

Parâmetros

lpszOldProfileName

[em] Um ponteiro para o nome atual do perfil a ser renomeado.

lpszOldPassword

[em] Sempre NULL.

lpszNewProfileName

[em] Um ponteiro para o novo nome do perfil a ser renomeado.

ulUIParam

[em] Um identificador para a janela pai de qualquer caixa de diálogo ou janela que esse método exiba.

ulFlags

[em] Uma máscara de bits de sinalizadores que controla como o perfil é renomeado. O seguinte sinalizador pode ser definido:

MAPI_APP_PROFILE

Permite renomear um perfil de "aplicativo". Esse sinalizador deverá ser definido se o perfil for um perfil de "aplicativo".

Esse sinalizador pode não ser reconhecido ou não ter suporte em todas as implementações MAPI.

Valor de retorno

S_OK

O perfil foi renomeado com sucesso.

MAPI_E_LOGON_FAILED

A senha do perfil está incorreta.

MAPI_E_NO_ACCESS

O perfil é um perfil de "aplicativo" e o sinalizador de MAPI_APP_PROFILE não foi definido.

MAPI_E_USER_CANCEL

O usuário cancelou a operação, geralmente clicando no botão Cancelar em uma caixa de diálogo.

Comentários

O método IProfAdmin::RenameProfile atribui um novo nome a um perfil, se tiver um. Se o perfil a ser renomeado estiver em uso por um cliente quando RenameProfile for chamado, RenameProfile marcará o perfil e retornará S_OK em vez de tentar a operação de renomeação enquanto o perfil estiver em uso. Quando o perfil não está mais sendo usado, RenameProfile atribui a ele o novo nome.

Os nomes antigos e novos do perfil podem ter até 64 caracteres e podem incluir os seguintes caracteres:

  • Todos os caracteres alfanuméricos, incluindo os caracteres de acento e o caractere de sublinhado.

  • Espaços incorporados, mas não espaços à direita ou à esquerda.

O lpszPassword sempre deve ser NULL ou um ponteiro para uma cadeia de comprimento zero.

Confira também

IProfAdmin : IUnknown