MsiEnumClientsA-Funktion (msi.h)

  • Artikel

Die MsiEnumClients-Funktion listet die Clients für eine bestimmte installierte Komponente auf. Die Funktion ruft bei jedem Aufruf einen Produktcode ab.

Syntax

UINT MsiEnumClientsA(
  [in]  LPCSTR szComponent,
  [in]  DWORD  iProductIndex,
  [out] LPSTR  lpProductBuf
);

Parameter

[in] szComponent

Gibt die Komponente an, deren Clients aufgelistet werden sollen.

[in] iProductIndex

Gibt den Index des abzurufenden Clients an. Dieser Parameter sollte für den ersten Aufruf der MsiEnumClients-Funktion null sein und dann für nachfolgende Aufrufe inkrementiert werden. Da Clients nicht sortiert sind, verfügt jeder neue Client über einen beliebigen Index. Dies bedeutet, dass die Funktion Clients in beliebiger Reihenfolge zurückgeben kann.

[out] lpProductBuf

Zeiger auf einen Puffer, der den Produktcode empfängt. Dieser Puffer muss 39 Zeichen lang sein. Die ersten 38 Zeichen gelten für die GUID, und das letzte Zeichen ist für das abschließende 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 Clients, die zurückgegeben werden können.
ERROR_NOT_ENOUGH_MEMORY
 Das System verfügt nicht über genügend Arbeitsspeicher, um den Vorgang abzuschließen. Verfügbar mit Windows Server 2003.
ERROR_SUCCESS
 Ein Wert wurde aufgezählt.
ERROR_UNKNOWN_COMPONENT
 Die angegebene Komponente ist unbekannt.

Hinweise

Zum Aufzählen von Clients sollte eine Anwendung zunächst die MsiEnumClients-Funktion aufrufen, wobei der iProductIndex-Parameter auf Null festgelegt ist. Die Anwendung sollte dann den iProductIndex-Parameter inkrementieren und MsiEnumClients aufrufen, bis keine clients mehr vorhanden sind (d. h. bis die Funktion ERROR_NO_MORE_ITEMS zurückgibt).

Wenn Sie mehrere Aufrufe an MsiEnumClients ausführen, um alle Clients der Komponente aufzulisten, sollte jeder Aufruf aus demselben Thread erfolgen.

Hinweis

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

Anforderungen

   
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

Weitere Informationen

Systemstatusfunktionen