SFBFlip

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

#include <SFBFlip.h.hpp>

class SFBFlip : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBFlip)

継承図

バージョン

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

参照

BREW API IFlip

メンバ

パブリック関数
`SFCError`	GetDisplayList( `AEECLSID *` clslist , `SInt16Ptr` count ) すべてのフリップの現在位置に基づき、ユーザーにアクセス可能なディスプレイのディスプレイ ClassID を取得します。
`SFCError`	GetFlipIDList( `AEEFlipInfo *` infolist , `SInt16Ptr` count ) デバイス上に存在するフリップのフリップ ID を取得します。
`SFCError`	GetFlipInfoEx( `AEEFlipInfoEx *` infoEx ) AEEFlipInfox 構造体内の指定されたフリップの情報を取得します。
`SFCError`	GetFlipPosition( `AEEFlipInfo *` info ) この関数は指定された現在の蓋開閉位置を返します。
`SFCError`	GetKeyList( `AVKType *` keylist , `SInt16Ptr` count ) すべてのフリップの現在位置に基づき、ユーザーにアクセス可能なキーのキーコードを取得する。
`SFCError`	GetMaxFlipPosition( `AEEFlipInfo *` info ) 指定されている蓋開閉に可能な最大位置、つまり、完全に開いたときの蓋開閉位置を返します。
`SFCError`	GetMinFlipPosition( `AEEFlipInfo *` info ) 指定されている蓋に可能な最小位置、つまり、完全に閉じたときの蓋の位置を返します
`SFCError`	GetParm( `AEEFlipInfo *` info , `SInt16` parmID , `SInt32Ptr` p1 , `SInt32Ptr` p2 ) 蓋開閉位置パラメータ情報を取得します。蓋開閉位置パラメータは、nParmID argument で指定する必要があります。
`SFCError`	IsSupport( `AEEFlipInfo *` info , `SInt16` parmID , `BoolPtr` support ) 指定したフリップパラメータ (FLIP_PARM_XXX) が IFlip インタフェースでサポートされているかどうかをチェックします。
static `SFBFlipSmp`	NewInstance( `SFCErrorPtr` exception = null ) SFBFlip インスタンスを生成します。
static `SFBFlipSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) SFBFlip インスタンスを生成します。
`SFCError`	SetParm( `AEEFlipInfo *` info , `SInt16` parmID , `SInt32` p1 , `SInt32` p2 ) 蓋開閉位置パラメータ情報を設定します。
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`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 インスタンスを使用して生成します。

SFBFlip::GetDisplayList

すべてのフリップの現在位置に基づき、ユーザーにアクセス可能なディスプレイのディスプレイ ClassID を取得します。

[ public ]
SFCError GetDisplayList(
    AEECLSID * clslist   // AEECLSID の配列へのポインタ。NULL も可能
    SInt16Ptr count      // コール側が、pClsList で渡される AEECLSID の配列のサイズを示す
);

引数

clslist: この関数が SUCCESS を返し、pClsList が NULL 以外の場合は、アクセス可能なディスプレイのディスプレイ ClassID が含まれる。
count: この関数が SUCCESS を返した場合、このパラメータにはアクセス可能なディスプレイの数が含まれる。

戻り値

SUCCESS: 正常終了の場合
EBADPARM: パラメータが無効。
EBUFFERTOOSMALL: コール側が指定したバッファが小さ過ぎる。
EFAILED: その他のエラー。

解説

各種のディスプレイ ClassID については、SFBDisplay インタフェースのドキュメントを参照してください。

参照

BREW API IFLIP_GetDisplayList | SFBDisplay

SFBFlip::GetFlipIDList

デバイス上に存在するフリップのフリップ ID を取得します。

[ public ]
SFCError GetFlipIDList(
    AEEFlipInfo * infolist   // AEEFlipInfo 構造体の配列へのポインタ、NULL も可能
    SInt16Ptr count          // コール側が、pFlipInfoList で渡される AEEFlipInfo 構造体の配列のサイズを示す
);

引数

infolist: この関数が SUCCESS を返し、pFlipInfoList が NULL 以外の場合は、デバイス上に存在するフリップのフリップ ID が含まれる。
count: この関数が SUCCESS または EBUFFERTOOSMALL を返した場合、pnCount にはデバイス上のフリップの数が含まれ、これは常にゼロ以外の正の数。

戻り値

SUCCESS: 正常終了の場合
EBADPARM: 引数が無効。
EFAILED: その他のエラー。
EBUFFERTOOSMALL: 渡された pFlipInfoList の配列サイズが、デバイス上に存在するフリップの数よりも小さい場合。

参照

BREW API IFLIP_GetFlipIDList

SFBFlip::GetFlipInfoEx

AEEFlipInfox 構造体内の指定されたフリップの情報を取得します。

[ public ]
SFCError GetFlipInfoEx(
    AEEFlipInfoEx * infoEx   // AEEFlipInfoEx 構造体へのポインタ
);

戻り値

SUCCESS: 正常終了の場合。
EBADPARM: 引数が無効。
EFAILED: その他のエラー。
EVERSIONNOTSUPPORT: 供給した wStructSize がサポートされていない場合。

参照

BREW API IFLIP_GetFlipInfoEx

SFBFlip::GetFlipPosition

この関数は指定された現在の蓋開閉位置を返します。

[ public ]
SFCError GetFlipPosition(
    AEEFlipInfo * info   // AEEFlipInfo 構造体へのポインタコール側がフリップ ID フィールドに入力する
);

