前のページ次のページ上に戻るホーム BREW C++ ライブラリ & GUI フレームワーク : SophiaFramework 3.0
SFBAddrBook
IAddrBook インターフェイスのラッパークラスです。
#include <SFBAddrBook.h.hpp>
class SFBAddrBook : public SFBBase;
SFMTYPEDEFWRAPPER(SFBAddrBook)

継承図

SFBAddrBook クラスの継承図

協調図

SFBAddrBook クラスの協調図

参照

BREW API IAddrBook

メンバ

パブリック関数
SFBAddrRecSmp CreateRec( AEEAddrCat category , AEEAddrField* items , SInt32 itemCount )
アドレス レコードを作成します。
SFCError EnumCategoryInit( Void )
デバイス上のアドレスブックでサポートされているアドレスレコードのカテゴリの列挙を初期化します。
SFCError EnumFieldsInfoInit( AEEAddrCat category )
与えられたカテゴリについて、アドレスブック内でサポートされているフィールドの列挙を初期化します。
Bool EnumNextCategory( AEEAddrCat* category )
デバイス上のアドレス ブックでサポートされている次のアドレス レコード カテゴリを列挙します。
Bool EnumNextFieldsInfo( AEEAddrFieldInfo* fieldInfo )
このカテゴリでサポートされている次のフィールドを列挙します。
SFBAddrRecSmp EnumNextRec( Void )
SFBAddrBook::EnumRecInit() への前回のコール時に指定されていた検索条件に一致する次のレコードを列挙します。
SFCError EnumRecInit( AEEAddrCat category , AEEAddrFieldID fieldId , VoidPtr data , UInt16 dataSize )
EnumRecInit( AEEAddrCat category , AEEAddrFieldID fieldId , SFXBufferPtr data )
指定された検索条件に基づき、アドレスブック内のレコードの列挙を初期化します。
SFCError GetLastError( Void )
最後のアドレスブック操作で発生したエラーを返します。
UInt16 GetNumRecs( Void )
このアドレスブックに存在するアドレスレコードの数を返します。
UInt32 GetProperties( Void )
プロパティを返します。
SFBAddrRecSmp GetRecByID( UInt16 id )
指定された ID を持つアドレス レコードへのポインタを取得します。
static
SFBAddrBookSmp
NewInstance( AEECLSID clsid = AEECLSID_ADDRBOOK )
インスタンスを取得します。
SFCError RemoveAllRecs( Void )
与えられたアドレス ブックからすべてのレコードを削除します。
Void SetProperties( UInt32 properties )
プロパティを設定します。

SFBAddrBook::CreateRec
アドレス レコードを作成します。
[ public ]
SFBAddrRecSmp CreateRec(
    AEEAddrCat category   // このアドレスが属するカテゴリ。AEE_ADDR_CAT_NONE は“無関係”を意味する。
    AEEAddrField* items   // アドレスブックに入れる新しいアドレスレコード用のフィールドの配列。
    SInt32 itemCount      // フィールド配列 items 内のフィールドの数。
);

参照

BREW API IADDRBOOK_CreateRec


SFBAddrBook::EnumCategoryInit
デバイス上のアドレスブックでサポートされているアドレスレコードのカテゴリの列挙を初期化します。
[ public ]
SFCError EnumCategoryInit(Void);

参照

BREW API IADDRBOOK_EnumCategoryInit | SFBAddrBook::EnumNextCategory


SFBAddrBook::EnumFieldsInfoInit
与えられたカテゴリについて、アドレスブック内でサポートされているフィールドの列挙を初期化します。
[ public ]
SFCError EnumFieldsInfoInit(
    AEEAddrCat category   
// フィールドのサポートを列挙すべきカテゴリを指定する。
// このパラメータを AEE_ADDR_CAT_NONE に設定した場合、
// この関数はすべてのカテゴリについてサポートされている全フィールドの列挙を初期化する。
        
);

参照

BREW API IADDRBOOK_EnumFieldsInfoInit | AEEAddrCat | SFBAddrBook::EnumNextFieldsInfo


SFBAddrBook::EnumNextCategory
デバイス上のアドレス ブックでサポートされている次のアドレス レコード カテゴリを列挙します。
[ public ]
Bool EnumNextCategory(
    AEEAddrCat* category   // カテゴリ情報が格納される。
);

解説

この関数を使用する前に、SFBAddrBook::EnumCategoryInit を使って列挙を初期化する必要があります。

参照

BREW API IAddrBook_EnumNextCategory | AEEAddrCat | SFBAddrBook::EnumCategoryInit


SFBAddrBook::EnumNextFieldsInfo
このカテゴリでサポートされている次のフィールドを列挙します。
[ public ]
Bool EnumNextFieldsInfo(
    AEEAddrFieldInfo* fieldInfo   // 入力時は、AEEAddrFieldInfo 構造体への有効なポインタを
指定する。戻り値がtrue の場合、このパラメータには、
このカテゴリでサポートされている次のフィールドタイプ
の情報が格納される。
);

解説

与えられたカテゴリについて、サポートされているフィールドの情報を返します。 この関数を使用する前に、SFBAddrBook::EnumFieldsInfoInit を使って列挙を初期化する必要があります。

