IOleLink::GetSourceDisplayName メソッド (oleidl.h)

[アーティクル]
03/01/2024

リンクオブジェクトのリンクソースの表示名を取得します。

構文

HRESULT GetSourceDisplayName(
  [out] LPOLESTR *ppszDisplayName
);

パラメーター

[out] ppszDisplayName

リンクソースの表示名へのポインターを受け取るポインター変数のアドレス。エラーが発生した場合、 ppszDisplayName は NULL に設定されます。それ以外の場合、実装では IMalloc::Alloc を使用して ppszDisplayName で返される文字列を割り当てる必要があります。呼び出し元は IMalloc::Free を呼び出して解放する必要があります。呼び出し元と呼び出し元の両方で、 CoGetMalloc によって返されるアロケーターが使用されます。

戻り値

このメソッドは、成功したS_OKを返します。その他の可能な戻り値は次のとおりです。

リターンコード	説明
E_FAIL	操作が失敗しました。

表示名を取得するには、これらの関数を呼び出す必要があります。したがって、このメソッドは CreateBindCtx と IMoniker::GetDisplayName によって生成されたエラーを返す場合があります。

注釈

呼び出し元へのメモ

コンテナーアプリケーションは IOleLink::GetSourceDisplayName を呼び出して、リンクの現在のソースを表示できます。

リンクの現在のソース が [リンク ] ダイアログボックスに表示されます。 OleUIEditLinks 関数を使用して [リンク] ダイアログボックスを表示する場合は、IOleUILinkContainer インターフェイスを実装する必要があります。ダイアログボックスは、IOleUILinkContainer::GetLinkSource の実装を呼び出して、表示する文字列を取得します。このメソッドの実装では 、IOleLink::GetSourceDisplayName を呼び出すことができます。

実装者へのメモ

リンクされたオブジェクトの IOleLink::GetSourceDisplayName の実装は、IOleLink::GetSourceMoniker を呼び出してリンクソースモニカーを取得し、 IMoniker::GetDisplayName を呼び出してそのモニカーの表示名を取得します。モニカーのバインドが必要になる可能性があるため、この操作はコストがかかる可能性があります。システム提供のすべてのモニカーは、バインドなしで表示名を返すことができますが、他のモニカー実装で可能な保証はありません。 IOleLink::GetSourceDisplayName を繰り返し呼び出す代わりに、コンテナーアプリケーションはリンクソースがバインドされるたびに名前をキャッシュして更新できます。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	oleidl.h