ページの先頭行へ戻る
Interstage Navigator ServerV9.5.0 Navigator APIプログラマーズガイド(Visual C++編)
FUJITSU Software

5.3.17 CSymNaviDoc::GetControlPoint

書式

CControlPoint * GetControlPoint( const CString & label , int locate , int order )

throw( CSymNaviException )

パラメタ

label

(in)

管理ポイントの問い合わせファイル上で表示される見出し

Locate

(in)

取得する管理ポイントがおかれている場所

  • NAVI_ALL: 表側、 表頭, 条件の順で検索

  • NAVI_SIDE: 表側

  • NAVI_HEAD: 表頭

  • NAVI_COND: 条件

Order

(in)

同じ項目名が複数存在した場合の、上(左)から数えた番号を、1個目を0として指定

返り値

管理ポイントのオブジェクトへのポインタ

例外

読み込みに失敗した場合、CSymNaviExceptionオブジェクトを返却します。

例外詳細コード

詳細コード

意味

NAVI_ERROR_CONTROLPOINT

管理ポイントの取得に失敗

説明

管理ポイントのオブジェクト(CControlPoint クラス)へのポインタを取得します。

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

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

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

エラーメッセージは、CSymNaviException::GetErrorMessage を用いて取得できます。

エラー例外詳細コードは、CSymNaviException::GetReturnCode を用いて取得できます。