| 1行読み込みクラス CLineRead Reference |
Document generated at 2003/10/26 23:33:15
| 書式 |
CLineRead() |
| 引数 |
なし |
| 戻り値 |
なし |
| 解説 |
デフォルトコンストラクタ |
| 書式 |
CLineRead( CLineRead& rLineRead ) |
| 引数 |
CLineRead& rLineRead コピーもとへの参照 |
| 戻り値 |
なし |
| 解説 |
コピーコンストラクタ |
| 書式 |
~CLineRead() |
| 引数 |
なし |
| 戻り値 |
なし |
| 解説 |
デストラクタ |
| 書式 |
void SetDefault() |
| 引数 |
なし |
| 戻り値 |
なし |
| 解説 |
コンストラクタレベルでのデフォルト値設定 |
| 書式 |
BOOL CopyMembers( CLineRead& rLineRead ) |
| 引数 |
CLineRead& rLineRead コピーもとオブジェクトへの参照 |
| 戻り値 |
成功:TRUE 失敗:FALSE |
| 解説 |
オブジェクトの内容を複製します。 |
| 書式 |
BOOL AddToken( const char* pString ) |
| 引数 |
const char* pString |
| 戻り値 |
成功:TRUE 失敗:FALSE |
| 解説 |
内部のトークンバッファにトークンを追加します。 |
| 書式 |
void ReleaseTokens() |
| 引数 |
なし |
| 戻り値 |
なし |
| 解説 |
内部のトークンバッファを空にします。 |
| 書式 |
BOOL TokenDivide() |
| 引数 |
なし |
| 戻り値 |
成功:TRUE 失敗:FALSE |
| 解説 |
m_pString の内容をトークン分割し、m_objTokens に格納します。 |
| 書式 |
void Release() |
| 引数 |
なし |
| 戻り値 |
なし |
| 解説 |
オブジェクトの内容を破棄し、初期状態に戻します。 |
| 書式 |
BOOL Open( const char* pFileName ) |
| 引数 |
const char* pFileName オープンするファイル名 |
| 戻り値 |
成功:TRUE 失敗:FALSE |
| 解説 |
ファイルを開きます。 このメソッドで開いたファイルは、オブジェクトが破棄されるときに 閉じられます。 すでにファイルが開かれているか、ストリームの関連づけが されている場合には、エラーになります。 |
| 書式 |
BOOL Close() |
| 引数 |
なし |
| 戻り値 |
成功:TRUE 失敗:FALSE |
| 解説 |
ファイルを閉じます。 ファイルをオープンしていないときに実行すると、何もしないで FALSE を返します。(エラーログの出力も行われません。) Attach() で関連づけられたファイルは閉じることができません。 Attach() で関連づけられたファイルを閉じようとすると、 この関数は FALSE を返します。 |
| 書式 |
BOOL Attach( FILE* pStream ) |
| 引数 |
FILE* pStream ファイルストリームへのポインタ |
| 戻り値 |
成功:TRUE 失敗:FALSE |
| 解説 |
ファイルストリームを関連づけます。 既存のファイルストリームがあった場合は、エラーを返します。 この関数で関連づけられたファイルストリームは、Close() で 閉じることができません。このクラスの外側で、open と close を 管理する必要があります。 |
| 書式 |
BOOL Detach() |
| 引数 |
なし |
| 戻り値 |
成功:TRUE 失敗:FALSE |
| 解説 |
Attach() で関連づけれられたファイルを解除します。 ファイルがアタッチされていない状態で実行すると、何もしないで FALSE を返します。(エラーログも出力されません。) Open() で開かれたファイルを Detach することはできません。 |
| 書式 |
BOOL SetTokenHeader( const char* pHeader ) |
| 引数 |
const char* pHeader 比較する文字列 |
| 戻り値 |
成功:TRUE 失敗:FALSE |
| 解説 |
トークンの先頭を識別する文字群を設定します。 |
| 書式 |
BOOL SetBufferSize( long lSize ) |
| 引数 |
long lSize 1行読み込み時のバッファサイズ |
| 戻り値 |
成功:TRUE 失敗:FALSE |
| 解説 |
1行読み込み時の最大バッファサイズを指定します。 |
| 書式 |
BOOL Read( BOOL bTokenDivide = TRUE ) |
| 引数 |
BOOL bTokenDivide トークン分割を実行するか否か |
| 戻り値 |
成功の場合は TRUE エラー、もしくはEOFの場合は FALSE |
| 解説 |
Open または Attach されているファイルから1行読み込みます。 bTokenDivide が TRUE の場合は、読み込むと同時にトークン分割が 実行され、内部のバッファに保存されます。 bTokenDivide が FALSE の場合はトークン分割がかかりませんので トークン分割に関連した機能を使用することはできません。、 |
| 書式 |
long GetLine() |
| 引数 |
なし |
| 戻り値 |
読み込み行番号 |
| 解説 |
読み込み行番号を返します。 |
| 書式 |
BOOL SetLine( long lLineCount ) |
| 引数 |
long lLineCount 読み込み行番号を設定します。 |
| 戻り値 |
成功:TRUE 失敗:FALSE |
| 解説 |
読み込み行番号を設定します。 ファイルをアタッチしたときなどに、読み込み行番号の オフセットを設定したりする場合に使用します。 |
| 書式 |
long GetTokens() |
| 引数 |
なし |
| 戻り値 |
内部のバッファに格納されているトークンの数 エラーの場合は -1 |
| 解説 |
内部のバッファに格納されているトークンの数を返します。 |
| 書式 |
const char* GetToken( long lIndex ) |
| 引数 |
long lIndex トークンのインデックス番号 |
| 戻り値 |
トークン文字列 |
| 解説 |
内部のバッファに保存されているトークン文字列を返します。 トークンのインデックス番号が0から始まります。 |
| 書式 |
long GetTokenLong( long lIndex ) |
| 引数 |
long lIndex トークンのインデックス番号 |
| 戻り値 |
トークンを long として解釈した値 エラーの場合は 0 |
| 解説 |
トークンを long の値として取得します。 |
| 書式 |
double GetTokenDouble( long lIndex ) |
| 引数 |
long lIndex トークンのインデックス番号 |
| 戻り値 |
トークンを double 型として解釈した値 エラーの場合は 0.0 |
| 解説 |
トークンを double の値として取得します。 |
| 書式 |
BOOL CheckHead( const char* pString ) |
| 引数 |
const char* pString 比較する文字列 |
| 戻り値 |
一致:TRUE 不一致:FALSE |
| 解説 |
読み込んだ行が pString で始まるか否かを確認します。 トークンの比較ではなく、そのままの文字列に対して 比較が実行されます。 |
| 書式 |
const char* AfterHead( const char* pString ) |
| 引数 |
const char* pString 先頭文字列 |
| 戻り値 |
読み込んだ文字列で、先頭 pString に続く後の文字列。 エラーの場合は NULL |
| 解説 |
読み込んだ文字列で、先頭 pString に続く後の文字列を返します。 読み込んだ文字列の先頭が pString でない場合はエラーを返します。 |
| 書式 |
const char* GetString( long lOffset=0 ) |
| 引数 |
long lOffset 読み込んだ文字列に対するオフセット |
| 戻り値 |
読み込んだ文字列の、先頭から lOffset バイト以降の文字列。 エラーの場合は NULL |
| 解説 |
読み込んだ文字列の、先頭から lOffset バイト以降の文字列を 返します。 読み込んだ文字列が lOffset より短い場合はエラーを返します。 |
| 書式 |
BOOL PrintLine( FILE* pStream = stdout ) |
| 引数 |
FILE* pStream 出力先のファイルストリーム |
| 戻り値 |
成功:TRUE 失敗:FALSE |
| 解説 |
読み込んだ文字列を、そのまま pStream に出力します。 |
| 書式 |
BOOL PrintTokens( FILE* pStream = stdout ) |
| 引数 |
FILE* pStream 出力先のファイルストリーム |
| 戻り値 |
成功:TRUE 失敗:FALSE |
| 解説 |
読み込んだトークンを並べて pStream に出力します。 |
| 書式 |
CLineRead& operator=( CLineRead& rLineRead ) |
| 引数 |
CLineRead& rLineRead rLineRead |
| 戻り値 |
自分への参照 |
| 解説 |
代入演算子 |