CGReason()

なし

なし

コンストラクタ

CGReason(
      const char* pFileName
    , long        lLineNumber
    , const char* pFuncName
    , const char* pMessage
    , CGReason*   pParent );

const char* pFileName       ファイル名
long        lLineNumnber    行番号
const char* pFuncName       関数名
const char* pMessage        メッセージ
CGReason*   pParent         親原因へのポインタ

なし

初期化つきコンストラクタです。
オブジェクトを構築し、各引数の内容をオブジェクトに設定します。

CGReason( CGReason& rReason )

CGReason& rReason           コピーもとオブジェクトへの参照

なし

コピーコンストラクタ
リンクされている親原因も含め、すべて複製されます。

~CGReason()

なし

なし

デストラクタ
オブジェクトに設定された親原因も再起的に削除しますので、
リンクされたオブジェクトを別の場所から２重解放しないように
してください。

BOOL SetDefault()

なし

成功：TRUE
失敗：FALSE

オブジェクトに対して、コンストラクタレベルでの初期化を
施します。

BOOL CopyMembers( CGReason& rReason )

CGReason& rReason           コピーもとオブジェクト

成功：TRUE
失敗：FALSE

オブジェクトの内容を複製します。
接続された親原因のリンクも含め、すべて複製されます。

BOOL Initialize()

なし

成功：TRUE
失敗：FALSE

オブジェクトの内容を初期化します。
接続されている親原因のリンクについては、再起的に
すべて削除されます。

BOOL Release()

なし

成功：TRUE
失敗：FALSE

オブジェクトの内容を破棄します。

BOOL SetParent( CGReason* pParent )

CGReason* pParent           親オブジェクトへのポインタ

成功：TRUE
失敗：FALSE

親原因の情報を格納した CGReason オブジェクトをリンクに
接続します。
接続されるオブジェクトは、delete で解放できるもので
なければなりません。
接続されるオブジェクトの制御は、すべて接続先のオブジェクトに
任されなければなりません。接続したオブジェクトを個別に
削除したりすると、接続先のオブジェクト delete 時に２重解放が
発生し不具合を引き起こします。

CGReason* GetParent()

なし

親原因の情報を格納したオブジェクトへのポインタ
親が設定されていない場合には NULL

親原因の情報を格納したオブジェクトへのポインタを返します。
親が設定されていない場合には NULL を返します。

BOOL DeleteParent()

なし

成功：TRUE
失敗：FALSE

オブジェクトに接続された親原因のオブジェクトを再起的に
解放します。

BOOL SetFileName( const char* pFileName )

const char* pFileName       ファイル名

成功：TRUE
失敗：FALSE

ファイル名をセットします。

const char* GetFileName()

なし

設定されているファイル名へのポインタ

設定されているファイル名へのポインタを返します。
なにも設定されていない場合は NULL を返します。

BOOL SetLineNumber( long lLine )

long lLine                  ライン番号

成功：TRUE
失敗：FALSE

行番号を設定します。

long GetLineNumber()

なし

設定されている行番号

設定されている行番号を返します。

BOOL SetFuncName( const char* pFuncName )

const char* pFuncName       関数名

成功：TRUE
失敗：FALSE

関数名を設定します。

const char* GetFuncName()

なし

設定されている関数名へのポインタ

設定されている関数名へのポインタを返します。
なにも設定されていない場合には NULL を返します。

long AddMessage( const char* pMessage )

const char* pMessage        追加するメッセージ文字列へのポインタ

追加された文字列のインデックス番号
エラーの場合は -1

オブジェクトにメッセージ（本文）を１行追加します。
戻り値として、追加された文字列の行番号が返ります。
エラーの場合には -1 が返ります。

const char* GetMessage( long lLine )

long lLine                  行番号

文字列へのポインタ
文字列が設定されていない lLine を指定した場合には NULL

オブジェクトに設定されているメッセージを１行返します。

long GetMessageCount()

なし

オブジェクトに設定されているメッセージの数

オブジェクトに設定されているメッセージの行数を返します。

const char* GetReason()

なし

生成されたメッセージ文字列へのポインタ
関数が失敗した場合には NULL

オブジェクトに設定されている各種情報をもとに、
メッセージ文字列を構築して返します。
文字列はオブジェクト内に保存されています。使用しなくなった
時に ReleaseReason() を実行して解放すると、無駄なメモリ消費を
抑えられます。

BOOL ReleaseReason()

なし

成功：TRUE
失敗：FALSE

オブジェクト内のメッセージ用バッファを解放します。

CGReason& operator=( CGReason& rReason )

CGReason& rReason           代入もとオブジェクトへの参照

自分への参照

代入演算子

MAKE_REASON( TARGET , FUNC_NAME , MESSAGE , PARENT )

TARGET              結果のオブジェクトを受け取るポインタ
FUNC_NAME           関数名
MESSAGE             メッセージ文字列
PARENT              親オブジェクトへのポインタ（NULL可）

なし

マクロ定義。
FUNC_NAME , MESSAGE , PARENT を設定した CGReason オブジェクトを
作成し、TARGET に結果を設定します。
PARENT にオブジェクトを指定すると、PARENT を親に持った
オブジェクトを作成し、TARGET に格納します。
PARENT に NULL を指定すると、親が NULL の CGReason オブジェクト
を作成し、作成したオブジェクトを TARGET を設定します。

HANDLE_REASON( TARGET , EXEC_COMMAND )

TARGET              CGReason オブジェクトへのポインタ
EXEC_COMMAND        実行するコマンド

なし

マクロ定義。
TARGET には、関数から返ってきた CGReason オブジェクトへの
ポインタを指定します。
この関数は、EXEC_COMMAND を実行したあとに、TARGET を
delete します。
基本的に、CGReason オブジェクトの削除し忘れという
ヒューマンエラーを抑制するために存在します。

PRINT_REASON( TARGET )

TARGET              CGReason オブジェクトへのポインタ

なし

マクロ定義。
TARGET には、関数から返ってきた CGReason オブジェクトへの
ポインタを指定します。
この関数は、標準出力にレポートを出力したあとに、TARGET を
delete します。