SFBPort

IPort インターフェースのラッパークラスです。

#include <SFBPort.h.hpp>

class SFBPort : public SFBSource;

SFMTYPEDEFWRAPPER(SFBPort)

継承図

バージョン

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
×	×	○	○

参照

BREW API IPort

メンバ

パブリック関数
`SFCError`	Close( `Void` ) 開いているポートを閉じる、または進行中の開く操作を停止します。
`SFCError`	GetLastError( `Void` ) SFBPort で発生した最後のエラーを取得します。
`SFCError`	IOCtl( `SInt32` option , `UInt32` val ) SFBPort の動作 ( 構成の設定／取得など ) に対する制御を可能にします。
static `SFBPortSmp`	NewInstance( `SFCErrorPtr` exception = null ) SFBPort インスタンスを生成します。
static `SFBPortSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) SFBPort インスタンスを生成します。
`SFCError`	Open( `ACharConstPtr` port ) 指定されたポートを開きます。
`SFCError`	Open( `SFXAnsiStringConstRef` port ) 指定されたポートを開きます。
`SInt32`	Write( `ACharConstPtr` port , `SInt32` bufSize ) 指定されたバッファからのバイトをソースストリームにコピーします。
`SInt32`	Write( `SFXAnsiStringConstRef` buf ) 指定されたバッファからのバイトをソースストリームにコピーします。
`SInt32`	Write( `SFXBufferConstRef` buf ) 指定されたバッファからのバイトをソースストリームにコピーします。
`Void`	Writeable( `SFXCallbackPtr` callback ) SFBPort::Write が AEEPORT_WAIT 以外のものを返した場合にコールされるコールバックをスケジュールします。
static `Bool`	Exhausted( `SInt32` code ) (SFBSource から継承) SFBSource、SFBPeek、または SFBGetLine がデータを処理し終えたかどうかを判定します。
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SInt32`	Read( `VoidPtr` buf , `SInt32` size ) (SFBSource から継承) 指定したバッファにソースストリームからのバイトをコピーします。
`SInt32`	Read( `SFXBufferPtr` buf ) (SFBSource から継承) 指定したバッファにソースストリームからのバイトをコピーします。
`Void`	Readable( `SFXCallbackPtr` callback ) (SFBSource から継承) SFBSource::Read 関数が ISOURCE_WAIT 以外のものを返した場合に呼び出されるコールバック関数を登録または登録解除します。
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (SFBQuery から継承) オブジェクトを単一インターフェースで実装するときに使います。
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (SFBQuery から継承) オブジェクトを単一インターフェースで実装するときに使います。

プロテクト関数
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (SFBBase から継承) 指定したクラス ID のインターフェースのインスタンスを生成します。
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (SFBBase から継承) 指定したクラス ID のインターフェースのインスタンスを指定した SFBQuery インスタンスを使用して生成します。

SFBPort::Close

開いているポートを閉じる、または進行中の開く操作を停止します。

[ public ]
SFCError Close(Void);

戻り値

成功したとき: SFERR_NO_ERROR
失敗したとき: SFERR_FAILED
ポートが開いた状態ではないとき: AEEPORT_ENOTOPEN

参照

BREW API IPORT_Close

SFBPort::GetLastError

SFBPort で発生した最後のエラーを取得します。

[ public ]
SFCError GetLastError(Void);

戻り値

AEEError.h で定義されているエラー値を返します。

参照

BREW API IPORT_GetLastError

SFBPort::IOCtl

SFBPort の動作 ( 構成の設定／取得など ) に対する制御を可能にします。

[ public ]
SFCError IOCtl(
    SInt32 option   // オプション ID
    UInt32 val      // オプション値
);

戻り値

成功したとき: SFERR_NO_ERROR
オプション ID が認識されなかったとき: SFERR_UNSUPPORTED
失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IPORT_IOCtl

SFBPort::NewInstance

SFBPort インスタンスを生成します。

[ public, static ]
SFBPortSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);

[ public, static ]
SFBPortSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // エラー値
);

SFBPort::Open

指定されたポートを開きます。

[ public ]
SFCError Open(
    ACharConstPtr port   // 開かれるポートの名前
);

[ public ]
SFCError Open(
    SFXAnsiStringConstRef port   // 開かれるポートの名前
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY
失敗したとき: SFERR_FAILED
開く操作が進行中のとき: AEEPORT_WAIT
ポートが他のエンティティによって開かれているとき: AEEPORT_EINUSE
要求したポート名がサポートされていないとき: ENOSUCH

参照

BREW API IPORT_Open

SFBPort::Write

指定されたバッファからのバイトをソースストリームにコピーします。

[ public ]
SInt32 Write(
    ACharConstPtr port   // ポートに書き込むバイトを含むバッファへのポインタ
    SInt32 bufSize       // port 内のデータのサイズ
);

[ public ]
SInt32 Write(
    SFXAnsiStringConstRef buf   // ポートに書き込むバッファへのポインタ
);

[ public ]
SInt32 Write(
    SFXBufferConstRef buf   // ポートに書き込むバッファへのポインタ
);

参照

BREW API IPORT_Write

SFBPort::Writeable

SFBPort::Write が AEEPORT_WAIT 以外のものを返した場合にコールされるコールバックをスケジュールします。

[ public ]
Void Writeable(
    SFXCallbackPtr callback   // ポートに書き込むバイトを含むバッファへのポインタ
);

参照

BREW API IPORT_Writeable