Função SHRegGetPathA (shlwapi.h)

Artigo
11/20/2024

Recupera um caminho de arquivo do registro, expandindo variáveis de ambiente conforme necessário.

Sintaxe

LSTATUS SHRegGetPathA(
  [in]  HKEY   hKey,
  [in]  LPCSTR pcszSubKey,
  [in]  LPCSTR pcszValue,
  [out] LPSTR  pszPath,
        DWORD  dwFlags
);

Parâmetros

[in] hKey

Tipo: HKEY

Um identificador para uma chave que está aberta no momento ou uma chave raiz do Registro.

[in] pcszSubKey

Tipo: LPCTSTR

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome da subchave.

[in] pcszValue

Tipo: LPCTSTR

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome do valor que contém a cadeia de caracteres de caminho não inicializada.

[out] pszPath

Tipo: LPTSTR

Um buffer para manter o caminho expandido. Você deve definir o tamanho desse buffer como MAX_PATH para garantir que ele seja grande o suficiente para manter a cadeia de caracteres retornada.

dwFlags

Tipo: DWORD

Reservado.

Valor de retorno

Tipo: LSTATUS

Retorna ERROR_SUCCESS se tiver êxito ou um código de erro do Windows de outra forma.

Observações

O tipo de dados do valor do Registro especificado deve ser REG_EXPAND_SZ ou REG_SZ. Se ele tiver o tipo REG_EXPAND_SZ, todas as variáveis de ambiente na cadeia de caracteres do Registro serão expandidas com ExpandEnvironmentStrings. Se ele tiver o tipo de dados REG_SZ, as variáveis de ambiente não serão expandidas e a cadeia de caracteres apontada por pszPath será idêntica à cadeia de caracteres no registro.

As cadeias de caracteres de ambiente a seguir serão substituídas pelo caminho equivalente.

Cadeia de caracteres de ambiente	Pasta
%USERPROFILE%	A pasta de perfil do usuário atual
%ALLUSERSPROFILE%	A pasta de perfil Todos os Usuários
%ProgramFiles%	A pasta Arquivos de Programas
%SystemRoot%	A pasta raiz do sistema
%SystemDrive%	A letra da unidade do sistema

Observação %USERPROFILE% é relativa 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.

Nota

O cabeçalho shlwapi.h define SHRegGetPath 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. 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)

Compartilhar via