戻り値

SUCCESS: 正常終了の場合。
EBADPARM: 無効な引数。
EUNSUPPORTED: フリップ ID が無効な場合。
EFAILED: 失敗の場合。

参照

BREW API IFLIP_GetFlipPosition

SFBFlip::GetKeyList

すべてのフリップの現在位置に基づき、ユーザーにアクセス可能なキーのキーコードを取得する。

[ public ]
SFCError GetKeyList(
    AVKType * keylist   // AVKType の配列へのポインタ、NULL も可能
    SInt16Ptr count     // コール側が、pKeyList で渡される AVKType の配列のサイズを示す
);

引数

keylist: この関数が SUCCESS を返し、pKeyList が NULL 以外の場合は、指定されたフリップの現在位置に基づき、アクセス可能なキーのキーコードが含まれる。
count: この関数が SUCCESS または EBUFFERTOOSMALL を返した場合、この引数には、指定されたフリップの現在位置に基づき、アクセス可能なキーの数が含まれる。

戻り値

SUCCESS: 正常終了の場合。
EBADPARM: 引数が無効。
EUNSUPPORTED: フリップ ID が無効な場合。
EFAILED: その他のエラー。

解説

キーコードの全列挙ついては、AEEVcodes.h を参照してください。

参照

BREW API IFLIP_GetKeyList

SFBFlip::GetMaxFlipPosition

指定されている蓋開閉に可能な最大位置、つまり、完全に開いたときの蓋開閉位置を返します。

[ public ]
SFCError GetMaxFlipPosition(
    AEEFlipInfo * info   // AEEFlipInfo 構造体へのポインタコール側がフリップ ID フィールドに入力する
);

戻り値

SUCCESS: 正常終了の場合。
EBADPARM: 無効な引数。
EUNSUPPORTED: フリップ ID が無効な場合。
EFAILED: 失敗の場合。

参照

BREW API IFLIP_GetMaxFlipPosition

SFBFlip::GetMinFlipPosition

指定されている蓋に可能な最小位置、つまり、完全に閉じたときの蓋の位置を返します

[ public ]
SFCError GetMinFlipPosition(
    AEEFlipInfo * info   // AEEFlipInfo 構造体へのポインタコール側がフリップ ID フィールドに入力する
);

戻り値

SUCCESS: 正常終了の場合。
EBADPARM: 無効な引数。
EUNSUPPORTED: フリップ ID が無効な場合。
EFAILED: 失敗の場合。

参照

BREW API IFLIP_GetMinFlipPosition

SFBFlip::GetParm

蓋開閉位置パラメータ情報を取得します。蓋開閉位置パラメータは、nParmID argument で指定する必要があります。

[ public ]
SFCError GetParm(
    AEEFlipInfo * info   // AEEFlipInfo 構造体へのポインタコール側がフリップ ID フィールドに入力する
    SInt16 parmID        // FLIP_PARM_XXXを参照
    SInt32Ptr p1         // parmID に依存
    SInt32Ptr p2         // parmID に依存
);

戻り値

SUCCESS: 正常終了した場合。
EBADPARM: (関数の引数中に)不正パラメータ。 NULL が予想されていたときに、pFlipInfo が NULL でない。
EUNSUPPORTED: IFLIP_GetParm がこの nParmID に対してサポートされていない（または）フリップ ID が無効 (または) nParmID がこのクラスでサポートされていない。
EBUFFERTOOSMALL: コール側によって指定されたバッファが小さすぎる。
EFAILED: 一般的なエラー。

参照

BREW API IFLIP_GetParm | BREW API FLIP_PARM_

SFBFlip::IsSupport

指定したフリップパラメータ (FLIP_PARM_XXX) が IFlip インタフェースでサポートされているかどうかをチェックします。

[ public ]
SFCError IsSupport(
    AEEFlipInfo * info   // AEEFlipInfo 構造体へのポインタ。コール側がフリップ ID フィールドを設定する
    SInt16 parmID        // FLIP_PARM_XXX フリップパラメータを参照
    BoolPtr support      // TRUE/FALSE => サポートあり/サポートなし
);

戻り値

SUCCESS: 正常終了した場合。
EBADPARM: (関数引数内に) 不正パラメータ。NULL が期待される場所に NULL 以外の pFlipInfo。
EUNSUPPORTED: pFlipInfo 内に無効なフリップ ID (pFlipInfo が NULL 以外の場合)。
EFAILED: 一般的なエラー。

参照

BREW API IFLIP_IsSupport

SFBFlip::NewInstance

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

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

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

SFBFlip::SetParm

蓋開閉位置パラメータ情報を設定します。

[ public ]
SFCError SetParm(
    AEEFlipInfo * info   // AEEFlipInfo 構造体へのポインタコール側がフリップ ID フィールドに入力する。
    SInt16 parmID        // FLIP_PARM_XXX フリップパラメータを参照
    SInt32 p1            // parmID に依存
    SInt32 p2            // parmID に依存
);

戻り値

SUCCESS: 正常終了した場合。
EBADPARM: (関数の引数中に)不正パラメータ。 NULL が予想されていたときに、pFlipInfo が NULL でない。
EUNSUPPORTED: IFLIP_SetParm がこの nParmID に対してサポートされていない（または）フリップ ID が無効 (または) nParmID がこのクラスでサポートされていない。
EFAILED: 一般的なエラー。

参照

BREW API IFLIP_SetParm