Função GetDefaultUserProfileDirectoryW (userenv.h)

Recupera o caminho para a raiz do perfil do usuário padrão.

Sintaxe

USERENVAPI BOOL GetDefaultUserProfileDirectoryW(
  [out, optional] LPWSTR  lpProfileDir,
  [in, out]       LPDWORD lpcchSize
);

Parâmetros

[out, optional] lpProfileDir

Tipo: LPTSTR

Um ponteiro para um buffer que, quando essa função retorna com êxito, recebe o caminho para o diretório de perfil do usuário padrão. Defina esse valor como NULL para determinar o tamanho necessário do buffer.

[in, out] lpcchSize

Tipo: LPDWORD

Especifica o tamanho do buffer lpProfileDir , em TCHARs.

Se o buffer especificado por lpProfileDir não for grande o suficiente ou lpProfileDir for NULL, a função falhará e esse parâmetro receberá o tamanho do buffer necessário, incluindo o caractere nulo de terminação.

Retornar valor

Tipo: BOOL

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

Comentários

Veja a seguir um exemplo do caminho retornado por GetDefaultUserProfileDirectory no Windows XP:

C:\Documents and Settings\Default User

Veja a seguir um exemplo do caminho retornado por GetDefaultUserProfileDirectory no Windows 7:

C:\Users\Default

Para obter os caminhos de subdiretórios desse diretório, use a função SHGetFolderPath (Windows XP e anterior) ou SHGetKnownFolderPath (Windows Vista).

Observação

O cabeçalho userenv.h define GetDefaultUserProfileDirectory 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

Requisito	Valor
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

GetAllUsersProfileDirectory

GetProfilesDirectory

GetUserProfileDirectory

Visão geral de perfis de usuário

Referência de perfis de usuário