IQueryAssociations::Metode GetString (shlwapi.h)

Artikel
08/26/2023

Mencari dan mengambil string terkait asosiasi file atau protokol dari registri.

Sintaks

HRESULT GetString(
  [in]            ASSOCF   flags,
  [in]            ASSOCSTR str,
  [in, optional]  LPCWSTR  pszExtra,
  [out, optional] LPWSTR   pszOut,
  [in, out]       DWORD    *pcchOut
);

Parameter

[in] flags

Jenis: ASSOCF

Bendera yang dapat digunakan untuk mengontrol pencarian. Ini bisa menjadi kombinasi dari nilai ASSOCF berikut.

[in] str

Jenis: ASSOCSTR

Nilai ASSOCSTR yang menentukan jenis string yang akan dikembalikan.

[in, optional] pszExtra

Jenis: LPCWSTR

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

[out, optional] pszOut

Jenis: LPWSTR

Penunjuk ke string Unicode 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, diatur ke jumlah karakter dalam buffer pwszOut . Ketika fungsi berhasil dikembalikan, fungsi menunjuk ke jumlah karakter yang ditempatkan dalam buffer.

Jika bendera ASSOCF_NOTRUNCATE diatur dalam bendera dan buffer yang ditentukan dalam pwszOut terlalu kecil, fungsi mengembalikan E_POINTER dan pcchOut menunjuk ke ukuran buffer yang diperlukan.

Jika pwszOutNULL, 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 pwszOut terlalu kecil untuk menahan seluruh string.
S_FALSE	pwszOut adalah NULL. pcchOut berisi ukuran buffer yang diperlukan.

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	Shell32.dll (versi 5.0 atau yang lebih baru)

Share via