Função MsiSourceListClearSourceA (msi.h)

Artigo
08/24/2023

A função MsiSourceListClearSource remove uma origem existente para um produto ou patch em um contexto especificado. O registro de patch também será removido se a única fonte do patch for removida e se o patch não estiver instalado por nenhum cliente no mesmo contexto. Especificar que MsiSourceListClearSource remova a origem atual deste produto ou patch força o instalador a pesquisar uma fonte na próxima vez que uma origem for necessária.

Sintaxe

UINT MsiSourceListClearSourceA(
  [in]           LPCSTR            szProductCodeOrPatchCode,
  [in, optional] LPCSTR            szUserSid,
  [in]           MSIINSTALLCONTEXT dwContext,
  [in]           DWORD             dwOptions,
  [in]           LPCSTR            szSource
);

Parâmetros

[in] szProductCodeOrPatchCode

O ProductCode ou o GUID de patch do produto ou patch. Use uma cadeia de caracteres terminada em nulo. Se a cadeia de caracteres tiver mais de 39 caracteres, a função falhará e retornará ERROR_INVALID_PARAMETER. Esse parâmetro não pode ser NULL.

[in, optional] szUserSid

Esse parâmetro pode ser um SID de cadeia de caracteres que especifica a conta de usuário que contém o produto ou patch. O SID não é validado ou resolvido. Um SID incorreto pode retornar ERROR_UNKNOWN_PRODUCT ou ERROR_UNKNOWN_PATCH. Ao referenciar um contexto de computador, szUserSID deve ser NULL e dwContext deve ser MSIINSTALLCONTEXT_MACHINE.

Tipo de SID	Significado
NULO	NULL indica o usuário conectado no momento. Ao referenciar a conta de usuário atual, szUserSID pode ser NULL e dwContext pode ser MSIINSTALLCONTEXT_USERMANAGED ou MSIINSTALLCONTEXT_USERUNMANAGED.
SID de usuário	Especifica a enumeração para um usuário específico no sistema. Um exemplo de SID de usuário é "S-1-3-64-2415071341-1358098788-3127455600-2561".

Nota A cadeia de caracteres sid especial "S-1-5-18" (sistema) não pode ser usada para enumerar produtos ou patches instalados como por computador. Definir o valor sid como "S-1-5-18" retorna ERROR_INVALID_PARAMETER.

Nota A cadeia de caracteres SID especial "S-1-1-0" (todos) não deve ser usada. A configuração do valor sid como "S-1-1-0" falha e retorna ERROR_INVALID_PARAM.

[in] dwContext

Esse parâmetro especifica o contexto da instância do produto ou patch. Esse parâmetro pode conter um dos valores a seguir.

Tipo de contexto	Significado
MSIINSTALLCONTEXT_USERMANAGED	A instância do produto ou patch existe no contexto por usuário gerenciado.
MSIINSTALLCONTEXT_USERUNMANAGED	A instância do produto ou patch existe no contexto por usuário não gerenciado.
MSIINSTALLCONTEXT_MACHINE	A instância do produto ou patch existe no contexto por computador.

[in] dwOptions

O valor dwOptions determina a interpretação do valor szProductCodeOrPatchCode e o tipo de fontes a serem limpas. Esse parâmetro deve ser uma combinação de uma das seguintes constantes MSISOURCETYPE_ e uma das seguintes constantes MSICODE_ .

Sinalizador	Significado
MSISOURCETYPE_NETWORK	A origem é um tipo de rede.
MSISOURCETYPE_URL	A origem é um tipo de URL.
MSICODE_PRODUCT	szProductCodeOrPatchCode é um código de produto.
MSICODE_PATCH	szProductCodeOrPatchCode é um código de patch.

[in] szSource

Origem a ser removida. Espera-se que esse parâmetro contenha apenas o caminho sem o nome do arquivo. O nome do arquivo já está registrado como "PackageName" e pode ser manipulado por meio de MsiSourceListSetInfo. Esse argumento é necessário.

Retornar valor

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

Valor	Significado
ERROR_ACCESS_DENIED	O usuário não tem a capacidade de remover uma origem. Não indica se o produto ou patch foi encontrado.
ERROR_BAD_CONFIGURATION	Os dados de configuração estão corrompidos.
ERROR_INSTALL_SERVICE_FAILURE	Não foi possível acessar o serviço Windows Installer
ERROR_INVALID_PARAMETER	Um parâmetro inválido foi passado para a função.
ERROR_SUCCESS	A origem foi removida ou não encontrada.
ERROR_UNKNOWN_PATCH	O patch especificado é desconhecido.
ERROR_UNKNOWN_PRODUCT	O produto especificado é desconhecido.
ERROR_FUNCTION_FAILED	Falha interna inesperada.

Comentários

Os administradores podem modificar a instalação de uma instância de patch ou produto que existe no contexto do computador ou em seu próprio contexto por usuário (gerenciado ou não gerenciado).) Eles podem modificar a instalação de uma instância de patch ou produto que existe no contexto por usuário gerenciado por usuário. Os administradores não podem modificar a instalação de outro usuário de uma instância de patch ou produto que existe no contexto não gerenciado por usuário desse outro usuário.

Os não administradores não podem modificar a instalação de uma instância de produto ou patch que existe no contexto por usuário de outro usuário (gerenciado ou não gerenciado).) Eles podem modificar a instalação de uma instância de produto ou patch que existe em seu próprio contexto por usuário não gerenciado. Eles podem modificar a instalação de uma instância de produto ou patch no contexto do computador ou no próprio contexto gerenciado por usuário somente se estiverem habilitados para procurar uma fonte de patch ou produto. Os usuários podem ser habilitados para procurar fontes definindo a política. Para obter mais informações, consulte as políticas DisableBrowse, AllowLockdownBrowse e AlwaysInstallElevated .

Observação

O cabeçalho msi.h define MsiSourceListClearSource 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 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. Confira os Requisitos de tempo de execução do Windows Installer para obter informações sobre o Windows service pack mínimo exigido por uma versão do Windows Installer.
Plataforma de Destino	Windows
Cabeçalho	msi.h
Biblioteca	Msi.lib
DLL	Msi.dll