前のページ次のページ上に戻るホーム BREW C++ ライブラリ & GUI フレームワーク & XML ミドルウェア : SophiaFramework 4.1
SFBAppHistory
IAppHistory インターフェースのラッパークラスです。
#include <SFBAppHistory.h.hpp>
class SFBAppHistory : public SFBQuery;
SFMTYPEDEFWRAPPER(SFBAppHistory)

継承図

SFBAppHistory クラスの継承図

バージョン

BREW 2.0 BREW 2.1 BREW 3.0 BREW 3.1
× × ×

参照

BREW API IAppHistory

メンバ

パブリック関数
SFCError Back( Void )
SFBAppHistory を履歴リスト内の前回の履歴エントリ、つまり最前面から 1 つ後方に移動します。
SFCError Current( SInt32Ptr idx )
SFBAppHistory のインスタンスが履歴リスト内のどの位置を指しているか判別します。
SFCError Forward( Void )
SFBAppHistory を履歴リスト内の次回の履歴エントリ、つまり最前面に 1 つ前方に移動します。
SFCError GetArgs( ACharPtr dest , SInt32Ptr size )
GetArgs( SFXAnsiStringPtr dest )
履歴エントリの起動引数文字列を取得します。
SFCError GetClass( AEECLSID* clsid )
SFBAppHistory が指しているアプリケーション履歴エントリの AEECLSID を取得します。
AEECLSID GetClass( Void )
SFBAppHistory が指しているアプリケーション履歴エントリの AEECLSID を取得します。
SFCError GetData( ACharConstPtr name , VoidPtr buf , SInt32Ptr size )
GetData( SFXAnsiStringConstRef name , SFXBufferPtr buf )
SFBAppHistory::SetData への前のコールで格納された、指定の入力名に関連付けられた履歴コンテキスト依存データを取得します。
SFCError GetReason( UInt32Ptr reason )
履歴エントリに関連付けられた起動理由を取得します。
SFCError GetResumeData( VoidPtr buf , SInt32Ptr size )
GetResumeData( SFXBufferPtr buf )
null を指定した、SFBAppHistory::GetData へのマクロ コールです。
SFCError Insert( AEECLSID clsid , ACharConstPtr args )
Insert( AEECLSID clsid , SFXAnsiStringConstRef args )
新しい履歴エントリをカレントエントリのすぐ "後ろ" に挿入します。
SFCError Move( SInt32 idx )
履歴 エントリを新しい位置に移動します。
static
SFBAppHistorySmp
NewInstance( Void )
SFBAppHistory クラスのインスタンスを生成します。
SFCError Remove( Void )
アプリケーション履歴リストからカレント エントリを削除します。
SFCError SetData( ACharConstPtr name , VoidPtr buf , SInt32 size )
SetData( SFXAnsiStringConstRef name , SFXBufferPtr buf )
入力名に関連付けられた履歴コンテキスト依存データを格納します。
SFCError SetReason( UInt32 reason )
履歴エントリに関連付けられた起動理由を設定します。
SFCError SetResumeData( VoidPtr buf , SInt32 size )
SetResumeData( SFXBufferPtr buf )
null を指定した、SFBAppHistory::SetData へのマクロ コールです。
SFCError Top( Void )
最前面のエントリを指すように、SFBAppHistory をリセットします。
SFCError QueryInterface( AEECLSID clsid , VoidHandle handle ) (SFBQuery から継承)
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 から継承)
オブジェクトを単一インターフェースで実装するときに使います。

SFBAppHistory::Back
SFBAppHistory を履歴リスト内の前回の履歴エントリ、つまり最前面から 1 つ後方に移動します。
[ public ]
SFCError Back(Void);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 失敗したとき : SFERR_FAILED
  • 前回の履歴エントリが存在しないとき : ENOSUCH
  • カレント項目が SFBAppHistory の別のユーザーによって削除されたとき : EINVALIDITEM

参照

BREW API IAppHistory_Back | SFBAppHistory::Forward


