Función GetDefaultUserProfileDirectoryA (userenv.h)

Artículo
03/03/2024

Recupera la ruta de acceso a la raíz del perfil del usuario predeterminado.

Sintaxis

USERENVAPI BOOL GetDefaultUserProfileDirectoryA(
  [out, optional] LPSTR   lpProfileDir,
  [in, out]       LPDWORD lpcchSize
);

Parámetros

[out, optional] lpProfileDir

Tipo: LPTSTR

Puntero a un búfer que, cuando esta función vuelve correctamente, recibe la ruta de acceso al directorio de perfil del usuario predeterminado. Establezca este valor en NULL para determinar el tamaño necesario del búfer.

[in, out] lpcchSize

Tipo: LPDWORD

Especifica el tamaño del búfer lpProfileDir , en TCHAR.

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

TRUE si se ejecuta correctamente; de lo contrario, FALSE. Para obtener información de error extendida, llame a GetLastError.

Comentarios

A continuación se muestra un ejemplo de la ruta de acceso devuelta por GetDefaultUserProfileDirectory en Windows XP:

C:\Documents and Settings\Default User

A continuación se muestra un ejemplo de la ruta de acceso devuelta por GetDefaultUserProfileDirectory en Windows 7:

C:\Users\Default

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 GetDefaultUserProfileDirectory 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 Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	userenv.h
Library	Userenv.lib
Archivo DLL	Userenv.dll