msiEnumClientsA 函式 (msi.h)

  • 發行項

MsiEnumClients 函式會列舉指定已安裝元件的用戶端。 函式會在每次呼叫時擷取一個產品代碼。

語法

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

參數

[in] szComponent

指定要列舉其用戶端的元件。

[in] iProductIndex

指定要擷取之用戶端的索引。 第一次呼叫 MsiEnumClients 函式時，此參數應該是零，然後針對後續呼叫遞增。 因為用戶端未排序，所以任何新的用戶端都有任意索引。 這表示函式可以依任何順序傳回用戶端。

[out] lpProductBuf

接收產品代碼之緩衝區的指標。 此緩衝區長度必須為 39 個字元。 前 38 個字元適用于 GUID，最後一個字元則用於終止 Null 字元。

傳回值

值 意義
ERROR_BAD_CONFIGURATION
 設定資料已損毀。
ERROR_INVALID_PARAMETER
 不正確參數已傳遞至 函式。
ERROR_NO_MORE_ITEMS
 沒有用戶端可傳回。
ERROR_NOT_ENOUGH_MEMORY
 系統沒有足夠的記憶體來完成作業。 適用于 Windows Server 2003。
ERROR_SUCCESS
 已列舉值。
ERROR_UNKNOWN_COMPONENT
 指定的元件未知。

備註

若要列舉用戶端，應用程式一開始應該呼叫 MsiEnumClients 函式，並將 iProductIndex 參數設定為零。 然後，應用程式應該遞增 iProductIndex 參數，並呼叫 MsiEnumClients ，直到函式傳回ERROR_NO_MORE_ITEMS) 為止，直到用戶端 (為止。

對 MsiEnumClients 進行多個呼叫以列舉所有元件的用戶端時，應該從相同的執行緒進行每個呼叫。

注意

msi.h 標頭會將 MsiEnumClients 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程式碼，可能會導致編譯或執行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

需求

   
最低支援的用戶端 Windows Server 2012、Windows 8、Windows Server 2008 R2 或 Windows 7 上的 Windows Installer 5.0。 Windows Server 2008 或 Windows Vista 上的 Windows Installer 4.0 或 Windows Installer 4.5。 Windows Server 2003 或 Windows XP 上的 Windows Installer。 如需 Windows Installer 版本所需的最低 Windows Service Pack 相關資訊，請參閱 Windows Installer Run-Time 需求。
目標平台 Windows
標頭 msi.h
程式庫 Msi.lib
Dll Msi.dll

另請參閱

系統狀態函式