Função ExpandEnvironmentStringsForUserA (userenv.h)

Expande a cadeia de caracteres de origem usando o bloco de ambiente estabelecido para o usuário especificado.

Sintaxe

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 o usuário, retornado da função LogonUser, CreateRestrictedToken, DuplicateToken, OpenProcessToken ou OpenThreadToken . O token deve ter acesso TOKEN_IMPERSONATE e TOKEN_QUERY. Além disso, a partir do Windows 7, o token também deve ter acesso TOKEN_DUPLICATE. Para obter mais informações, consulte Direitos de Acesso para objetos Access-Token.

Se hToken for NULL, o bloco de ambiente conterá somente variáveis do sistema.

[in] lpSrc

Tipo: LPCTSTR

Ponteiro para a cadeia de caracteres de origem terminada em nulo a ser expandida.

[out] lpDest

Tipo: LPTSTR

Ponteiro para um buffer que recebe as cadeias de caracteres expandidas.

[in] dwSize

Tipo: DWORD

Especifica o tamanho do buffer lpDest , em TCHARs.

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 de cadeia de caracteres de origem:

%USERPROFILE%\ntuser.dat

Quando ExpandEnvironmentStringsForUser retorna, a cadeia de caracteres de destino se expande da seguinte maneira:

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

Observação

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

Visão geral de perfis de usuário

Referência de perfis de usuário