5.4.4 NaviGetCategory

機能

位置を指定してカテゴリを取得する。

書式

[Excelを使用する場合]

NaviGetCategory( ByVal hCPoint As Long , rc As Long , ByVal locate As Long , ByVal order As Long , ByVal master As Long , reserve As String , category As String )

[Visual Basicの場合]

NaviGetCategory( ByVal pCPoint As Integer , ByRef rc As Integer , ByVal locate As Integer , ByVal order As Integer , ByVal master As Integer , ByVal reserve As String , ByRef category As String )

パラメタ

hCPoint	(in)	管理ポイントのハンドル
rc	(out)	返却コード NAVI_OK:正常終了 NAVI_ERROR:エラー
locate	(in)	取得したいカテゴリ表側、または表頭に指定した管理ポイントの場合 NAVI_IN_DISP : 「表示する」に指定されているカテゴリ NAVI_IN_NONDISP: 「表示しない」に指定されているカテゴリ NAVI_IN_OTHERS : 「その他に含める」に指定されているカテゴリ条件に指定した管理ポイントの場合 NAVI_IN_TARGET : 「対象とする」に指定されているカテゴリ NAVI_IN_NONTARGET: 「対象としない」に指定されているカテゴリ
order	(in)	カテゴリの番号を、1個目を0として指定
master	(out)	カテゴリをラベルで返却するかコードで返却するかを指定 NAVI_LABEL: ラベル NAVI_CODE : コード（マスタ型管理ポイントに対してのみ有効）
reserve	(in)	将来拡張のために用意したパラメタ必ず空文字列“”を指定してください
category	(out)	取得するカテゴリのラベル、またはコード

エラーの詳細コード

詳細コード	意味
NAVI_ERROR_TYPE	扱えない型の管理ポイントが指定された
NAVI_ERROR_CATEGORY	カテゴリの取得に失敗
NAVI_ERROR	その他のエラー

説明

位置を指定してカテゴリのラベル、またはコードを取得します。

パラメタlocate で指定された場所の、パラメタorder で指定された位置のカテゴリを取得します。

表側、または表頭に指定してある範囲型の管理ポイントについては、カテゴリが返却されません。

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

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

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