Função PathUnExpandEnvStringsW (shlwapi.h)

Artigo
11/20/2024

Substitui determinados nomes de pasta em um caminho totalmente qualificado pela cadeia de caracteres de ambiente associada.

Sintaxe

BOOL PathUnExpandEnvStringsW(
  [in]  LPCWSTR pszPath,
  [out] LPWSTR  pszBuf,
  [in]  UINT    cchBuf
);

Parâmetros

[in] pszPath

Tipo: LPCTSTR

Um ponteiro para uma cadeia de caracteres terminada em nulo de comprimento máximo MAX_PATH que contém o caminho a ser não verificado.

[out] pszBuf

Tipo: LPTSTR

Um ponteiro para um buffer que, quando esse método retorna com êxito, recebe a cadeia de caracteres nãoexpanada. O tamanho desse buffer deve ser definido como MAX_PATH para garantir que ele seja grande o suficiente para manter a cadeia de caracteres retornada.

[in] cchBuf

Tipo: UINT

O tamanho, em caracteres, no buffer de pszBuf.

Valor de retorno

Tipo: BOOL

Retorna verdadeiro se bem-sucedido; caso contrário, FALSE .

Observações

Os caminhos de pasta a seguir são substituídos por sua cadeia de caracteres de ambiente equivalente.

Pasta	Cadeia de caracteres de ambiente
A pasta de perfil Todos os Usuários	%ALLUSERSPROFILE%
A pasta de dados do aplicativo do usuário atual (somente Windows Vista e posterior).	%APPDATA%
O nome do sistema	%COMPUTERNAME%
A pasta Arquivos de Programas	%ProgramFiles%
A pasta raiz do sistema	%SystemRoot%
A letra da unidade do sistema	%SystemDrive%
A pasta de perfil do usuário atual	%USERPROFILE%

Observação %APPDATA% e %USERPROFILE% são relativos ao usuário que está fazendo a chamada. Essa função não funcionará se o usuário estiver sendo representado de um serviço. Para obter mais discussões sobre problemas de controle de acesso, consulte controle de acesso.

As variáveis de ambiente listadas na tabela acima podem não estar definidas em todos os sistemas. Se uma variável de ambiente não estiver definida, ela não será exibida.

Nota

O cabeçalho shlwapi.h define PathUnExpandEnvStrings 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, Windows XP [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	shlwapi.h
biblioteca	Shlwapi.lib
de DLL	Shlwapi.dll (versão 5.0 ou posterior)

Consulte também

DoEnvironmentSubst

Compartilhar via