MsiEnumRelatedProductsW-Funktion (msi.h)

Artikel
08/24/2023

Die MsiEnumRelatedProducts-Funktion listet Produkte mit einem angegebenen Upgradecode auf. Diese Funktion listet die aktuell installierten und angekündigten Produkte auf, die in der Property-Tabelle über die angegebene UpgradeCode-Eigenschaft verfügen.

Syntax

UINT MsiEnumRelatedProductsW(
  [in]  LPCWSTR lpUpgradeCode,
  [in]  DWORD   dwReserved,
  [in]  DWORD   iProductIndex,
  [out] LPWSTR  lpProductBuf
);

Parameter

[in] lpUpgradeCode

Die NULL-beendete Zeichenfolge, die den Upgradecode verwandter Produkte angibt, die das Installationsprogramm aufzählen soll.

[in] dwReserved

Dieser Parameter ist reserviert und muss 0 sein.

[in] iProductIndex

Der nullbasierte Index in die registrierten Produkte.

[out] lpProductBuf

Ein Puffer zum Empfangen der Produktcode-GUID. Dieser Puffer muss 39 Zeichen lang sein. Die ersten 38 Zeichen sind für die GUID, und das letzte Zeichen ist für das beendende NULL-Zeichen.

Rückgabewert

Wert	Bedeutung
ERROR_BAD_CONFIGURATION	Die Konfigurationsdaten sind beschädigt.
ERROR_INVALID_PARAMETER	Es wurde ein ungültiger Parameter an die Funktion übergeben.
ERROR_NO_MORE_ITEMS	Es gibt keine Produkte zurückzugeben.
ERROR_NOT_ENOUGH_MEMORY	Das System verfügt nicht über genügend Arbeitsspeicher, um den Vorgang abzuschließen. Verfügbar ab Windows Server 2003.
ERROR_SUCCESS	Ein Wert wurde aufgelistet.

Hinweise

Siehe UpgradeCode-Eigenschaft .

Um derzeit installierte und angekündigte Produkte aufzulisten, die über einen bestimmten Upgradecode verfügen, sollte eine Anwendung zunächst die MsiEnumRelatedProducts-Funktion aufrufen, wobei der Parameter iProductIndex auf Null festgelegt ist. Die Anwendung sollte dann den iProductIndex-Parameter erhöhen und MsiEnumRelatedProducts aufrufen, bis die Funktion ERROR_NO_MORE_ITEMS zurückgibt. Dies bedeutet, dass es keine weiteren Produkte mit dem angegebenen Upgradecode gibt.

Wenn Sie mehrere Aufrufe von MsiEnumRelatedProducts ausführen, um alle zugehörigen Produkte aufzulisten, sollte jeder Aufruf aus demselben Thread erfolgen.

Hinweis

Der msi.h-Header definiert MsiEnumRelatedProducts als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Installer 5.0 unter Windows Server 2012, Windows 8, Windows Server 2008 R2 oder Windows 7. Windows Installer 4.0 oder Windows Installer 4.5 unter Windows Server 2008 oder Windows Vista. Windows Installer unter Windows Server 2003 oder Windows XP. Informationen zum mindestens erforderlichen Windows Service Pack für eine Windows Installer-Version finden Sie unter Windows Installer – Laufzeitanforderungen.
Zielplattform	Windows
Kopfzeile	msi.h
Bibliothek	Msi.lib
DLL	Msi.dll

Share via