MsiEnumClientsExA-Funktion (msi.h)

Die MsiEnumClientsEx-Funktion listet die installierten Anwendungen auf, die eine angegebene Komponente verwenden. Die Funktion ruft bei jedem Aufruf einen Produktcode für eine Anwendung ab.

Windows Installer 4.5 oder früher: Nicht unterstützt. Diese Funktion ist ab Windows Installer 5.0 verfügbar.

Syntax

UINT MsiEnumClientsExA(
  [in]                LPCSTR            szComponent,
  [in, optional]      LPCSTR            szUserSid,
  [in]                DWORD             dwContext,
  [in]                DWORD             dwProductIndex,
  [out, optional]     CHAR [39]         szProductBuf,
  [out, optional]     MSIINSTALLCONTEXT *pdwInstalledContext,
  [out, optional]     LPSTR             szSid,
  [in, out, optional] LPDWORD           pcchSid
);

Parameter

[in] szComponent

Die Komponentencode-GUID, die die Komponente identifiziert. Die Funktion listet die Anwendungen auf, die diese Komponente verwenden.

[in, optional] szUserSid

Ein NULL-beendeter Zeichenfolgenwert, der einen Sicherheitsbezeichner (SID) enthält. Die Aufzählung von Anwendungen erstreckt sich auf Benutzer, die von dieser SID identifiziert werden. Die spezielle SID-Zeichenfolge s-1-1-0 (Jeder) listet alle Anwendungen für alle Benutzer im System auf. Ein anderer SID-Wert als s-1-1-0 gibt eine Benutzer-SID für einen bestimmten Benutzer an und listet die Instanzen von Anwendungen auf, die vom angegebenen Benutzer installiert wurden.

[in] dwContext

Ein Flag, das die Enumeration auf Instanzen von Anwendungen erweitert, die im angegebenen Installationskontext installiert sind. Die Enumeration enthält nur Instanzen von Anwendungen, die von den benutzern installiert werden, die durch szUserSid identifiziert werden.

Dies kann eine Kombination der folgenden Werte sein.

[in] dwProductIndex

Gibt den Index der abzurufenden Anwendung an. Der Wert dieses Parameters muss beim ersten Aufruf der Funktion null (0) sein. Für jeden nachfolgenden Aufruf muss der Index um 1 erhöht werden. Der Index sollte nur erhöht werden, wenn der vorherige Aufruf der Funktion ERROR_SUCCESS zurückgibt.

[out, optional] szProductBuf

Ein Zeichenfolgenwert, der den Produktcode für die Anwendung empfängt. Die Länge des Puffers an diesem Speicherort sollte groß genug sein, um einen NULL-endendierten Zeichenfolgenwert mit dem Produktcode zu enthalten. Die ersten 38 TCHAR-Zeichen empfangen die GUID für die Komponente, und das 39. Zeichen erhält ein beendendes NULL-Zeichen.

[out, optional] pdwInstalledContext

Ein Flag, das den Installationskontext der Anwendung angibt.

Dies kann eine Kombination der folgenden Werte sein.

[out, optional] szSid

Empfängt die Sicherheits-ID (SID), die den Benutzer identifiziert, der die Anwendung installiert hat. Der Speicherort empfängt einen leeren Zeichenfolgenwert, wenn dieser instance der Anwendung in einem Installationskontext pro Computer vorhanden ist.

Die Länge des Puffers sollte groß genug sein, um einen null-beendeten Zeichenfolgenwert zu enthalten, der die SID enthält. Wenn der Puffer zu klein ist, gibt die Funktion ERROR_MORE_DATA zurück, und die Position, auf die von pcchSid verwiesen wird, empfängt die Anzahl von TCHAR in der SID, ohne das beendende NULL-Zeichen.

Wenn szSid auf NULL festgelegt ist und pcchSid ein gültiger Zeiger auf einen Speicherort im Arbeitsspeicher ist, gibt die Funktion ERROR_SUCCESS zurück, und der Speicherort empfängt die Anzahl von TCHAR in der SID, ohne das beendende NULL-Zeichen. Die Funktion kann dann erneut aufgerufen werden, um den Wert abzurufen, wobei die Größe des szSid-Puffers so groß ist, dass er *pcchSid + 1 Zeichen enthält.

[in, out, optional] pcchSid

Zeiger auf einen Speicherort im Arbeitsspeicher, der eine Variable enthält, die die Anzahl von TCHAR in der SID angibt, ohne das beendende NULL-Zeichen. Wenn die Funktion zurückgibt, wird diese Variable auf die Größe der angeforderten SID festgelegt, unabhängig davon, ob die Funktion die SID erfolgreich kopieren und das NULL-Zeichen in den Pufferspeicherort kopieren kann, auf den szSid verweist. Die Größe wird als Anzahl von TCHAR im angeforderten Wert zurückgegeben, ohne das beendende NULL-Zeichen.

Dieser Parameter kann nur auf NULL festgelegt werden, wenn szSid ebenfalls NULL ist, andernfalls gibt die Funktion ERROR_INVALID_PARAMETER zurück. Wenn szSid und pcchSid auf NULL festgelegt sind, gibt die Funktion ERROR_SUCCESS zurück, wenn die SID vorhanden ist, ohne den SID-Wert abzurufen.

Rückgabewert

Die MsiEnumClientsEx-Funktion gibt einen der folgenden Werte zurück.

Hinweise

Anforderungen