SFBAddrBook

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

#include <SFBAddrBook.hpp>

class SFBAddrBook : public SFBBase;

typedef SFBAddrBook&          SFBAddrBookRef;
typedef SFBAddrBook*          SFBAddrBookPtr;
typedef SFBAddrBook**         SFBAddrBookHandle;
typedef const SFBAddrBook     ConstSFBAddrBook;
typedef const SFBAddrBook&    ConstSFBAddrBookRef;
typedef const SFBAddrBook*    ConstSFBAddrBookPtr;
typedef const SFBAddrBook**   ConstSFBAddrBookHandle;

継承図

参照

BREW API IAddrBook

メンバ

パブリック関数
public	AddRef (SFBBase から継承)	インターフェイスの参照カウントをインクリメントします。
public	CreateRec	アドレスレコードを作成します。
public	EnumCategoryInit	デバイス上のアドレスブックでサポートされているアドレスレコードのカテゴリの列挙を初期化します。
public	EnumFieldsInfoInit	与えられたカテゴリについて、アドレスブック内でサポートされているフィールドの列挙を初期化します。
public	EnumNextCategory	デバイス上のアドレスブックでサポートされている次のアドレスレコードカテゴリを列挙します。
public	EnumNextFieldsInfo	このカテゴリでサポートされている次のフィールドを列挙します。
public	EnumNextRec	IADDRBOOK_EnumRecInit()への前回のコール時に指定されていた検索条件に一致する次のレコードを列挙します。
public	EnumRecInit	指定された検索条件に基づき、アドレスブック内のレコードの列挙を初期化します。
public	GetLastError	最後のアドレスブック操作で発生したエラーを返します。
public	GetNumRecs	このアドレスブックに存在するアドレスレコードの数を返します。
public	GetProperties	IAddressBook インターフェイスのプロパティを返します。
public	GetRecByID	指定された ID を持つアドレスレコードへのポインタを取得します。
public static	Instance	IAddrBook インターフェイスのインスタンスを取得します。
public	Release (SFBBase から継承)	インターフェイスの参照カウントをデクリメントします。
public	RemoveAllRecs	与えられたアドレスブックからすべてのレコードを削除します。
public	SetProperties	IAddressBook インターフェイスのプロパティを設定します。

SFBAddrBook::CreateRec

アドレスレコードを作成します。

[ public ]
SFUBrewPtr<SFBAddrRec> CreateRec(
    AEEAddrCat c            
    AEEAddrField * pItems   
    SIntN nItemCount        
);

参照

BREW API IADDRBOOK_CreateRec

SFBAddrBook::EnumCategoryInit

デバイス上のアドレスブックでサポートされているアドレスレコードのカテゴリの列挙を初期化します。

[ public ]
SFCError EnumCategoryInit(Void);

参照

BREW API IADDRBOOK_EnumCategoryInit | SFBAddrBook::EnumNextCategory

SFBAddrBook::EnumFieldsInfoInit

与えられたカテゴリについて、アドレスブック内でサポートされているフィールドの列挙を初期化します。

[ public ]
SFCError EnumFieldsInfoInit(
    AEEAddrCat c   
);

参照

BREW API IADDRBOOK_EnumFieldsInfoInit | AEEAddrCat | SFBAddrBook::EnumNextFieldsInfo

SFBAddrBook::EnumNextCategory

デバイス上のアドレスブックでサポートされている次のアドレスレコードカテゴリを列挙します。

[ public ]
Bool EnumNextCategory(
    AEEAddrCat * pc   
);

[ public ]
AEEAddrCat EnumNextCategory(Void);

解説

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

参照

BREW API IAddrBook_EnumNextCategory | AEEAddrCat | SFBAddrBook::EnumCategoryInit

SFBAddrBook::EnumNextFieldsInfo

このカテゴリでサポートされている次のフィールドを列挙します。

[ public ]
Bool EnumNextFieldsInfo(
    AEEAddrFieldInfo * pf   
);

解説

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

参照

BREW API IADDRBOOK_EnumNextFieldsInfo | AEEAddrFieldInfo | SFBAddrBook::EnumFieldsInfoInit

SFBAddrBook::EnumNextRec

IADDRBOOK_EnumRecInit()への前回のコール時に指定されていた検索条件に一致する次のレコードを列挙します。

[ public ]
SFUBrewPtr<SFBAddrRec> EnumNextRec(Void);

解説

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

参照

BREW API IADDRBOOK_EnumNextRec | SFBAddrBook::EnumRecInit

SFBAddrBook::EnumRecInit

指定された検索条件に基づき、アドレスブック内のレコードの列挙を初期化します。

[ public ]
SFCError EnumRecInit(
    AEEAddrCat wCategory      
    AEEAddrFieldID wFieldID   
    VoidPtr pData             
    UInt16 wDataSize          
);

解説

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

参照

SFBAddrBook::GetLastError

最後のアドレスブック操作で発生したエラーを返します。

[ public ]
SFCError GetLastError(Void);

参照

BREW API IADDRBOOK_GetLastError

SFBAddrBook::GetNumRecs

このアドレスブックに存在するアドレスレコードの数を返します。

[ public ]
SIntN GetNumRecs(Void);

参照

BREW API IADDRBOOK_GetNumRecs

SFBAddrBook::GetProperties

IAddressBook インターフェイスのプロパティを返します。

[ public ]
UInt32 GetProperties(Void);

バージョン

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

参照

BREW API IADDRBOOK_GetProperties | SFBAddrBook::SetProperties

SFBAddrBook::GetRecByID

指定された ID を持つアドレスレコードへのポインタを取得します。

[ public ]
SFUBrewPtr<SFBAddrRec> GetRecByID(
    UInt16 wID   
);

解説

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

参照

BREW API IADDRBOOK_GetRecById | SFBAddrRec::GetRecID

SFBAddrBook::Instance

IAddrBook インターフェイスのインスタンスを取得します。

[ public, static ]
SFUBrewPtr<SFBAddrBook> Instance(
    AEECLSID clsid = AEECLSID_ADDRESSBOOK   
);

解説

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

SFBAddrBook::RemoveAllRecs

与えられたアドレスブックからすべてのレコードを削除します。

[ public ]
SFCError RemoveAllRecs(Void);

解説

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

参照

BREW API IADDRBOOK_RemoveAllRecs

SFBAddrBook::SetProperties

IAddressBook インターフェイスのプロパティを設定します。

[ public ]
Void SetProperties(
    UInt32 dwProps   
);

バージョン

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

参照

BREW API IADDRBOOK_SetProperties | SFBAddrBook::GetProperties