Interstage Navigator ServerV9.6.0 Navigator APIプログラマーズガイド(Visual Basic編)

5.5.1 NaviGetDataItem

機能

データ項目のハンドルを取得する。

書式

[Excelを使用する場合]

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

[Visual Basicを使用する場合]

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

パラメタ

hCatalog	(in)	問い合わせファイルのハンドル
rc	(out)	返却コード NAVI_OK:正常終了 NAVI_ERROR:エラー
locate	(in)	取得するデータ項目が置かれている場所 NAVI_COND: 条件 NAVI_DATA: データ項目
label	(in)	データ項目の項目名
order	(in)	同じ項目名のデータ項目が複数存在した場合の、左から数えた番号を、1個目を0として指定
reserve	(in)	将来拡張のために用意したパラメタ 必ず0を指定してください

返り値

データ項目へのハンドル

エラーの詳細コード

詳細コード	意味
NAVI_ERROR_DATAITEM	データ項目の取得に失敗
NAVI_ERROR	その他のエラー

説明

問い合わせファイル作成時に条件フィールド、あるいはデータフィールドに貼り付けたデータ項目のハンドルを取得します。

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

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

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

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

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