Função MsiGetComponentPathA (msi.h)

  • Artigo

A função MsiGetComponentPath retorna o caminho completo para um componente instalado. Se o caminho da chave do componente for uma chave do Registro, a chave do Registro será retornada.

Sintaxe

INSTALLSTATE MsiGetComponentPathA(
  [in]      LPCSTR  szProduct,
  [in]      LPCSTR  szComponent,
  [out]     LPSTR   lpPathBuf,
  [in, out] LPDWORD pcchBuf
);

Parâmetros

[in] szProduct

Especifica o código do produto para o produto cliente.

[in] szComponent

Especifica a ID do componente a ser localizado.

[out] lpPathBuf

Ponteiro para uma variável que recebe o caminho para o componente. Este parâmetro pode ser nulo. Se o componente for uma chave do Registro, as raízes do Registro serão representadas numericamente. Se esse for um caminho de subchave do Registro, haverá uma barra invertida no final do Caminho da Chave. Se esse for um caminho de chave de valor do Registro, não haverá barra invertida no final. Por exemplo, um caminho do Registro em um sistema operacional de 32 bits de HKEY_CURRENT_USER\SOFTWARE\Microsoft é retornado como "01:\SOFTWARE\Microsoft". As raízes do registro retornadas em sistemas operacionais de 32 bits são definidas conforme mostrado na tabela a seguir.

Nota Em sistemas operacionais de 64 bits, um valor de 20 é adicionado às raízes numéricas do registro nesta tabela para distingui-las dos caminhos de chave do Registro em sistemas operacionais de 32 bits. Por exemplo, um caminho de chave do Registro de HKEY_CURRENT_USER\SOFTWARE\Microsoft será retornado como "21:\SOFTWARE\Microsoft\", se o caminho do componente for uma chave do Registro em um sistema operacional de 64 bits.
 
Root Significado
HKEY_CLASSES_ROOT
 00
HKEY_CURRENT_USER
 01
HKEY_LOCAL_MACHINE
 02
HKEY_USERS
 03

[in, out] pcchBuf

Ponteiro para uma variável que especifica o tamanho, em caracteres, do buffer apontado pelo parâmetro lpPathBuf . Na entrada, esse é o tamanho total do buffer, incluindo um espaço para um caractere nulo de terminação. Se o buffer passado for muito pequeno, a contagem retornada não incluirá o caractere nulo de terminação.

Se lpPathBuf for nulo, pcchBuf poderá ser nulo.

Valor retornado

A função MsiGetComponentPath retorna os valores a seguir.

Valor Significado
INSTALLSTATE_NOTUSED
 O componente que está sendo solicitado está desabilitado no computador.
INSTALLSTATE_ABSENT
 O componente não está instalado.
INSTALLSTATE_INVALIDARG
 Um dos parâmetros de função é inválido.
INSTALLSTATE_LOCAL
 O componente é instalado localmente.
INSTALLSTATE_SOURCE
 O componente é instalado para ser executado a partir da origem.
INSTALLSTATE_SOURCEABSENT
 A origem do componente é inacessível.
INSTALLSTATE_UNKNOWN
 O código do produto ou A ID do componente é desconhecido.

Comentários

Após o sucesso da função MsiGetComponentPath , o parâmetro pcchBuf contém o comprimento da cadeia de caracteres em lpPathBuf.

A função MsiGetComponentPath pode retornar INSTALLSTATE_ABSENT ou INSTALL_STATE_UNKNOWN, pelos seguintes motivos:

  • INSTALLSTATE_ABSENT

    O aplicativo não garantiu corretamente que o recurso foi instalado chamando MsiUseFeature e, se necessário, MsiConfigureFeature.

  • INSTALLSTATE_UNKNOWN

    O recurso não foi publicado. O aplicativo deve ter determinado isso anteriormente chamando MsiQueryFeatureState ou MsiEnumFeatures. O aplicativo faz essas chamadas enquanto inicializa. Um aplicativo só deve usar recursos que são conhecidos por serem publicados. Como INSTALLSTATE_UNKNOWN deveria ter sido retornado por MsiUseFeature também, MsiUseFeature não foi chamado ou seu valor retornado não foi verificado corretamente.

Observação

O cabeçalho msi.h define MsiGetComponentPath 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

   
Cliente mínimo com suporte Windows Installer 5.0 no Windows Server 2012, no Windows 8, no Windows Server 2008 R2 ou no Windows 7. Windows Installer 4.0 ou Windows Installer 4.5 no Windows Server 2008 ou no Windows Vista. Windows Installer no Windows Server 2003 ou no Windows XP. Confira os Requisitos de tempo de execução do Windows Installer para obter informações sobre o service pack mínimo do Windows exigido por uma versão do Windows Installer.
Plataforma de Destino Windows
Cabeçalho msi.h
Biblioteca Msi.lib
DLL Msi.dll

Confira também

Funções específicas do componente