Fungsi StrRetToBufA (shlwapi.h)

Artikel
20/11/2024

Mengonversi struktur STRRET yang dikembalikan oleh IShellFolder::GetDisplayNameOf ke string, dan menempatkan hasilnya dalam buffer.

Sintaksis

C++

LWSTDAPI StrRetToBufA(
  [in, out] STRRET          *pstr,
  [in]      PCUITEMID_CHILD pidl,
  [out]     LPSTR           pszBuf,
  [in]      UINT            cchBuf
);

Parameter

[in, out] pstr

Jenis: STRRET

Penunjuk ke struktur STRRET . Ketika fungsi kembali, penunjuk ini tidak akan valid lagi.

[in] pidl

Jenis: PCUITEMID_CHILD

Penunjuk ke struktur ITEMIDLIST item.

[out] pszBuf

Jenis: LPTSTR

Buffer untuk menahan nama tampilan. Ini akan dikembalikan sebagai string null-terminated. Jika cchBuf terlalu kecil, nama akan dipotong agar pas.

[in] cchBuf

Jenis: UINT

Ukuran pszBuf, dalam karakter. Jika cchBuf terlalu kecil, string akan dipotong agar pas.

Mengembalikan nilai

Jenis: HRESULT

Jika fungsi ini berhasil, fungsi akan mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT.

Komentar

Jika uType anggota struktur yang ditunjukkan oleh pstr diatur ke STRRET_WSTR, pOleStr anggota struktur tersebut akan dibebaskan saat pengembalian.

Catatan

Header shlwapi.h mendefinisikan StrRetToBuf sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosesor 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 2000 Professional, Windows XP [hanya aplikasi desktop]
server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Platform Target	Windows
Header	shlwapi.h
Pustaka	Shlwapi.lib
DLL	Shlwapi.dll (versi 5.0 atau yang lebih baru)

Lihat juga

StrRetToStr

StrRetToStrN

Bagikan melalui