Função DeleteProfileA (userenv.h)

  • Artigo

Exclui o perfil do usuário e todas as configurações relacionadas ao usuário do computador especificado. O chamador deve ter privilégios administrativos para excluir o perfil de um usuário.

Sintaxe

USERENVAPI BOOL DeleteProfileA(
  [in]           LPCSTR lpSidString,
  [in, optional] LPCSTR lpProfilePath,
  [in, optional] LPCSTR lpComputerName
);

Parâmetros

[in] lpSidString

Tipo: LPCTSTR

Ponteiro para uma cadeia de caracteres que especifica o SID do usuário.

[in, optional] lpProfilePath

Tipo: LPCTSTR

Ponteiro para uma cadeia de caracteres que especifica o caminho do perfil. Se esse parâmetro for NULL, a função obterá o caminho do registro.

[in, optional] lpComputerName

Tipo: LPCTSTR

Ponteiro para uma cadeia de caracteres que especifica o nome do computador do qual o perfil deve ser excluído. Se esse parâmetro for NULL, o nome do computador local será usado.

Nota A partir do Windows Vista, esse parâmetro deve ser NULL. Se não estiver, essa função falhará com o código de erro ERROR_INVALID_PARAMETER.
 

Valor retornado

Tipo: BOOL

TRUE se tiver êxito; caso contrário, FALSE. Para obter informações de erro estendidas, chame GetLastError.

Comentários

DeleteProfile pode falhar quando passado o SID (identificador de segurança) da conta do sistema local (S-1-5-18).

Observação

O cabeçalho userenv.h define DeleteProfile como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

   
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho userenv.h
Biblioteca Userenv.lib
DLL Userenv.dll

Confira também

Visão geral de perfis de usuário

Referência de perfis de usuário