Antenna House PDF Tool API (C++) 8.0
PdfTk::PtlParamOutput クラス

#include <PtlParamOutput.h>

PdfTk::PtlParamOutput の継承関係図
PdfTk::PtlParamOutput 連携図

公開メンバ関数

int getHandle () const
 PtlParamOutput ()
 コンストラクタ
 PtlParamOutput (const PtlParamString &path)
 コンストラクタ
 PtlParamOutput (const PtlParamString &path, const OutputStream *outStream)
 コンストラクタ
 PtlParamOutput (const PtlParamOutput &obj)
 コピーコンストラクタ
 ~PtlParamOutput ()
 デストラクタ
PtlParamOutputoperator= (const PtlParamOutput &obj)
 コピーオペレータ
bool open ()
 出力ストリームをオープン。
void close ()
 ストリームをクローズ。
int write (char *pBuf, int len)
 出力ストリームを書き込み。
const PtlParamStringgetPath ()
 パスの取得。
OutputStream & getStream () const
基底クラス PdfTk::PtlParamStream に属する継承公開メンバ関数
 PtlParamStream ()
 コンストラクタ
virtual ~PtlParamStream ()
 デストラクタ
bool canRead () const
 入力ストリームの読み込み可能かを取得。
bool canWrite () const
 出力ストリームの書き込み可能かを取得。
virtual int read (char *pBuf, int len)
 入力ストリームの読み込み。
virtual long seekoff (long off, int way, int which)
 入力ストリーム内の移動。

その他の継承メンバ

基底クラス PdfTk::PtlParamStream に属する継承限定公開変数類
bool m_canRead
bool m_canWrite

詳解

ファイルやストリームの出力指定に使うパラメータクラスです。

パス(ファイル)名を指定して、ストリームを指定しない場合、パス(ファイル)名を使って、ストリームをオープンします。
ストリームを指定した場合、パス(ファイル)名はエラーメッセージの表示などに使われる情報として扱われ、 パス(ファイル)名でストリームをオープンすることはありません。

PtlParamOutput.h24 行目に定義があります。

構築子と解体子

◆ PtlParamOutput() [1/4]

PdfTk::PtlParamOutput::PtlParamOutput ( )

コンストラクタ

例外
PtlException

◆ PtlParamOutput() [2/4]

PdfTk::PtlParamOutput::PtlParamOutput ( const PtlParamString & path)

コンストラクタ

引数
pathパス。
例外
PtlException

◆ PtlParamOutput() [3/4]

PdfTk::PtlParamOutput::PtlParamOutput ( const PtlParamString & path,
const OutputStream * outStream )

コンストラクタ

引数
pathパス。
outStreamストリーム。
例外
PtlException

◆ PtlParamOutput() [4/4]

PdfTk::PtlParamOutput::PtlParamOutput ( const PtlParamOutput & obj)

コピーコンストラクタ

引数
objコピー元オブジェクト。
例外
PtlException

関数詳解

◆ close()

void PdfTk::PtlParamOutput::close ( )
virtual

ストリームをクローズ。

例外
PtlException

PdfTk::PtlParamStreamを再実装しています。

◆ getPath()

const PtlParamString & PdfTk::PtlParamOutput::getPath ( )
virtual

パスの取得。

PdfTk::PtlParamStreamを実装しています。

◆ open()

bool PdfTk::PtlParamOutput::open ( )
virtual

出力ストリームをオープン。

戻り値
オープンできた場合はtrue
例外
PtlException

PdfTk::PtlParamStreamを実装しています。

◆ operator=()

PtlParamOutput & PdfTk::PtlParamOutput::operator= ( const PtlParamOutput & obj)

コピーオペレータ

引数
objコピー元オブジェクト。

◆ write()

int PdfTk::PtlParamOutput::write ( char * pBuf,
int len )
virtual

出力ストリームを書き込み。

引数
pBuf書き込むデータ
lenデータ長
戻り値
書き込んだ長さ
移動に失敗した時は-1

PdfTk::PtlParamStreamを再実装しています。