IOleUILinkContainerA::GetLinkSource メソッド (oledlg.h)

[アーティクル]
08/25/2023

[リンク] ダイアログボックスに表示できるリンクに関する情報を取得します。

構文

HRESULT GetLinkSource(
  [in]            DWORD dwLink,
  [out, optional] LPSTR *lplpszDisplayName,
  [out]           ULONG *lplenFileName,
  [out, optional] LPSTR *lplpszFullLinkType,
  [out, optional] LPSTR *lplpszShortLinkType,
  [out]           BOOL  *lpfSourceAvailable,
  [out]           BOOL  *lpfIsSelected
);

パラメーター

[in] dwLink

1 つのリンクのコンテナー定義の一意識別子。「IOleUILinkContainer::GetNextLink」を参照してください。

[out, optional] lplpszDisplayName

リンクソースの完全な表示名文字列へのポインターを受け取るポインター変数のアドレス。 [ リンク ] ダイアログボックスでは、この文字列が解放されます。

[out] lplenFileName

lplpszDisplayName 文字列の先頭のファイル名部分の長さを指すポインター。リンクソースがファイルに格納されていない場合、 lplenFileName は 0 である必要があります。 OLE リンクの場合は、 IOleLink::GetSourceDisplayName を呼び出します。

[out, optional] lplpszFullLinkType

[リンク] ダイアログボックスの下部に表示される完全なリンクの種類の文字列へのポインターを受け取る ポインター 変数のアドレス。呼び出し元はこの文字列を割り当てます。 [ リンク ] ダイアログボックスでは、この文字列が解放されます。 OLE リンクの場合、完全なユーザー型名を指定する必要があります。 dwFormOfType のUSERCLASSTYPE_FULLを指定して、IOleObject::GetUserType を使用します。

[out, optional] lplpszShortLinkType

[リンク] ダイアログボックスのリストボックスに表示される短いリンクの種類の文字列へのポインターを受け取る ポインター 変数のアドレス。呼び出し元はこの文字列を割り当てます。 [ リンク ] ダイアログボックスでは、この文字列が解放されます。 OLE リンクの場合、これは短いユーザー型名にする必要があります。 dwFormOfType のUSERCLASSTYPE_SHORTを指定して、IOleObject::GetUserType を使用します。

[out] lpfSourceAvailable

リンクが既知のドキュメントに対するリンクであるため、リンクが使用できないことがわかっている場合に FALSE を 返すポインター。このような場合は、[ 今すぐ更新] などの特定のオプションが無効 (ユーザーインターフェイスでは灰色表示) されます。

[out] lpfIsSelected

ダイアログの複数選択リストボックスでこのリンクのエントリを選択する必要があることを [リンクの編集 ] ダイアログボックスに指示する変数へのポインター。 OleUIEditLinks は、リンクリストに配置するアイテムごとにこのメソッドを少なくとも 1 回呼び出します。いずれも TRUE を返さない場合、ダイアログボックスが最初に表示されるときには選択されません。すべてが TRUE を返す場合は、すべて表示されます。つまり、このリンクが現在基になるドキュメントの選択範囲の一部である場合は TRUE を返し、そうでない場合は FALSE を 返します。基になるドキュメントで選択されているリンクは、ダイアログボックスで選択されます。これにより、ユーザーはリンクのセットを選択し、ダイアログボックスを使用してリンクを更新したり、ソースを同時に変更したりできます。

戻り値

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

リターンコード	説明
E_ACCESSDENIED	アクセス許可が不十分です。
E_FAIL	操作が失敗しました。
E_INVALIDARG	指定された識別子が無効です。
E_OUTOFMEMORY	この操作に使用できるメモリが不足しています。

注釈

呼び出し元へのメモ

[ ソースの変更 ] ダイアログボックスから戻った後、ダイアログボックスの初期化中にこのメソッドを呼び出します。

要件

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