SFBResourceCtl

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

#include <SFBResourceCtl.h.hpp>

class SFBResourceCtl : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBResourceCtl)

継承図

バージョン

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

参照

BREW API IResourceCtl

メンバ

パブリック関数
`SFCError`	Acquire( `UInt32` reason , `UInt32Ptr` status ) リソースの制御権を取得します。
`UInt32`	Acquire( `UInt32` reason ) リソースの制御権を取得します。
`SFCError`	CanAcquire( `UInt32` reason , `UInt32Ptr` status ) コール側がリソースを制御できるかどうかを問い合わせます。
`UInt32`	CanAcquire( `UInt32` reason ) コール側がリソースを制御できるかどうかを問い合わせます。
`SFCError`	Free( `UInt32Ptr` status ) リソースを開放します。
`UInt32`	Free( `Void` ) リソースを開放します。
`UInt32`	GetStatus( `UInt32Ptr` status ) リソースの現在の所有権のステータスを取得します。
`UInt32`	GetStatus( `Void` ) リソースの現在の所有権のステータスを取得します。
`SFCError`	OnStatusChangeNotify( `UInt32` statusMask , `SFXCallbackPtr` callback ) リソースのステータスが変わった場合に、コール側がコールバックを受信できるようにします。
`SFCError`	SetRelinquishCtl( `AEECLSID*` clsidList , `SInt32` count ) 他のリクエスタからリソース確保の要求があった場合にリソースを明け渡すことを許可するかどうかの判断を行う条件群を、ClassID、グループ ID、および RESCTL_REASON のリストの形式で設定します。
`SFCError`	SetRelinquishCtlAll( `Void` ) リクエスタに無条件でリソースの取得を許可するよう、制御の移行リストを設定します。
`SFCError`	SetRelinquishCtlNone( `Void` ) リクエスタによるリソースの取得を禁止するための制御の移行リストを設定します。
`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 インスタンスを使用して生成します。

SFBResourceCtl::Acquire

リソースの制御権を取得します。

[ public ]
SFCError Acquire(
    UInt32 reason      // リソースを要求または保持する理由
    UInt32Ptr status   // リソースの現在の RESCTL_STATUS
);

[ public ]
UInt32 Acquire(
    UInt32 reason   // リソースを要求または保持する理由
);

戻り値

成功したとき: SFERR_NO_ERROR
失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IRESOURCECTL_Acquire | SFBResourceCtl::Free

SFBResourceCtl::CanAcquire

コール側がリソースを制御できるかどうかを問い合わせます。

[ public ]
SFCError CanAcquire(
    UInt32 reason      // リソースを要求または保持する理由
    UInt32Ptr status   // リソースの現在の RESCTL_STATUS
);

[ public ]
UInt32 CanAcquire(
    UInt32 reason   // リソースを要求または保持する理由
);

戻り値

成功したとき: SFERR_NO_ERROR
失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IQOSFLOW_CanAcquire | SFBResourceCtl::Free

SFBResourceCtl::Free

リソースを開放します。

[ public ]
SFCError Free(
    UInt32Ptr status   // リソースの現在の RESCTL_STATUS
);

[ public ]
UInt32 Free(Void);

戻り値

成功したとき: SFERR_NO_ERROR
失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IRESOURCECTL_Free | SFBResourceCtl::Acquire

SFBResourceCtl::GetStatus

リソースの現在の所有権のステータスを取得します。

[ public ]
UInt32 GetStatus(
    UInt32Ptr status   // SFBResourceCtl::Acquire() または SFBResourceCtl::CanAcquire() で指定されている最後の RESCTL_REASON_XXX を指す
);

[ public ]
UInt32 GetStatus(Void);

戻り値

リソースの現在の RESCTL_STATUS を返します。

参照

BREW API IRESOURCECTL_GetStatus | SFBResourceCtl::Acquire | SFBResourceCtl::CanAcquire

SFBResourceCtl::OnStatusChangeNotify

リソースのステータスが変わった場合に、コール側がコールバックを受信できるようにします。

[ public ]
SFCError OnStatusChangeNotify(
    UInt32 statusMask         // RESCTL_STATUS マスク
    SFXCallbackPtr callback   // SFXCallback へのポインタ
);

戻り値

成功したとき: SFERR_NO_ERROR
失敗したとき: AEEError.h で定義されているエラー値

解説

コール側は、通知を引き続き受信するために各コールバックごとに再登録する必要があります。

参照

BREW API IRESOURCECTL_OnStatusChangeNotify

SFBResourceCtl::SetRelinquishCtl

他のリクエスタからリソース確保の要求があった場合にリソースを明け渡すことを許可するかどうかの判断を行う条件群を、ClassID、グループ ID、および RESCTL_REASON のリストの形式で設定します。

[ public ]
SFCError SetRelinquishCtl(
    AEECLSID* clsidList   // クラス/特権/理由リストへのポインタ
    SInt32 count          // clsidList の要素数
);

戻り値

成功したとき: SFERR_NO_ERROR
失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IRESOURCECTL_SetRelinquishCtl | SFBResourceCtl::Acquire | SFBResourceCtl::SetRelinquishCtlAll | SFBResourceCtl::SetRelinquishCtlNone

SFBResourceCtl::SetRelinquishCtlAll

リクエスタに無条件でリソースの取得を許可するよう、制御の移行リストを設定します。

[ public ]
SFCError SetRelinquishCtlAll(Void);

戻り値

成功したとき: SFERR_NO_ERROR
失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IRESOURCECTL_SetRelinquishCtlAll | SFBResourceCtl::Acquire | SFBResourceCtl::SetRelinquishCtl

SFBResourceCtl::SetRelinquishCtlNone

リクエスタによるリソースの取得を禁止するための制御の移行リストを設定します。

[ public ]
SFCError SetRelinquishCtlNone(Void);

戻り値

成功したとき: SFERR_NO_ERROR
失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IRESOURCECTL_SetRelinquishCtlNone | SFBResourceCtl::Acquire | SFBResourceCtl::SetRelinquishCtl