Função SHRegSetPathA (shlwapi.h)

  • Artigo

Usa um caminho de arquivo, substitui nomes de pasta por cadeias de caracteres de ambiente e coloca a cadeia de caracteres resultante no Registro.

Sintaxe

LSTATUS SHRegSetPathA(
  [in] HKEY   hKey,
  [in] LPCSTR pcszSubKey,
  [in] LPCSTR pcszValue,
  [in] LPCSTR pcszPath,
       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 de uma subchave existente. Se a subchave não existir, SHRegSetPath falhará.

[in] pcszValue

Tipo: LPCTSTR

Um ponteiro para uma cadeia de caracteres terminada em nulo com o nome do valor para manter a cadeia de caracteres de caminho.

[in] pcszPath

Tipo: LPCTSTR

Um ponteiro para uma cadeia de caracteres terminada em nulo com um caminho de arquivo totalmente qualificado.

dwFlags

Tipo: DWORD

Reservado.

Retornar valor

Tipo: LSTATUS

Retorna ERROR_SUCCESS se tiver êxito ou um código de erro do Windows caso contrário.

Comentários

Para o Windows 2000, SHRegSetPath usa PathUnExpandEnvStrings para converter nomes de pasta em sua cadeia de caracteres de ambiente correspondente. Se alguma variável de ambiente tiver sido substituída, o valor do Registro será definido com o tipo de dados REG_EXPAND_SZ . Caso contrário, ele será definido com o tipo de dados REG_SZ .

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

Pasta Cadeia de caracteres de ambiente
A pasta de perfil do usuário atual %USERPROFILE%
A pasta de perfil Todos os Usuários %ALLUSERSPROFILE%
A pasta Arquivos de Programas %ProgramFiles%
A pasta raiz do sistema %SystemRoot%
A letra da unidade do sistema %SystemDrive%
 
Observação %USERPROFILE% é relativo 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.
 
As variáveis de ambiente listadas na tabela acima podem não ser definidas em nenhum sistema específico. Se uma variável de ambiente não estiver definida, ela não será desexpandada. Em particular, nenhuma dessas variáveis é definida para o ambiente padrão do Windows 95 ou Windows 98. A variável %ProgramFiles% é nova para o Windows 2000 e normalmente não será definida nos sistemas microsoft Windows NT 4.0.

Observação

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