Fungsi StrRetToStrA (shlwapi.h)
Mengambil struktur STRRET yang dikembalikan oleh IShellFolder::GetDisplayNameOf dan mengembalikan pointer ke string yang dialokasikan yang berisi nama tampilan.
Sintaks
LWSTDAPI StrRetToStrA(
[in, out] STRRET *pstr,
[in, optional] PCUITEMID_CHILD pidl,
[out] LPSTR *ppsz
);
Parameter
[in, out] pstr
Jenis: STRRET*
Penunjuk ke struktur STRRET . Ketika fungsi kembali, penunjuk ini tidak akan valid lagi.
[in, optional] pidl
Jenis: PCUITEMID_CHILD
Penunjuk ke struktur ITEMIDLIST item. Nilai ini bisa NULL.
[out] ppsz
Jenis: LPTSTR*
Penunjuk ke string yang dialokasikan yang berisi hasilnya. StrRetToStr mengalokasikan memori untuk string ini dengan CoTaskMemAlloc. Anda harus membebaskan string dengan CoTaskMemFree ketika tidak lagi diperlukan.
Nilai kembali
Jenis: HRESULT
Jika fungsi ini berhasil, fungsi akan mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT akan dikembalikan.
Keterangan
Catatan
Header shlwapi.h mendefinisikan StrRetToStr 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) |