5.4.1 NaviGetControlPoint

機能

管理ポイントのハンドルを取得する。

書式

[Excelを使用する場合]

NaviGetControlPoint( ByVal hCatalog As Long , rc As Long , ByVal label As String , ByVal locate As Long , ByVal order As Long ) As Long

[Visual Basicを使用する場合]

NaviGetControlPoint( ByVal hCatalog As Integer , ByRef rc As Integer , ByVal label As String , ByVal locate As Integer , ByVal order As Integer ) As Integer

パラメタ

hCatalog	(in)	問い合わせファイルのハンドル
rc	(out)	返却コード NAVI_OK:正常終了 NAVI_ERROR:エラー
label	(in)	管理ポイントの問い合わせファイル上で表示される項目名
locate	(in)	取得する管理ポイントがおかれている場所 NAVI_ALL :表側、表頭、条件の順に検索 NAVI_SIDE: 表側 NAVI_HEAD: 表頭 NAVI_COND: 条件
order		同じ項目名が複数存在した場合の、上（左）から探して何個目に見つかったかを、1つ目を0として指定

返り値

管理ポイントのハンドル

エラーの詳細コード

詳細コード	意味
NAVI_ERROR_CONTROLPOINT	管理ポイントの取得に失敗
NAVI_ERROR	その他のエラー

説明

管理ポイントのハンドルを取得します。

問い合わせファイル作成時に項目名を変更した場合は、変更後の項目名が対象となります。

同じ項目名を持つ管理ポイントが存在した場合に、パラメタlocate 、パラメタorder の情報を用いて管理ポイントを特定します。

問い合わせが複数のレポートを含む場合、本関数はアクティブなページを対象として動作します。ページをアクティブにするにはNaviSetActiveDocPage を用いてください。

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

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