参照

BREW API IADDRBOOK_EnumNextFieldsInfo | AEEAddrFieldInfo | SFBAddrBook::EnumFieldsInfoInit


SFBAddrBook::EnumNextRec
SFBAddrBook::EnumRecInit() への前回のコール時に指定されていた検索条件に一致する次のレコードを列挙します。
[ public ]
SFBAddrRecSmp EnumNextRec(Void);

解説

この関数を呼び出す前に、SFBAddrBook::EnumRecInit 関数を呼び出す必要があります。

参照

BREW API IADDRBOOK_EnumNextRec | SFBAddrBook::EnumRecInit


SFBAddrBook::EnumRecInit
指定された検索条件に基づき、アドレスブック内のレコードの列挙を初期化します。
[ public ]
SFCError EnumRecInit(
    AEEAddrCat category      // 一致すべきカテゴリタイプ。これを AEE_ADDR_CAT_NONE に設定した場合は無視される。
    AEEAddrFieldID fieldId   
// 一致すべきAEEAddrFieldID。
// これをAEE_ADDRFIELD_NONE に設定した場合は無視される。
// ここでフィールドを指定する前に、アドレスブックがこのフィールドに基づく検索を許可しているかチェックする必要がある。
// これには、関数 IADDRBOOK_EnumFieldsInfoInit() と IADDRBOOK_EnumNextFieldsInfo() を使用する。
        
    VoidPtr data             // 非null の場合、一致すべき実際のデータを指定する。NULL の場合は無視される。
    UInt16 dataSize          // sizeof(pData) を指定する。
);
[ public ]
SFCError EnumRecInit(
    AEEAddrCat category      // 一致すべきカテゴリタイプ。これを AEE_ADDR_CAT_NONE に設定した場合は無視される。
    AEEAddrFieldID fieldId   
// 一致すべき AEEAddrFieldID。
// これを AEE_ADDRFIELD_NONE に設定した場合は無視される。
// ここでフィールドを指定する前に、アドレスブックがこのフィールドに基づく検索を許可しているかチェックする必要がある。
// これには、関数 IADDRBOOK_EnumFieldsInfoInit() と IADDRBOOK_EnumNextFieldsInfo() を使用する。
        
    SFXBufferPtr data        // 非null の場合、一致すべき実際のデータを指定する。NULL の場合は失敗する。
);

解説

列挙が初期化された後は、SFBAddrBook::EnumNextRec 関数を使って、 この検索条件を満たすレコードに順次アクセスできます。

参照

BREW API IADDRBOOK_EnumRecInit | AEEAddrCat | AEEAddrFieldID | SFBAddrBook::EnumNextRec | SFBAddrBook::EnumFieldsInfoInit | SFBAddrBook::EnumNextFieldsInfo


SFBAddrBook::GetLastError
最後のアドレスブック操作で発生したエラーを返します。
[ public ]
SFCError GetLastError(Void);

参照

BREW API IADDRBOOK_GetLastError


SFBAddrBook::GetNumRecs
このアドレスブックに存在するアドレスレコードの数を返します。
[ public ]
UInt16 GetNumRecs(Void);

参照

BREW API IADDRBOOK_GetNumRecs


SFBAddrBook::GetProperties
プロパティを返します。
[ public ]
UInt32 GetProperties(Void);

バージョン

この関数は、BREW 2.1 でのみ使用可能です。

参照

BREW API IADDRBOOK_GetProperties | SFBAddrBook::SetProperties


SFBAddrBook::GetRecByID
指定された ID を持つアドレス レコードへのポインタを取得します。
[ public ]
SFBAddrRecSmp GetRecByID(
    UInt16 id   // アドレスブックから取得するレコードのID
);

解説

レコードのレコード ID は、SFBAddrRec::GetRecID を使って取得できます。

参照

BREW API IADDRBOOK_GetRecById | SFBAddrRec::GetRecID


SFBAddrBook::NewInstance
インスタンスを取得します。
[ public, static ]
SFBAddrBookSmp NewInstance(
    AEECLSID clsid = AEECLSID_ADDRBOOK   
);

解説

clsid 引数には、作成する IAddressBook インスタンスのクラスIDを指定します。 BREW 2.0 では AEECLSID_ADDRBOOK のみ指定可能ですが、 BREW 2.1 では AEECLSID_RUIM も指定可能です。


SFBAddrBook::RemoveAllRecs
与えられたアドレス ブックからすべてのレコードを削除します。
[ public ]
SFCError RemoveAllRecs(Void);

解説

この関数はアドレス ブックに大きな影響を与えるため、 デバイスによってはサポートされていない場合もあります。 この関数がサポートされていない場合は、戻り値として EUNSUPPORTED が返されます。

参照

BREW API IADDRBOOK_RemoveAllRecs


SFBAddrBook::SetProperties
プロパティを設定します。
[ public ]
Void SetProperties(
    UInt32 properties   // プロパティ
);

バージョン

この関数は、BREW 2.1 でのみ使用可能です。

参照

BREW API IADDRBOOK_SetProperties | SFBAddrBook::GetProperties