nlib
nn::nlib::exi::ExiErrorStatus クラスfinal

XMLパーサーのエラー状態を設定・格納します。 [詳解]

#include "nn/nlib/exi/ExiErrorStatus.h"

公開型

enum  ErrorValue {
  OK = 0,
  OUT_OF_MEMORY,
  ARGUMENT_ERROR,
  IO_ERROR,
  UNEXPECTED_EOS,
  STREAM_DETACHED,
  ILLEGAL_CHARACTER,
  INTERNAL_ERROR,
  NOT_SUPPORTED,
  DUPLICATE_ATTRIBUTE,
  RESERVED_PREFIX,
  UNDECLARING_PREFIX,
  ATTRIBUTE_DEFAULT_NS,
  ILLEGAL_COMMENT,
  ILLEGAL_PI,
  ILLEGAL_BINARY,
  ILLEGAL_BINARY_IDX,
  ILLEGAL_BINARY_EVT,
  SYNTAX_ERROR,
  ILLEGAL_BINARY_HDR,
  FUNC_NOT_AVAILABLE
}
 エラー状態を示す列挙型です。 [詳解]
 

公開メンバ関数

 ExiErrorStatus () noexcept
 コンストラクタです。
 
ErrorValue GetError () const noexcept
 エラー状態を示す値を取得します。 [詳解]
 
int GetLineNo () const noexcept
 エラーを発生させたコードの行番号を返します。
 
const char * GetFileName () const noexcept
 エラーを発生させたコードのファイル名を返します。 [詳解]
 
bool SetError (ErrorValue e, int line, const char *filename) noexcept
 エラーを設定します。 [詳解]
 
void Reset () noexcept
 エラー状態をリセットします。通常利用しません。
 
 operator bool () const
 エラーが発生していなければtrueを返します。
 

詳解

XMLパーサーのエラー状態を設定・格納します。

ExiErrorStatus.h17 行目に定義があります。

列挙型メンバ詳解

§ ErrorValue

エラー状態を示す列挙型です。

説明
どのようなエラーが発生したかについて参考となる情報です。 この値がOK以外の場合は、読み出し又は書き出しが失敗していることを示します。
列挙値
OK 

エラーはありません。

OUT_OF_MEMORY 

メモリの確保に失敗しました。

ARGUMENT_ERROR 

引数が不正でした

IO_ERROR 

IOがエラーを起こしました。

UNEXPECTED_EOS 

想定外のEOSを検出しました。

STREAM_DETACHED 

ストリームが取り外されています(クローズされている)。

ILLEGAL_CHARACTER 

不正な文字の読み書きをしようとしました。

INTERNAL_ERROR 

内部エラー

NOT_SUPPORTED 

サポートされていない機能やフォーマットです。

DUPLICATE_ATTRIBUTE 

属性が重複しています。

RESERVED_PREFIX 

予約されたプレフィックスであるxml又はxmlnsを宣言しようとしました。

UNDECLARING_PREFIX 

prefixを削除(undeclare)しようとしました。

ATTRIBUTE_DEFAULT_NS 

属性の名前空間をデフォルト名前空間にすることはできません。

ILLEGAL_COMMENT 

不正なコメントです。

ILLEGAL_PI 

不正なPIです。

ILLEGAL_BINARY 

不正なバイナリデータの可能性があります。

ILLEGAL_BINARY_IDX 

不正なバイナリデータの可能性があります。インデックスがあるべき範囲を超えています。

ILLEGAL_BINARY_EVT 

不正なバイナリデータの可能性があります。指定されたイベントが不正であるか見つかりませんでした。

SYNTAX_ERROR 

各種シンタックスエラーです。

ILLEGAL_BINARY_HDR 

不正なバイナリデータの可能性があります。 EXIヘッダの解析中にエラーになりました。 不正なデータであるか、exiライブラリがサポートしていないオプションが指定されている可能性があります。

FUNC_NOT_AVAILABLE 

呼び出すことのできる状態でないAPIを呼び出しました。 XML宣言を書きこむ前にタグをオープンする関数を呼び出す等、呼び出せる状態でないAPIを呼び出しました。

ExiErrorStatus.h19 行目に定義があります。

関数詳解

§ GetError()

nn::nlib::exi::ExiErrorStatus::GetError ( ) const
inlinenoexcept

エラー状態を示す値を取得します。

戻り値
ErrorValue型の値

ExiErrorStatus.h45 行目に定義があります。

§ GetFileName()

nn::nlib::exi::ExiErrorStatus::GetFileName ( ) const
inlinenoexcept

エラーを発生させたコードのファイル名を返します。

戻り値
ソースコードのファイル名

ExiErrorStatus.h47 行目に定義があります。

§ SetError()

nn::nlib::exi::ExiErrorStatus::SetError ( ErrorValue  e,
int  line,
const char *  filename 
)
noexcept

エラーを設定します。

引数
[in]eエラー値
[in]line行番号
[in]filenameファイル名
戻り値
指定されたエラー状態が設定された場合はtrue
説明
通常XMLパーサー内部でNEXI_SET_ERRORマクロを利用することで呼び出されます。 既にエラー状態の場合はエラーは設定されず、falseを返します。

このクラス詳解は次のファイルから抽出されました: