Fungsi MsiSummaryInfoGetPropertyA (msiquery.h)

Fungsi MsiSummaryInfoGetProperty mendapatkan satu properti dari aliran informasi ringkasan.

Catatan Arti nilai properti tergantung pada apakah aliran informasi ringkasan adalah untuk database penginstalan (file .msi), transformasi (file .mst) atau patch (file .msp). Lihat Deskripsi Properti Ringkasan dan Informasi Ringkasan Stream Kumpulan Properti untuk informasi selengkapnya tentang properti informasi ringkasan.

 

Sintaks

UINT MsiSummaryInfoGetPropertyA(
  [in]      MSIHANDLE hSummaryInfo,
  [in]      UINT      uiProperty,
  [out]     PUINT     puiDataType,
  [out]     LPINT     piValue,
  [out]     FILETIME  *pftValue,
  [out]     LPSTR     szValueBuf,
  [in, out] LPDWORD   pcchValueBuf
);

Parameter

[in] hSummaryInfo

Menangani informasi ringkasan.

[in] uiProperty

Menentukan ID properti dari properti ringkasan. Parameter ini bisa menjadi ID properti yang tercantum dalam Ringkasan Informasi Stream Kumpulan Properti. Fungsi ini tidak mengembalikan nilai untuk properti PID_DICTIONARY OR PID_THUMBNAIL.

[out] puiDataType

Menerima jenis properti yang dikembalikan. Parameter ini dapat berupa jenis yang tercantum dalam
Informasi Ringkasan Stream Kumpulan Properti.

[out] piValue

Menerima data properti bilangan bulat yang dikembalikan.

[out] pftValue

Penunjuk ke nilai file.

[out] szValueBuf

Penunjuk ke buffer yang menerima nilai properti informasi ringkasan null yang dihentikan. Jangan mencoba menentukan ukuran buffer dengan meneruskan null (value=0) untuk szValueBuf. Anda bisa mendapatkan ukuran buffer dengan meneruskan string kosong (misalnya ""). Fungsi kemudian mengembalikan ERROR_MORE_DATA dan pcchValueBuf berisi ukuran buffer yang diperlukan dalam TCHAR, tidak termasuk karakter null yang mengakhiri. Pada pengembalian ERROR_SUCCESS, pcchValueBuf berisi jumlah TCHAR yang ditulis ke buffer, tidak termasuk karakter null yang mengakhiri. Parameter ini adalah string kosong jika tidak ada kesalahan.

[in, out] pcchValueBuf

Penunjuk ke variabel yang menentukan ukuran, dalam TCHAR, dari buffer yang diacu oleh variabel szValueBuf. Ketika fungsi mengembalikan ERROR_SUCCESS, variabel ini berisi ukuran data yang disalin ke szValueBuf, tidak termasuk karakter null yang mengakhiri. Jika szValueBuf tidak cukup besar, fungsi mengembalikan ERROR_MORE_DATA dan menyimpan ukuran yang diperlukan, tidak termasuk karakter null yang mengakhiri, dalam variabel yang ditunjukkan oleh pcchValueBuf.

Mengembalikan nilai

Fungsi MsiSummaryInfoGetProperty mengembalikan salah satu nilai berikut:

Keterangan

Jika ERROR_MORE_DATA dikembalikan, parameter yang merupakan penunjuk memberikan ukuran buffer yang diperlukan untuk menahan string. Jika ERROR_SUCCESS dikembalikan, ia memberikan jumlah karakter yang ditulis ke buffer string. Oleh karena itu Anda bisa mendapatkan ukuran buffer dengan meneruskan string kosong (misalnya "") untuk parameter yang menentukan buffer. Jangan mencoba menentukan ukuran buffer dengan meneruskan Null (value=0).

Fungsi Pemasang Windows yang mengembalikan data di lokasi memori yang disediakan pengguna tidak boleh dipanggil dengan null sebagai nilai untuk penunjuk. Fungsi-fungsi ini mengembalikan string atau mengembalikan data sebagai penunjuk bilangan bulat, tetapi mengembalikan nilai yang tidak konsisten saat meneruskan null sebagai nilai untuk argumen output. Untuk informasi selengkapnya, lihat Meneruskan Null sebagai Argumen Fungsi Penginstal Windows.

Informasi properti yang dikembalikan oleh fungsi MsiSummaryInfoGetProperty diterima oleh parameter piValue, pftValue, atau szValueBuf tergantung pada jenis nilai properti yang telah ditentukan dalam parameter puiDataType .

Catatan

Header msiquery.h mendefinisikan MsiSummaryInfoGetProperty 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

Persyaratan	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 di Windows Server 2008 atau Windows Vista. Pemasang Windows pada Windows Server 2003 atau Windows XP
Target Platform	Windows
Header	msiquery.h
Pustaka	Msi.lib
DLL	Msi.dll

Lihat juga

Meneruskan Null sebagai Argumen Fungsi Pemasang Windows

Fungsi Properti Informasi Ringkasan

Informasi Ringkasan Stream Kumpulan Properti

Summaryinfo.Property