Fungsi AssocQueryStringByKeyA (shlwapi.h)

Artikel
03/02/2024

Mencari dan mengambil string terkait asosiasi file dari registri mulai dari kunci tertentu.

Sintaks

LWSTDAPI AssocQueryStringByKeyA(
  [in]            ASSOCF   flags,
  [in]            ASSOCSTR str,
  [in]            HKEY     hkAssoc,
  [in, optional]  LPCSTR   pszExtra,
  [out, optional] LPSTR    pszOut,
  [in, out]       DWORD    *pcchOut
);

Parameter

[in] flags

Jenis: ASSOCF

Bendera yang dapat digunakan untuk mengontrol pencarian. Ini bisa menjadi kombinasi nilai ASSOCF apa pun, kecuali bahwa hanya satu nilai ASSOCF_INIT yang dapat disertakan.

[in] str

Jenis: ASSOCSTR

Nilai ASSOCSTR yang menentukan jenis string yang akan dikembalikan.

[in] hkAssoc

Jenis: HKEY

Nilai HKEY dari kunci yang akan digunakan sebagai kunci akar. Pencarian hanya terlihat di bawah kunci ini.

[in, optional] pszExtra

Jenis: LPCTSTR

Penunjuk ke string opsional yang dihentikan null dengan informasi tambahan tentang lokasi string. Biasanya diatur ke kata kerja Shell seperti terbuka. Atur parameter ini ke NULL jika tidak digunakan.

[out, optional] pszOut

Jenis: LPTSTR

Penunjuk ke string yang dihentikan null yang digunakan untuk mengembalikan string yang diminta. Atur parameter ini ke NULL untuk mengambil ukuran buffer yang diperlukan.

[in, out] pcchOut

Jenis: DWORD*

Penunjuk ke nilai yang, pada entri, menentukan jumlah karakter dalam buffer pszOut . Saat fungsi kembali, fungsi menunjuk ke jumlah karakter yang ditempatkan di buffer.

Jika bendera ASSOCF_NOTRUNCATE diatur dalam bendera dan buffer yang ditentukan dalam pszOut terlalu kecil, fungsi mengembalikan E_POINTER dan nilai diatur ke ukuran buffer yang diperlukan.

Jika pszOut adalah NULL, fungsi mengembalikan S_FALSE dan pcchOut menunjuk ke ukuran buffer yang diperlukan.

Nilai kembali

Jenis: HRESULT

Mengembalikan nilai kesalahan COM standar, termasuk yang berikut ini:

Kesalahan	Makna
S_OK	Berhasil.
E_POINTER	Buffer pszOut terlalu kecil untuk menahan seluruh string.
S_FALSE	pszOut adalah NULL. pcchOut berisi ukuran buffer yang diperlukan.

Keterangan

Fungsi ini adalah pembungkus untuk antarmuka IQueryAssociations . Ini dimaksudkan untuk menyederhanakan proses penggunaan antarmuka ini. Untuk diskusi lebih lanjut tentang cara kerja fungsi asosiasi file, lihat IQueryAssociations.

Catatan

Header shlwapi.h mendefinisikan AssocQueryStringByKey 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 2000 Professional, Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	shlwapi.h
Pustaka	Shlwapi.lib
DLL	Shlwapi.dll (versi 5.0 atau yang lebih baru)

Bagikan melalui