SFBCallHistory

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

#include <SFBCallHistory.h.hpp>

class SFBCallHistory : public SFBBase;

SFMTYPEDEFWRAPPER(SFBCallHistory)

継承図

バージョン

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

参照

BREW API ICallHistory

メンバ

パブリック関数
`SFCError`	AddEntry( `AEECallHistoryEntry const *` entry ) 現在のストレージ内にある通話履歴リストに新しいエントリを追加します。
`SFCError`	Clear( `Void` ) 現在のストレージの呼び出し履歴リストからすべてのエントリを削除します。
`SFCError`	ClearEntry( `Void` ) 最後に列挙された通話履歴エントリを削除します。
`SFCError`	EnumInit( `Void` ) 通話履歴リスト内の列挙を初期化 / リセットします。
`SFCError`	EnumInitByCallType( `UInt16` type ) 通話履歴リスト内の列挙を初期化 / リセットします。
`AEECallHistoryEntry const *`	EnumNext( `SInt32Ptr` err ) 現在のストレージ内にある通話履歴リストから次のエントリを取得します。
static `SFBCallHistorySmp`	NewInstance( `SFCErrorPtr` exception = null ) SFBCallHistory インスタンスを生成します。
static `SFBCallHistorySmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) SFBCallHistory インスタンスを生成します。
`SFCError`	Notify( `SFXCallbackPtr` callback ) 通話履歴が変更された場合にユーザーにコールバックを送るための通知関数を設定します。
`SFCError`	UpdateEntry( `AEECallHistoryEntry const *` entry ) 与えられたエントリで現在の通話履歴エントリを置き換えます。

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

SFBCallHistory::AddEntry

現在のストレージ内にある通話履歴リストに新しいエントリを追加します。

[ public ]
SFCError AddEntry(
    AEECallHistoryEntry const * entry   // 新しいエントリ
);

戻り値

成功したとき: SFERR_NO_ERROR
引数が不正なとき: SFERR_INVALID_PARAM
メモリ不足のとき: SFERR_NO_MEMORY
失敗したとき: SFERR_FAILED

解説

エントリの数が最大数に達した場合、リスト内の最も古いエントリが削除され、リストのトップに新しいエントリが追加されます。

参照

BREW API ICALLHISTORY_AddEntry

SFBCallHistory::Clear

現在のストレージの呼び出し履歴リストからすべてのエントリを削除します。

[ public ]
SFCError Clear(Void);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY
失敗したとき: SFERR_FAILED

参照

BREW API ICALLHISTORY_Clear

SFBCallHistory::ClearEntry

最後に列挙された通話履歴エントリを削除します。

[ public ]
SFCError ClearEntry(Void);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY
失敗したとき: SFERR_FAILED

バージョン

この関数は、BREW 3.1 から使用可能です。

参照

BREW API ICALLHISTORY_ClearEntry

SFBCallHistory::EnumInit

通話履歴リスト内の列挙を初期化 / リセットします。

[ public ]
SFCError EnumInit(Void);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY
失敗したとき: SFERR_FAILED

参照

BREW API ICALLHISTORY_EnumInit

SFBCallHistory::EnumInitByCallType

通話履歴リスト内の列挙を初期化 / リセットします。

[ public ]
SFCError EnumInitByCallType(
    UInt16 type   // 列挙する通話タイプ 
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY
失敗したとき: SFERR_FAILED

バージョン

この関数は、BREW 3.1 から使用可能です。

参照

BREW API ICALLHISTORY_EnumInitByCallType

SFBCallHistory::EnumNext

現在のストレージ内にある通話履歴リストから次のエントリを取得します。

[ public ]
AEECallHistoryEntry const * EnumNext(
    SInt32Ptr err   // エラー値( ある場合 )を格納する整数へのポインタ
                    // 正常終了した、または列挙の最後に達した場合は SUCCESS に、
                    // エラーが発生した場合は EFAILED かその他の BREW エラーになる
);

参照

BREW API ICALLHISTORY_EnumNext

SFBCallHistory::NewInstance

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

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

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

SFBCallHistory::Notify

通話履歴が変更された場合にユーザーにコールバックを送るための通知関数を設定します。

[ public ]
SFCError Notify(
    SFXCallbackPtr callback   // コールバック
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY
OEM がコール通知をサポートしていないとき: SFERR_UNSUPPORTED
失敗したとき: SFERR_FAILED

バージョン

この関数は、BREW 3.1 から使用可能です。

解説

コールバックはユーザーがキャンセルするまで実行継続されます。OEM によってはこの関数がサポートされない場合があります。

参照

BREW API ICALLHISTORY_Notify

SFBCallHistory::UpdateEntry

与えられたエントリで現在の通話履歴エントリを置き換えます。

[ public ]
SFCError UpdateEntry(
    AEECallHistoryEntry const * entry   // 既存のエントリを置き換える新しいデータ
);

戻り値

成功したとき: SFERR_NO_ERROR
引数が不正なとき: SFERR_INVALID_PARAM
メモリ不足のとき: SFERR_NO_MEMORY
失敗したとき: SFERR_FAILED

参照

BREW API ICALLHISTORY_UpdateEntry