IOleUILinkContainerA::UpdateLink メソッド (oledlg.h)
選択したリンクを強制的にソースに接続し、現在の情報を取得します。
構文
HRESULT UpdateLink(
[in] DWORD dwLink,
[in] BOOL fErrorMessage,
[in] BOOL fReserved
);
パラメーター
[in] dwLink
単一リンクのコンテナー定義の一意識別子。 コンテナーでは、この値にリンクのコンテナー サイトへのポインターを使用できます。
[in] fErrorMessage
呼び出し元 ( IOleUILinkContainer の実装者) がリンクの更新に失敗したときにエラー メッセージを表示するかどうかを決定します。 [ リンクの更新 ] ダイアログ ボックスでは、これを FALSE に設定 します。 [オブジェクトのプロパティ] ダイアログ ボックスと [リンク] ダイアログ ボックスでは、このダイアログ ボックスを TRUE に設定します。
[in] fReserved
このパラメーターは予約されており、 FALSE に設定する必要があります。
戻り値
このメソッドは、成功したS_OKを返します。 その他の可能な戻り値は次のとおりです。
リターン コード | 説明 |
---|---|
|
アクセス許可が不十分です。 |
|
操作が失敗しました。 |
|
指定された識別子が無効です。 |
|
この操作に使用できるメモリが不足しています。 |
注釈
呼び出し元へのメモ
ユーザーがボタンを明示的に押してリンクを更新する場合、つまりリンクの [今すぐ更新] ボタンを押す場合は、fErrorMessage を TRUE に設定してこのメソッドを呼び出します。 コンテナーでエラー メッセージを表示しない場合、つまり、大きな操作セットが実行され、後で更新リンクの進行状況メーターで発生する可能性があるエラーをユーザーに反映する必要がある場合は、FALSE で呼び出します。 エラーがあると仮定して、エラーごとに 1 つのメッセージを提供するのではなく、操作の最後のすべてのエラーに対して 1 つのメッセージを提供します。実装者へのメモ
OLE リンクの場合は、 IOleObject::Update を呼び出します。要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | oledlg.h |