Fungsi MsiProvideComponentW (msi.h)

Artikel
11/20/2024

Fungsi MsiProvideComponent mengembalikan jalur komponen lengkap, melakukan penginstalan yang diperlukan. Fungsi ini meminta sumber jika perlu dan menaikkan jumlah penggunaan untuk fitur tersebut.

Sintaksis

UINT MsiProvideComponentW(
  [in]      LPCWSTR szProduct,
  [in]      LPCWSTR szFeature,
  [in]      LPCWSTR szComponent,
  [in]      DWORD   dwInstallMode,
  [out]     LPWSTR  lpPathBuf,
  [in, out] LPDWORD pcchPathBuf
);

Parameter

[in] szProduct

Menentukan kode produk untuk produk yang berisi fitur dengan komponen yang diperlukan.

[in] szFeature

Menentukan ID fitur fitur dengan komponen yang diperlukan.

[in] szComponent

Menentukan kode komponen dari komponen yang diperlukan.

[in] dwInstallMode

Menentukan mode penginstalan. Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Arti
INSTALLMODE_DEFAULT	Berikan komponen dan lakukan penginstalan apa pun yang diperlukan untuk menyediakan komponen. Jika file kunci komponen dalam fitur yang diminta, atau induk fitur, hilang, instal ulang fitur menggunakan MsiReinstallFeature dengan kumpulan bit bendera berikut: REINSTALLMODE_FILEMISSING, REINSTALLMODE_FILEOLDERVERSION, REINSTALLMODE_FILEVERIFY, REINSTALLMODE_MACHINEDATA, REINSTALLMODE_USERDATA, dan REINSTALLMODE_SHORTCUT.
INSTALLMODE_EXISTING	Berikan komponen hanya jika fitur ada. Jika tidak, kembalikan ERROR_FILE_NOT_FOUND. Mode ini memverifikasi bahwa file kunci komponen ada.
INSTALLMODE_NODETECTION	Berikan komponen hanya jika fitur ada. Jika tidak, kembalikan ERROR_FILE_NOT_FOUND. Mode ini hanya memeriksa bahwa komponen terdaftar dan tidak memverifikasi bahwa file kunci komponen ada.
kombinasi bendera REINSTALLMODE	Panggil MsiReinstallFeature untuk menginstal ulang fitur menggunakan parameter ini untuk parameter dwReinstallMode, lalu berikan komponen.
INSTALLMODE_NOSOURCERESOLUTION	Berikan komponen hanya jika status penginstalan fitur INSTALLSTATE_LOCAL. Jika status penginstalan fitur INSTALLSTATE_SOURCE, kembalikan ERROR_INSTALL_SOURCE_ABSENT. Jika tidak, kembalikan ERROR_FILE_NOT_FOUND. Mode ini hanya memeriksa apakah komponen terdaftar dan tidak memverifikasi bahwa file kunci ada.

[out] lpPathBuf

Penunjuk ke variabel yang menerima jalur ke komponen. Parameter ini bisa null.

[in, out] pcchPathBuf

Penunjuk ke variabel yang menentukan ukuran, dalam karakter, dari buffer yang ditujukkan oleh parameter lpPathBuf. Pada input, ini adalah ukuran penuh buffer, termasuk spasi untuk karakter null yang mengakhiri. Jika buffer yang diteruskan terlalu kecil, jumlah yang dikembalikan tidak menyertakan karakter null yang mengakhiri.

Jika lpPathBuf null, pcchBuf dapat null.

Mengembalikan nilai

Nilai	Arti
ERROR_BAD_CONFIGURATION	Data konfigurasi rusak.
ERROR_FILE_NOT_FOUND	Fitur ini tidak ada atau rusak. kesalahan ini dikembalikan untuk dwInstallMode = INSTALLMODE_EXISTING.
ERROR_INSTALL_FAILURE	Penginstalan gagal.
ERROR_INSTALL_NOTUSED	Komponen yang diminta dinonaktifkan pada komputer.
ERROR_INVALID_PARAMETER	Parameter yang tidak valid diteruskan ke fungsi.
ERROR_SUCCESS	Fungsi berhasil diselesaikan.
ERROR_UNKNOWN_FEATURE	ID fitur tidak mengidentifikasi fitur yang diketahui.
ERROR_UNKNOWN_PRODUCT	Kode produk tidak mengidentifikasi produk yang diketahui.
INSTALLSTATE_UNKNOWN	Produk yang tidak dikenal atau nama fitur diteruskan ke fungsi.
ERROR_MORE_DATA	Luapan buffer dikembalikan.
ERROR_INSTALL_SOURCE_ABSENT	Tidak dapat mendeteksi sumber.

Untuk informasi selengkapnya, lihat Pesan Kesalahan yang Ditampilkan.

Komentar

Setelah keberhasilan fungsi MsiProvideComponent, parameter pcchPathBuf berisi panjang string dalam lpPathBuf.

Fungsi MsiProvideComponent menggabungkan fungsionalitas MsiUseFeature, MsiConfigureFeature, dan MsiGetComponentPath. Anda dapat menggunakan fungsi MsiProvideComponent untuk menyederhanakan urutan panggilan. Namun, karena fungsi ini menaikkan jumlah penggunaan, gunakan dengan hati-hati untuk mencegah jumlah penggunaan yang tidak akurat. Fungsi MsiProvideComponent juga memberikan lebih sedikit fleksibilitas daripada rangkaian panggilan individual.

Jika aplikasi pulih dari situasi yang tidak terduga, aplikasi mungkin telah memanggil MsiUseFeature dan meningkatkan jumlah penggunaan. Dalam hal ini, aplikasi harus memanggil MsiConfigureFeature alih-alih MsiProvideComponent untuk menghindari peningkatan jumlah lagi.

Opsi INSTALLMODE_EXISTING tidak dapat digunakan dalam kombinasi dengan bendera REINSTALLMODE.

Fitur dengan komponen yang berisi file yang rusak atau versi file yang salah harus diinstal ulang secara eksplisit oleh pengguna atau dengan melakukan panggilan aplikasi MsiReinstallFeature.

Nota

Header msi.h mendefinisikan MsiProvideComponent sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosem 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

Syarat	Nilai
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 pada 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.
Platform Target	Windows
Header	msi.h
Pustaka	Msi.lib
DLL	Msi.dll

Lihat juga

Component-Specific Functions

Penginstalan Multiple-Package

Bagikan melalui