Función GetUserProfileDirectoryA (userenv.h)
Recupera la ruta de acceso al directorio raíz del perfil del usuario especificado.
Sintaxis
USERENVAPI BOOL GetUserProfileDirectoryA(
[in] HANDLE hToken,
[out, optional] LPSTR lpProfileDir,
[in, out] LPDWORD lpcchSize
);
Parámetros
[in] hToken
Tipo: HANDLE de
Token para el usuario, que devuelve el LogonUser, CreateRestrictedToken, DuplicateToken, OpenProcessTokeno función OpenThreadToken. El token debe tener acceso TOKEN_QUERY. Para obtener más información, vea Derechos de acceso para Access-Token Objetos.
[out, optional] lpProfileDir
Tipo: LPTSTR de
Puntero a un búfer que, cuando esta función vuelve correctamente, recibe la ruta de acceso al directorio de perfil del usuario especificado.
[in, out] lpcchSize
Tipo: LPDWORD de
Especifica el tamaño del búfer de lpProfileDir de
Si el búfer especificado por lpProfileDir no es lo suficientemente grande o lpProfileDir es NULL, se produce un error en la función y este parámetro recibe el tamaño de búfer necesario, incluido el carácter nulo de terminación.
Valor devuelto
Tipo: BOOL de
true si se ejecuta correctamente; De lo contrario, FALSE. Para obtener información de error extendida, llame a GetLastError.
Observaciones
A continuación se muestra un ejemplo de la ruta de acceso devuelta por GetUserProfileDirectory en Windows XP:
C:\Documents and Settings\Joe
A continuación se muestra un ejemplo de la ruta de acceso devuelta por GetUserProfileDirectory en Windows 7:
C:\Users\Joe
Para obtener las rutas de acceso de los subdirectorios de este directorio, use la función SHGetFolderPath (Windows XP y versiones anteriores) o SHGetKnownFolderPath (Windows Vista).
Nota
El encabezado userenv.h define GetUserProfileDirectory como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.
Requisitos
| Requisito | Valor |
|---|---|
| cliente mínimo admitido | Windows 2000 Professional [solo aplicaciones de escritorio] |
| servidor mínimo admitido | Windows 2000 Server [solo aplicaciones de escritorio] |
| de la plataforma de destino de |
Windows |
| encabezado de |
userenv.h |
| biblioteca de |
Userenv.lib |
| DLL de |
Userenv.dll |
Consulte también
GetDefaultUserProfileDirectory
Información general de perfiles de usuario de
de referencia de perfiles de usuario de