MsiEnumClientsA-Funktion (msi.h)
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 aufgezählt 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 erhöht 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
Zeigen Sie 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 endende Nullzeichen.
Rückgabewert
| Wert | Bedeutung |
|---|---|
|
Die Konfigurationsdaten sind beschädigt. |
|
An die Funktion wurde ein ungültiger Parameter übergeben. |
|
Es gibt keine Clients, die zurückgegeben werden sollen. |
|
Das System verfügt nicht über genügend Arbeitsspeicher, um den Vorgang abzuschließen. Verfügbar mit Windows Server 2003. |
|
Ein Wert wurde aufgezählt. |
|
Die angegebene Komponente ist unbekannt. |
Bemerkungen
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 weiteren Clients vorhanden sind (d. h., bis die Funktion ERROR_NO_MORE_ITEMS zurückgibt).
Bei mehreren Aufrufen von MsiEnumClients zum Aufzählen aller Clients der Komponente sollte jeder Aufruf aus demselben Thread erfolgen.
Anmerkung
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
| Anforderung | Wert |
|---|---|
| mindestens unterstützte 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 von einer Windows Installer-Version erforderlichen Windows-Service Pack finden Sie unter den Windows Installer-Run-Time Anforderungen. |
| Zielplattform- | Fenster |
| Header- | msi.h |
| Library | Msi.lib |
| DLL- | Msi.dll |