Fungsi MsiEnumClientsA (msi.h)

  • Artikel

Fungsi MsiEnumClients menghitung klien untuk komponen yang diinstal tertentu. Fungsi ini mengambil satu kode produk setiap kali dipanggil.

Sintaks

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

Parameter

[in] szComponent

Menentukan komponen yang kliennya akan dijumlahkan.

[in] iProductIndex

Menentukan indeks klien yang akan diambil. Parameter ini harus nol untuk panggilan pertama ke fungsi MsiEnumClients lalu dinaikkan untuk panggilan berikutnya. Karena klien tidak diurutkan, klien baru mana pun memiliki indeks arbitrer. Ini berarti bahwa fungsi dapat mengembalikan klien dalam urutan apa pun.

[out] lpProductBuf

Penunjuk ke buffer yang menerima kode produk. Panjang buffer ini harus 39 karakter. 38 karakter pertama adalah untuk GUID, dan karakter terakhir adalah untuk karakter null yang mengakhiri.

Menampilkan nilai

Nilai Makna
ERROR_BAD_CONFIGURATION
 Data konfigurasi rusak.
ERROR_INVALID_PARAMETER
 Parameter yang tidak valid diteruskan ke fungsi.
ERROR_NO_MORE_ITEMS
 Tidak ada klien yang akan dikembalikan.
ERROR_NOT_ENOUGH_MEMORY
 Sistem tidak memiliki cukup memori untuk menyelesaikan operasi. Tersedia dengan Windows Server 2003.
ERROR_SUCCESS
 Nilai dijumlahkan.
ERROR_UNKNOWN_COMPONENT
 Komponen yang ditentukan tidak diketahui.

Keterangan

Untuk menghitung klien, aplikasi awalnya harus memanggil fungsi MsiEnumClients dengan parameter iProductIndex yang diatur ke nol. Aplikasi kemudian harus meningkatkan parameter iProductIndex dan memanggil MsiEnumClients sampai tidak ada lagi klien (yaitu, sampai fungsi kembali ERROR_NO_MORE_ITEMS).

Saat melakukan beberapa panggilan ke MsiEnumClients untuk menghitung semua klien komponen, setiap panggilan harus dilakukan dari utas yang sama.

Catatan

Header msi.h mendefinisikan MsiEnumClients sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta pra-prosesor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

   
Klien minimum yang didukung Windows Installer 5.0 di Windows Server 2012, Windows 8, Windows Server 2008 R2 atau Windows 7. Windows Installer 4.0 atau Windows Installer 4.5 di Windows Server 2008 atau Windows Vista. Windows Installer pada Windows Server 2003 atau Windows XP. Lihat Persyaratan Run-Time Penginstal Windows untuk informasi tentang paket layanan Windows minimum yang diperlukan oleh versi Penginstal Windows.
Target Platform Windows
Header msi.h
Pustaka Msi.lib
DLL Msi.dll

Lihat juga

Fungsi Status Sistem