Metode IOleLink::GetSourceDisplayName (oleidl.h)

Artikel
03/04/2024

Mengambil nama tampilan sumber tautan objek yang ditautkan.

Sintaks

HRESULT GetSourceDisplayName(
  [out] LPOLESTR *ppszDisplayName
);

Parameter

[out] ppszDisplayName

Alamat variabel penunjuk yang menerima penunjuk ke nama tampilan sumber tautan. Jika terjadi kesalahan, ppszDisplayName diatur ke NULL; jika tidak, implementasi harus menggunakan IMalloc::Alloc untuk mengalokasikan string yang dikembalikan dalam ppszDisplayName, dan pemanggil bertanggung jawab untuk memanggil IMalloc::Free untuk membebaskannya. Baik penelepon maupun yang disebut menggunakan alokator yang dikembalikan oleh CoGetMalloc.

Nilai kembali

Metode ini mengembalikan S_OK pada keberhasilan. Kemungkinan nilai pengembalian lainnya termasuk yang berikut ini.

Menampilkan kode	Deskripsi
E_FAIL	Operasi gagal.

Mengambil nama tampilan memerlukan panggilan fungsi-fungsi ini; oleh karena itu, metode ini dapat mengembalikan kesalahan yang dihasilkan oleh CreateBindCtx dan IMoniker::GetDisplayName.

Keterangan

Catatan untuk Penelepon

Aplikasi kontainer Anda dapat memanggil IOleLink::GetSourceDisplayName untuk menampilkan sumber tautan saat ini.

Sumber tautan saat ini ditampilkan dalam kotak dialog Tautan . Jika Anda menggunakan fungsi OleUIEditLinks untuk menampilkan kotak dialog Tautan , Anda harus menerapkan antarmuka IOleUILinkContainer . Kotak dialog memanggil implementasi IOleUILinkContainer::GetLinkSource Anda untuk mendapatkan string yang harus ditampilkan. Implementasi metode tersebut dapat memanggil IOleLink::GetSourceDisplayName.

Catatan untuk Pelaksana

Implementasi objek tertaut dari IOleLink::GetSourceDisplayName memanggil IOleLink::GetSourceMoniker untuk mendapatkan moniker sumber tautan, lalu memanggil IMoniker::GetDisplayName untuk mendapatkan nama tampilan moniker tersebut. Operasi ini berpotensi mahal karena mungkin memerlukan pengikatan moniker. Semua moniker yang disediakan sistem dapat mengembalikan nama tampilan tanpa mengikat, tetapi tidak ada jaminan bahwa implementasi moniker lainnya dapat. Alih-alih melakukan panggilan berulang ke IOleLink::GetSourceDisplayName, aplikasi kontainer Anda dapat menyimpan nama dan memperbaruinya setiap kali sumber tautan terikat.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	oleidl.h