書式
int DownLoadData( int max )
throw( CSymNaviException )
返り値
実際にダウンロードした行数
パラメタ
max | (in) | ダウンロードする最大行数数 |
例外
エラーが発生した場合、CSymNaviExceptionオブジェクトを返却します。
例外詳細コード
詳細コード | 意味 |
---|---|
NAVI_ERROR_CATALOG | 問い合わせファイルが読み込まれていない |
NAVI_ERROR_EXECMD | 問い合わせファイルの実行に失敗 |
NAVI_ERROR_DOWNLOAD | データのダウンロードに失敗 |
説明
問い合わせの実行結果をレコード単位でダウンロードします。
この関数はNAVI_DOWNLOADLATERを指定してExecuteを呼び出した場合に使用します。
問い合わせ結果をダウンロードする場合は、この関数を繰り返し呼び出してください。
指定したパラメタ max よりも小さい値が返却されたら、ダウンロードが完了したことを示しています。
ダウンロードを途中で打ち切りたい場合は、TerminateDownLoading を呼び出してください。この場合、SaveData では、ダウンロードしたレコードの分だけデータが出力されます。また、GetRecordData では、ダウンロードしたレコードの分だけデータを取得することができます。
すべてのレコードのダウンロードが完了した場合は、TerminateDownLoading は呼ぶ必要がありません。(呼んでもかまいません)
問い合わせが複数のレポートを含む場合、本関数は、すべてのページを対象として動作します。
問い合わせファイルが読み込まれていない場合、本関数はエラーとなります。
問い合わせファイルが実行されていない場合、本関数はエラーとなります。
エラーメッセージは、CSymNaviException::GetErrorMessage を用いて取得できます。
エラー例外詳細コードは、CSymNaviException::GetReturnCode を用いて取得できます。