5.4.5 NaviReloadCategory

機能

条件を指定してカテゴリをサーバ（辞書）から読み込み直す。

書式

[Excelを使用する場合]

NaviReloadCategory( ByVal hCPoint As Long , rc As Long , ByVal master As Long , key As String , ByVal search As Long , ByVal nonmatch As Long , reserve As String )

[Visual Basicを使用する場合]

NaviReloadCategory( ByVal hCPoint As Integer , ByRef rc As Integer , ByVal master As Integer , ByVal key As String , ByVal search As Integer , ByVal nonmatch As Integer , ByVal reserve As String )

パラメタ

hCPoint	(in)	管理ポイントのハンドル
rc	(out)	返却コード NAVI_OK:正常終了 NAVI_ERROR:エラー
master	(in)	検索の指定がラベルに対する検索か、コードに対する検索かを指定 NAVI_LABEL: ラベル NAVI_CODE : コード（マスタ型のみ有効）
key	(in)	検索する文字列
search	(in)	検索方法の指定 NAVI_ALL : すべてのカテゴリ NAVI_COMPLETE : 指定された文字列と完全に一致するカテゴリ NAVI_FROMSTART: 先頭が指定された文字列と一致するカテゴリ NAVI_PARTIAL : 指定された文字列とどこかが一致するカテゴリ NAVI_FROMEND : 末尾が指定された文字列と一致するカテゴリ NAVI_NOLOAD : 指定した文字列を読み込んだものとみなす
nonmatch	(in)	一致するカテゴリを読み込むか、一致しないカテゴリを読み込むかを指定 NAVI_MATCH : 一致するカテゴリを読み込む NAVI_NONMATCH : 一致しないカテゴリを読み込む
reserve	(in)	将来拡張のために用意したパラメタ必ず空文字列“”を指定してください

エラーの詳細コード

詳細コード	意味
NAVI_ERROR_TYPE	扱えない型の管理ポイントが指定された
NAVI_ERROR_ZERO	カテゴリが0件
NAVI_ERROR_OVER8000	カテゴリが8000件を超過
NAVI_ERROR_NOSUPPORT	サポート外の機能範囲が指定されている
NAVI_ERROR	その他のエラー

説明

すでに読み込まれているカテゴリを1回破棄し、検索条件を指定して、サーバ（辞書）からカテゴリを読み込みなおします。パラメタsearch にNAVI_NOLOADを指定した場合は、サーバ（辞書）にアクセスしません。

本関数は、マスタ型、カテゴリ型、全値型、および範囲型の管理ポイントに対してだけ有効です。それ以外の管理ポイントが指定された場合はエラーとなります。

読み込みを行う際は、コードとラベルの両方が読み込まれます。

再読み込みするカテゴリがコードで数値型の場合、パラメタsearch に指定できるのは、NAVI_ALLとNAVI_COMPLETEだけです。それ以外を指定するとエラーとなります。

パラメタkey に複数の文字列を指定する場合は、カンマで区切って指定してください。

パラメタsearch にNAVI_NOLOADが指定できるのは全値型管理ポイントの場合だけです。それ以外の管理ポイントに対して指定するとエラーとなります。

範囲型およびカテゴリ型の管理ポイントの場合、パラメタsearch にはNAVI_ALLを指定してください。範囲型の管理ポイントの場合、NAVI_ALL以外を指定するとエラーとなります。

カテゴリ型の管理ポイントの場合、NAVI_ALL以外の指定は無効になります。

パラメタsearch にNAVI_ALLが指定された場合、パラメタkey およびパラメタnonmatch の値は無視されます。パラメタsearch にNAVI_NOLOADが指定された場合、パラメタnonmatch の値は無視されます。

カテゴリの数が0個の場合、および8000個を超えた場合はエラーとなります。

管理ポイントのハンドルはNaviGetControlPoint で取得してください。それ以外の不正なハンドルを使用した場合、アプリケーションは予期しない振る舞いをします。

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

『CSVファイル、またはShunsaku利用時の注意事項』

作成元のデータがCSVファイル、またはShunsaku上にある場合に、以下の条件を満たす時は、searchにNAVI_FROMSTART、またはNAVI_FROMENDを指定するとエラーとなります。詳細コードには、NAVI_ERROR_NOSUPPORTが返却されます。

管理ポイントがマスタ型

※旧バージョンの詳細コード「NAVI_ERROR_SHUNSAKU」は、Shunsakuを利用する場合に、互換用コードとして利用できます。