SFBAppHistory::Current
SFBAppHistory のインスタンスが履歴リスト内のどの位置を指しているか判別します。
[ public ]
SFCError Current(
    SInt32Ptr idx   // 最前面アプリケーションからの距離が格納される
                    // エントリがリンク解除された場合、idx は -1 に設定される
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 失敗したとき : SFERR_FAILED

参照

BREW API IAppHistory_Current | SFBAppHistory::Top


SFBAppHistory::Forward
SFBAppHistory を履歴リスト内の次回の履歴エントリ、つまり最前面に 1 つ前方に移動します。
[ public ]
SFCError Forward(Void);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 失敗したとき : SFERR_FAILED
  • 次回の履歴エントリが存在しないとき : ENOSUCH
  • カレント項目が SFBAppHistory の別のユーザーによって削除されたとき : EINVALIDITEM

参照

BREW API IAppHistory_Forward | SFBAppHistory::Back


SFBAppHistory::GetArgs
履歴エントリの起動引数文字列を取得します。
[ public ]
SFCError GetArgs(
    ACharPtr dest    // 格納先バッファ
    SInt32Ptr size   // バッファのバイト単位サイズの整数へのポインター
);
[ public ]
SFCError GetArgs(
    SFXAnsiStringPtr dest   // 格納先バッファ
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • dest が null のとき : SFERR_INVALID_PARAM
  • 失敗したとき : SFERR_FAILED

参照

BREW API IAppHistory_GetArgs


SFBAppHistory::GetClass
SFBAppHistory が指しているアプリケーション履歴エントリの AEECLSID を取得します。
[ public ]
SFCError GetClass(
    AEECLSID* clsid   // カレントエントリの ClassID が格納される AEECLSID へのポインター
);
[ public ]
AEECLSID GetClass(Void);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 失敗したとき : SFERR_FAILED

参照

BREW API IAppHistory_GetClass


SFBAppHistory::GetData
SFBAppHistory::SetData への前のコールで格納された、指定の入力名に関連付けられた履歴コンテキスト依存データを取得します。
[ public ]
SFCError GetData(
    ACharConstPtr name   // データに関連付けられた名前
    VoidPtr buf          // 格納先バッファ
    SInt32Ptr size       // バッファのバイト単位サイズの整数へのポインター
);
[ public ]
SFCError GetData(
    SFXAnsiStringConstRef name   // データに関連付けられた名前
    SFXBufferPtr buf             // 格納先バッファ
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • buf が null のとき : SFERR_INVALID_PARAM
  • 失敗したとき : SFERR_FAILED
  • 特権を持っていないとき : EPRIVLEVEL

解説

SFBAppHistory::GetData 関数を buf に null を指定してコールすると、size にバッファのサイズが格納されます。

参照

BREW API IAppHistory_GetData | SFBAppHistory::SetResumeData | SFBAppHistory::SetData


SFBAppHistory::GetReason
履歴エントリに関連付けられた起動理由を取得します。
[ public ]
SFCError GetReason(
    UInt32Ptr reason   // リターン時に理由コードが格納されるバッファ
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 失敗したとき : SFERR_FAILED
  • reason が null のとき : SFERR_INVALID_PARAM
  • 特権を持っていないとき : EPRIVLEVEL

参照

BREW API IAppHistory_GetReason | SFBAppHistory::SetReason


SFBAppHistory::GetResumeData
null を指定した、SFBAppHistory::GetData へのマクロ コールです。
[ public ]
SFCError GetResumeData(
    VoidPtr buf      // 格納先バッファ
    SInt32Ptr size   // バッファのバイト単位サイズの整数へのポインター
);
[ public ]
SFCError GetResumeData(
    SFXBufferPtr buf   // 格納先バッファ
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • buf が null のとき : SFERR_INVALID_PARAM
  • 失敗したとき : SFERR_FAILED
  • 特権を持っていないとき : EPRIVLEVEL

参照

BREW API IAppHistory_GetResumeData | SFBAppHistory::GetData |


SFBAppHistory::Insert
新しい履歴エントリをカレントエントリのすぐ "後ろ" に挿入します。
[ public ]
SFCError Insert(
    AEECLSID clsid       // 要求されたアプリケーションの AEECLSID
    ACharConstPtr args   // 起動引数へのポインター
);
[ public ]
SFCError Insert(
    AEECLSID clsid               // 要求されたアプリケーションの AEECLSID
    SFXAnsiStringConstRef args   // 起動引数へのポインター
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 失敗したとき : SFERR_FAILED
  • 特権を持っていないとき : EPRIVLEVEL

解説

エントリを挿入するには、コール側が clsid のインスタンスであるか、または、PL_SYSTEM を持っていなければなりません。

参照

BREW API IAppHistory_Insert | SFBAppHistory::SetResumeData | SFBAppHistory::SetData


SFBAppHistory::Move
履歴 エントリを新しい位置に移動します。
[ public ]
SFCError Move(
    SInt32 idx   // このエントリの移動先の位置
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 引数が不正なとき : SFERR_INVALID_PARAM
  • 失敗したとき : SFERR_FAILED
  • 特権を持っていないとき : EPRIVLEVEL
  • インデックスで指定した値がカレント SFBAppHistory リストのサイズを超えるとき : ENOSUCH

参照

BREW API IAppHistory_Move | SFBAppHistory::Insert | SFBAppHistory::Remove | SFBAppHistory::Current


SFBAppHistory::NewInstance
SFBAppHistory クラスのインスタンスを生成します。
[ public, static ]
SFBAppHistorySmp NewInstance(Void);

SFBAppHistory::Remove
アプリケーション履歴リストからカレント エントリを削除します。
[ public ]
SFCError Remove(Void);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 失敗したとき : SFERR_FAILED
  • 特権を持っていないとき : EPRIVLEVEL
  • 項目が既に削除されているとき : EALREADY

参照

BREW API IAppHistory_Remove | SFBAppHistory::Top |


SFBAppHistory::SetData
入力名に関連付けられた履歴コンテキスト依存データを格納します。
[ public ]
SFCError SetData(
    ACharConstPtr name   // データに関連付けられた名前
    VoidPtr buf          // コピー先のバッファ
    SInt32 size          // データのサイズ ( バイト数 )
);
[ public ]
SFCError SetData(
    SFXAnsiStringConstRef name   // データに関連付けられた名前
    SFXBufferPtr buf             // コピー先のバッファ
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 引数が不正なとき : SFERR_INVALID_PARAM
  • メモリ不足のとき : SFERR_NO_MEMORY
  • 失敗したとき : SFERR_FAILED
  • 特権を持っていないとき : EPRIVLEVEL

参照

BREW API IAppHistory_SetData | SFBAppHistory::GetResumeData | SFBAppHistory::GetData


SFBAppHistory::SetReason
履歴エントリに関連付けられた起動理由を設定します。
[ public ]
SFCError SetReason(
    UInt32 reason   // 理由コード
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 失敗したとき : SFERR_FAILED
  • 特権を持っていないとき : EPRIVLEVEL

参照

BREW API IAppHistory_SetReason | SFBAppHistory::GetReason


SFBAppHistory::SetResumeData
null を指定した、SFBAppHistory::SetData へのマクロ コールです。
[ public ]
SFCError SetResumeData(
    VoidPtr buf   // コピー先のバッファ
    SInt32 size   // データのサイズ ( バイト数 )
);
[ public ]
SFCError SetResumeData(
    SFXBufferPtr buf   // コピー先のバッファ
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 引数が不正なとき : SFERR_INVALID_PARAM
  • メモリ不足のとき : SFERR_NO_MEMORY
  • 失敗したとき : SFERR_FAILED
  • 特権を持っていないとき : EPRIVLEVEL

参照

BREW API IAppHistory_SetResumeData | SFBAppHistory::SetData |


SFBAppHistory::Top
最前面のエントリを指すように、SFBAppHistory をリセットします。
[ public ]
SFCError Top(Void);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 失敗したとき : SFERR_FAILED

参照

BREW API IAppHistory_Top | SFBAppHistory::Forward | SFBAppHistory::Back