Fungsi StrRetToBufA (shlwapi.h)
Mengonversi struktur STRRET yang dikembalikan oleh IShellFolder::GetDisplayNameOf ke string, dan menempatkan hasilnya dalam buffer.
Sintaks
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 lagi valid.
[in] pidl
Jenis: PCUITEMID_CHILD
Penunjuk ke struktur ITEMIDLIST item.
[out] pszBuf
Jenis: LPTSTR
Buffer untuk menahan nama tampilan. Ini akan dikembalikan sebagai string yang dihentikan null. Jika cchBuf terlalu kecil, nama akan terpotong agar pas.
[in] cchBuf
Jenis: UINT
Ukuran pszBuf, dalam karakter. Jika cchBuf terlalu kecil, string akan terpotong agar pas.
Nilai kembali
Jenis: HRESULT
Jika fungsi ini berhasil, fungsi akan mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT akan dikembalikan.
Keterangan
Jika anggota uType struktur yang diacu oleh pstr diatur ke STRRET_WSTR, anggota pOleStr dari struktur tersebut akan dikosongkan saat dikembalikan.
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
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) |