Función ExpandEnvironmentStringsForUserA (userenv.h)

Expande la cadena de origen mediante el bloque de entorno establecido para el usuario especificado.

Sintaxis

USERENVAPI BOOL ExpandEnvironmentStringsForUserA(
  [in, optional] HANDLE hToken,
  [in]           LPCSTR lpSrc,
  [out]          LPSTR  lpDest,
  [in]           DWORD  dwSize
);

Parámetros

[in, optional] hToken

Tipo: HANDLE

Token para el usuario, devuelto por la función LogonUser, CreateRestrictedToken, DuplicateToken, OpenProcessToken o OpenThreadToken . El token debe tener acceso TOKEN_IMPERSONATE y TOKEN_QUERY. Además, a partir de Windows 7, el token también debe tener acceso TOKEN_DUPLICATE. Para obtener más información, vea Derechos de acceso para objetos Access-Token.

Si hToken es NULL, el bloque de entorno solo contiene variables del sistema.

[in] lpSrc

Tipo: LPCTSTR

Puntero a la cadena de origen terminada en null que se va a expandir.

[out] lpDest

Tipo: LPTSTR

Puntero a un búfer que recibe las cadenas expandidas.

[in] dwSize

Tipo: DWORD

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

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 una cadena de origen de ejemplo:

%USERPROFILE%\ntuser.dat

Cuando ExpandEnvironmentStringsForUser devuelve, la cadena de destino se expande de la siguiente manera:

C:\Documents and Settings\UserName\ntuser.dat

Nota

El encabezado userenv.h define ExpandEnvironmentStringsForUser 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

Consulte también

Introducción a los perfiles de usuario

Referencia de perfiles de usuario