Fungsi MsiEnumClientsExA (msi.h)

Fungsi MsiEnumClientsEx menghitung aplikasi yang diinstal yang menggunakan komponen tertentu. Fungsi ini mengambil kode produk untuk aplikasi setiap kali dipanggil.

Windows Installer 4.5 atau yang lebih lama: Tidak didukung. Fungsi ini tersedia dimulai dengan Windows Installer 5.0.

Sintaksis

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

GUID kode komponen yang mengidentifikasi komponen. Fungsi menghitung aplikasi yang menggunakan komponen ini.

[in, optional] szUserSid

Nilai string null-terminated yang berisi pengidentifikasi keamanan (SID.) Enumerasi aplikasi meluas ke pengguna yang diidentifikasi oleh SID ini. String SID khusus s-1-1-0 (Semua Orang) menghitung semua aplikasi untuk semua pengguna dalam sistem. Nilai SID selain s-1-1-0 menentukan SID pengguna untuk pengguna tertentu dan menghitung instans aplikasi yang diinstal oleh pengguna yang ditentukan.

[in] dwContext

Bendera yang memperluas enumerasi ke instans aplikasi yang diinstal dalam konteks penginstalan yang ditentukan. Enumerasi hanya mencakup instans aplikasi yang diinstal oleh pengguna yang diidentifikasi oleh szUserSid.

Ini bisa menjadi kombinasi dari nilai berikut.

[in] dwProductIndex

Menentukan indeks aplikasi yang akan diambil. Nilai parameter ini harus nol (0) dalam panggilan pertama ke fungsi. Untuk setiap panggilan berikutnya, indeks harus bertambah 1. Indeks hanya boleh dinaikkan jika panggilan sebelumnya ke fungsi mengembalikan ERROR_SUCCESS.

[out, optional] szProductBuf

Nilai string yang menerima kode produk untuk aplikasi. Panjang buffer di lokasi ini harus cukup besar untuk menahan nilai string yang dihentikan null yang berisi kode produk. 38 karakter TCHAR pertama menerima GUID untuk komponen, dan karakter ke-39 menerima karakter NULL yang mengakhiri.

[out, optional] pdwInstalledContext

Bendera yang memberikan konteks penginstalan aplikasi.

Ini bisa menjadi kombinasi dari nilai berikut.

[out, optional] szSid

Menerima pengidentifikasi keamanan (SID) yang mengidentifikasi pengguna yang menginstal aplikasi. Lokasi menerima nilai string kosong jika instans aplikasi ini ada dalam konteks penginstalan per komputer.

Panjang buffer harus cukup besar untuk menahan nilai string null-terminated yang berisi SID. Jika buffer terlalu kecil, fungsi mengembalikan ERROR_MORE_DATA dan lokasi yang ditunjukkan oleh pcchSid menerima jumlah TCHAR di SID, tidak termasuk karakter NULL yang mengakhiri.

Jika szSid diatur ke NULL dan pcchSid adalah penunjuk yang valid ke lokasi dalam memori, fungsi mengembalikan ERROR_SUCCESS dan lokasi menerima jumlah TCHAR dalam SID, tidak termasuk karakter null yang mengakhiri. Fungsi kemudian dapat dipanggil lagi untuk mengambil nilai , dengan szSid buffer mengubah ukuran yang cukup besar untuk berisi *pcchSid + 1 karakter.

[in, out, optional] pcchSid

Penunjuk ke lokasi dalam memori yang berisi variabel yang menentukan jumlah TCHAR dalam SID, tidak termasuk karakter null yang mengakhiri. Ketika fungsi kembali, variabel ini diatur ke ukuran SID yang diminta apakah fungsi dapat berhasil menyalin SID dan mengakhiri karakter null ke lokasi buffer yang ditujukan oleh szSid. Ukuran dikembalikan sebagai jumlah TCHAR dalam nilai yang diminta, tidak termasuk karakter null yang dihentikan.

Parameter ini dapat diatur ke NULL hanya jika szSid juga NULL, jika tidak, fungsi mengembalikan ERROR_INVALID_PARAMETER. Jika szSid dan pcchSid keduanya diatur ke NULL, fungsi mengembalikan ERROR_SUCCESS jika SID ada, tanpa mengambil nilai SID.

Mengembalikan nilai

Fungsi MsiEnumClientsEx mengembalikan salah satu nilai berikut.

Komentar

Persyaratan