Interstage Navigator ServerV9.5.0 Navigator APIプログラマーズガイド(Visual Basic編)

5.3.7 NaviTerminateDL

機能

ダウンロードの処理を打ち切る。

書式

[Excelを使用する場合]

NaviTerminateDL( ByVal hCatalog As Long , rc As Long )

[Visual Basicを使用する場合]

NaviTerminateDL( ByVal hCatalog As Integer , ByRef rc As Integer )

パラメタ

hCatalog	(in)	問い合わせファイルのハンドル
rc	(out)	返却コード NAVI_OK:正常終了 NAVI_ERROR:エラー

エラーの詳細コード

詳細コード	意味
NAVI_ERROR_EXECUTE	問い合わせファイルが実行されていない
NAVI_ERROR	その他のエラー

説明

ダウンロードの処理を打ち切ります。

この関数はNaviDownLoadData を使用して問い合わせ結果をダウンロードしている場合に、ダウンロードを途中で打ち切るために使用します。

すべてのレコードのダウンロードが完了した場合、本関数を呼び出す必要はありません。（呼んでもかまいません）

問い合わせが複数のレポートを含む場合、本関数はすべてのページを対象として動作します。

問い合わせファイルが実行されていない場合、本関数はエラーとなります。

問い合わせファイルのハンドルはNaviOpenCatalog から返却されたものを使用してください。それ以外の不正なハンドルを使用した場合、アプリケーションは予期しない振る舞いをします。

エラーが発生した時に、エラーの詳細コードを取得したい場合は、エラー詳細コード取得関数NaviGetErrorCode を呼び出してください。また、Navigatorサーバ、またはNavigator APIが出力したエラーメッセージを参照したい場合は、エラーメッセージ取得関数NaviGetErrorMessage を呼び出してください。