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

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

リンクオブジェクトがキャッシュされたデータを更新する頻度を指定します。

構文

HRESULT SetUpdateOptions(
  [in] DWORD dwUpdateOpt
);

パラメーター

[in] dwUpdateOpt

リンクオブジェクトがキャッシュされたデータを更新する頻度を指定します。 dwUpdateOpt に指定できる値は、列挙 OLEUPDATE から取得されます。

戻り値

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

リターンコード	説明
E_INVALIDARG	指定された値が無効です。

注釈

呼び出し元へのメモ

エンドユーザーがリンクオブジェクトの更新オプションを変更した場合、コンテナーアプリケーションは IOleLink::SetUpdateOptions を呼び出す必要があります。

エンドユーザーは、[ リンク ] ダイアログボックスを使用してリンクオブジェクトの更新オプションを選択します。 OleUIEditLinks 関数を使用してこのダイアログボックスを表示する場合は、IOleUILinkContainer インターフェイスを実装する必要があります。ダイアログボックスは IOleUILinkContainer::SetLinkUpdateOptions メソッドを呼び出して、エンドユーザーが選択した更新オプションを指定します。このメソッドの実装では 、IOleLink::SetUpdateOptions メソッドを呼び出して、選択したオプションをリンクオブジェクトに渡す必要があります。

実装者へのメモ

既定の更新オプションはOLEUDPATE_ALWAYS。リンクオブジェクトの IPersistStorage::Save の実装により、現在の更新オプションが保存されます。

OLEUDPATE_ALWAYSが update オプションとして指定されている場合、リンクされたオブジェクトは、次の状況でリンクのキャッシュを更新します。

リンクソースが実行されている場合、更新オプションが手動から自動に変更されたとき。
リンクオブジェクトがリンクソースにバインドされるたびに。
リンクソースが実行されていて、リンクオブジェクトの IOleObject::Close、 IPersistStorage::Save、または IAdviseSink::OnSave 実装が呼び出されるたびに。

手動リンクと自動リンクの両方で、コンテナーアプリケーションが IOleObject::Update または IOleLink::Update を呼び出すたびに、リンクオブジェクトによってキャッシュが更新されます。

要件

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