Compartilhar via


Função DeleteProfileW (userenv.h)

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 DeleteProfileW(
  [in]           LPCWSTR lpSidString,
  [in, optional] LPCWSTR lpProfilePath,
  [in, optional] LPCWSTR lpComputerName
);

Parâmetros

[in] lpSidString

Tipo: LPCTSTR

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

[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.

Observação 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 de retorno

Tipo: BOOL

verdadeiro se bem-sucedido; caso contrário, FALSE . Para obter informações de erro estendidas, chame GetLastError.

Observações

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

Nota

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 do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito Valor
de cliente com suporte mínimo Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino Windows
cabeçalho userenv.h
biblioteca Userenv.lib
de DLL Userenv.dll

Consulte também

Visão geral dos perfis de usuário

Referência de perfis de usuário