機能
時間型管理ポイントの期間を変更する。
書式
[Excelを使用する場合]
NaviChangePeriod( ByVal hTCPoint As Long , rc As Long , ByVal condition As Long , ByVal fromTime As String , ByVal toTime As String , ByVal reserve As String )
[Visual Basicを使用する場合]
NaviChangePeriod( ByVal hTCPoint As Integer , ByRef rc As Integer , ByVal condition As Integer , ByVal fromTime As String , ByVal toTime As String , ByVal reserve As String )
パラメタ
hTCPoint | (in) | 時間型管理ポイントのハンドル |
rc | (out) | 返却コード
|
condition | (in) | 期間の指定方法
|
fromTime | (in) | 開始期 |
toTime | (in) | 終了期 |
reserve | (in) | 将来拡張のために用意したパラメタ 必ず空文字列“”を指定してください |
エラーの詳細コード
詳細コード | 意味 |
---|---|
NAVI_ERROR_TYPE | 扱えない型の管理ポイントが指定された |
NAVI_ERROR_VALUE | 入力値が不正 |
NAVI_ERROR_NOSUPPORT | サポート外の機能範囲が指定されている |
NAVI_ERROR | その他のエラー |
説明
問い合わせファイル作成時に指定した時間型管理ポイントの期間を変更します。
変更を行ったあとにNaviExecuteCatalog を呼び出して問い合わせを実行すると、変更した内容で問い合わせが行われます。
パラメタfromTime、およびパラメタtoTimeはYYYYMMDD形式の文字列で指定してください。指定できるのは1800年1月1日(“18000101”)から2100年12月31日(“21001231”)までです。それ以外の値や不適当な値を指定した場合、本関数、またはNaviExecuteCatalogの呼び出し時に、アプリケーションが予期しない振る舞いをします。
問い合わせが複数のレポートを含み、操作対象の管理ポイントが表側、および時間フィールドに指定されている場合は、本関数はすべてのページの管理ポイントを対象として動作します。
本関数は、時間型管理ポイント(ユーザが定義した時間型管理ポイントを除く)に対してのみ有効です。それ以外が指定された場合はエラーとなります。
管理ポイントのハンドルは、NaviGetControlPoint 、またはNaviGetControlPointForTimeSpan で取得してください。それ以外の不正なハンドルを使用した場合、アプリケーションは予期しない振る舞いをします。
エラーが発生した時に、エラーの詳細コードを取得したい場合は、エラー詳細コード取得関数NaviGetErrorCode を呼び出してください。また、Navigatorサーバ、またはNavigator APIが出力したエラーメッセージを参照したい場合は、エラーメッセージ取得関数NaviGetErrorMessage を呼び出してください。
『CSVファイル、またはShunsaku利用時の注意事項』
以下の条件の場合に、conditionにNAVI_ALLを指定するとエラーとなります。詳細コードには、NAVI_ERROR_NOSUPPORTが返却されます。
表側フィールド、または時間フィールドの時間型管理ポイントに対して使用する場合は、[データ]フィールドにCSVファイル、またはShunsakuのデータがあるとエラーになります。
(問い合わせが複数ページで構成される(マルチクロスレポート)場合は、どれかのページにShunsakuのデータがある場合も含みます)
表頭フィールド、条件フィールドの時間型管理ポイントに対して使用する場合は、[データ]フィールドにCSVファイル、またはShunsakuのデータがあるとエラーになります。
(問い合わせが複数ページで構成される(マルチクロスレポート)場合は、該当ページにCSVファイル、またはShunsakuのデータがある場合のみです)
※旧バージョンの詳細コード「NAVI_ERROR_SHUNSAKU」は、Shunsakuを利用する場合に、互換用コードとして利用できます。