Função GetUserProfileDirectoryA (userenv.h)
Recupera o caminho para o diretório raiz do perfil do usuário especificado.
Sintaxe
USERENVAPI BOOL GetUserProfileDirectoryA(
[in] HANDLE hToken,
[out, optional] LPSTR lpProfileDir,
[in, out] LPDWORD lpcchSize
);
Parâmetros
[in] hToken
Tipo: HANDLE
Um token para o usuário, que é retornado pelo LogonUser, CreateRestrictedToken, DuplicateToken, OpenProcessToken ou função OpenThreadToken. O token deve ter acesso TOKEN_QUERY. Para obter mais informações, consulte Access Rights for Access-Token Objects.
[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 especificado.
[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 encerramento.
Valor de retorno
Tipo: BOOL
verdadeiro se bem-sucedido; caso contrário, FALSE . Para obter informações de erro estendidas, chame GetLastError.
Observações
Veja a seguir um exemplo do caminho retornado por GetUserProfileDirectory no Windows XP:
C:\Documents and Settings\Joe
Veja a seguir um exemplo do caminho retornado por GetUserProfileDirectory no Windows 7:
C:\Users\Joe
Para obter os caminhos dos subdiretórios desse diretório, use a
Nota
O cabeçalho userenv.h define GetUserProfileDirectory 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
GetDefaultUserProfileDirectory