Share via

_QueryTable.Refresh(Object) メソッド

  • リファレンス

定義

名前空間:
Microsoft.Office.Interop.Excel
アセンブリ:
Microsoft.Office.Interop.Excel.dll

外部データ範囲 (QueryTable) をUpdatesします。 ブール値 です。

public bool Refresh (object BackgroundQuery);
Public Function Refresh (Optional BackgroundQuery As Object) As Boolean

パラメーター

BackgroundQuery
Object

省略可能 なオブジェクト。 QueryTables が SQL クエリの結果を基にしている場合にのみ使用します。 データベース接続が確立し、クエリが実行されると直ちに制御をプロシージャに返す場合は True を指定します。 QueryTable はバックグラウンドで更新されます。 すべてのデータをシートに取り出した後で制御をプロシージャに返す場合は False を指定します。 この引数を指定しない場合、プロパティの設定によって BackgroundQuery クエリ モードが決まります。

戻り値

Boolean

注釈

この「備考」の内容は SQL クエリの結果を基にした QueryTable オブジェクトに適用されます。

Refresh メソッドは、QueryTable オブジェクトのデータ ソースに接続し、SQL クエリを実行し、QueryTable オブジェクトに基づいた範囲にデータを返します。 このメソッドを呼び出すまで、QueryTable オブジェクトはデータ ソースと通信しません。

OLE DB または ODBC データ ソースへの接続を行うとき、Microsoft Excel では、 プロパティで指定された接続文字列をConnection使用します。 この接続文字列の情報が十分でない場合、必要な情報をユーザーに確認するダイアログ ボックスが表示されます。 プロパティが DisplayAlertsFalse の場合、ダイアログ ボックスは表示されず、 Refresh メソッドは不十分な接続情報例外で失敗します。

接続に成功すると、完全な接続文字列が保存され、同じ編集セッションでこの後 Refresh メソッドが呼び出されるときにダイアログ ボックスが表示されなくなります。 プロパティの値を調べることで、完了した接続文字列をConnection取得できます。

データベース接続が確立すると、SQL クエリの妥当性が確認されます。 クエリが有効でない場合、SQL 構文エラーの例外で Refresh メソッドは失敗します。

クエリにパラメーターが必要な場合は、Refresh メソッドをParameters呼び出す前に、パラメーター バインド情報を使用してコレクションを初期化する必要があります。 結合しているパラメーターが不十分な場合、Refresh メソッドはパラメーター エラー例外で失敗します。 パラメーターを設定して値の入力を求める場合、プロパティの設定に関係なく、ダイアログ ボックスがユーザーに DisplayAlerts 表示されます。 パラメーターを指定するダイアログ ボックスをユーザーがキャンセルすると、Refresh メソッドは停止し、False を返します。 追加のパラメーターが Parameters コレクションにバインドされている場合、これらの追加パラメーターは無視されます。

クエリが正常に完了するか、開始されると、Refresh メソッドは True を返します。接続文字列またはパラメーターを指定するダイアログ ボックスをユーザーがキャンセルすると、このメソッドは False を返します。

フェッチされた行の数がワークシートの使用可能な行数を超えたかどうかを確認するには、 プロパティを FetchedRowOverflow 調べます。 このプロパティは、 Refresh メソッドを呼び出すたびに初期化されます。

適用対象