SophiaFramework UNIVERSE 5.3 |
BREW 2.0 | BREW 2.1 | BREW 3.1 | BREW 4.0 |
---|---|---|---|
○ | ○ | ○ | ○ |
パブリック関数 | |
---|---|
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
)
指定した検索条件に基づき、アドレス ブック内のレコードの列挙を初期化します。
|
SFCError |
EnumRecInit(
AEEAddrCat category
, AEEAddrFieldID fieldId
, SFXBufferPtr data
)
指定した検索条件に基づき、アドレス ブック内のレコードの列挙を初期化します。
|
SFCError |
EnumRecInitEx(
AEEAddrEnumRecInfo* enumRecInfo
)
指定された検索条件に基づき、アドレス ブック内のレコードの列挙を初期化します。
|
SFCError |
GetCategoryName(
AEEAddrCat category
, WCharPtr name
, SInt32Ptr size
)
指定されたカテゴリのテキスト名を取得します。返された文字列は指定したバッファに格納されます。
|
SFCError |
GetFieldName(
AEEAddrFieldID field
, WCharPtr fieldName
, SInt32Ptr size
)
指定されたフィールドのテキスト名を取得します。返された文字列は指定したバッファに格納されます。
|
SFCError |
GetLastError( Void )
最後のアドレス ブック操作で発生したエラーを取得します。
|
UInt16 |
GetNumRecs( Void )
このアドレス ブックに存在するアドレスレコードの数を取得します。
|
UInt32 |
GetProperties( Void )
プロパティを取得します。
|
SFBAddrRecSmp |
GetRecByID(
UInt16 id
)
指定した ID を持つアドレス レコードへのポインタを取得します。
|
static SFBAddrBookSmp |
NewInstance(
SFCErrorPtr exception = null
)
SFBAddrBook インスタンスを生成します。
|
static SFBAddrBookSmp |
NewInstance(
AEECLSID clsid = AEECLSID_ADDRBOOK
, SFCErrorPtr exception = null
)
SFBAddrBook インスタンスを生成します。
|
SFCError |
RemoveAllRecs( Void )
与えられたアドレス ブックからすべてのレコードを削除します。
|
Void |
SetProperties(
UInt32 properties
)
プロパティを設定します。
|
プロテクト関数 | |
---|---|
static SFBBaseSmp |
FactoryByCreate(
AEECLSID id
, SFCErrorPtr exception = null
)
(SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを生成します。
|
static SFBBaseSmp |
FactoryByQuery(
SFBQuerySmpConstRef query
, AEECLSID id
, SFCErrorPtr exception = null
)
(SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを指定した SFBQuery インスタンスを使用して生成します。
|
[ public ] SFBAddrRecSmp CreateRec( AEEAddrCat category // このアドレスが属するカテゴリ // AEE_ADDR_CAT_NONE は"無関係"を意味する AEEAddrField* items // アドレス ブックに入れる新しいアドレスレコード用のフィールドの配列 SInt32 itemCount // フィールド配列 items 内のフィールドの数 );
[ public ] SFCError EnumCategoryInit(Void);
[ public ] SFCError EnumFieldsInfoInit( AEEAddrCat category // フィールドのサポートを列挙すべきカテゴリを指定する // このパラメータを AEE_ADDR_CAT_NONE に設定した場合、 // この関数はすべてのカテゴリについてサポートされている全フィールドの列挙を初期化する );
[ public ] Bool EnumNextCategory( AEEAddrCat* category // カテゴリ情報を格納する );
この関数を使用する前に、SFBAddrBook::EnumCategoryInit を使用して列挙を初期化する必要があります。
[ public ] Bool EnumNextFieldsInfo( AEEAddrFieldInfo* fieldInfo // 入力時は、AEEAddrFieldInfo 構造体への有効なポインタを指定する // 戻り値が true の場合、このパラメータには、 // このカテゴリでサポートされている次のフィールドタイプの情報を格納する );
与えられたカテゴリについて、サポートされているフィールドの情報を返します。 この関数を使用する前に、SFBAddrBook::EnumFieldsInfoInit を使用して列挙を初期化する必要があります。
[ public ] SFBAddrRecSmp EnumNextRec(Void);
この関数を呼び出す前に、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
[ public ] SFCError EnumRecInitEx( AEEAddrEnumRecInfo* enumRecInfo // 検索条件を指定する AEEAddrEnumRecInfo 構造体へのポインタ );
この関数は、BREW 3.1 から使用可能です。
列挙が初期化された後は、SFBAddrBook::EnumNextRec 関数を使用して、この検索条件を満たすレコードのブラウズが可能です。
BREW API IAddrBook_EnumRecInitEx | AEEAddrCat | AEEAddrFieldID | SFBAddrBook::EnumNextRec | SFBAddrBook::EnumFieldsInfoInit | SFBAddrBook::EnumNextFieldsInfo
[ public ] SFCError GetCategoryName( AEEAddrCat category // テキスト名を探すカテゴリ WCharPtr name // 入力時は、有効な Wchar バッファへのポインタか、または項目のサイズを問い合わせるには null を指定する。 // 戻り値に、指定されたカテゴリの null 終結 Wchar 文字列名がこのバッファに格納される。 SInt32Ptr size // 入力時は、name バッファのサイズ( バイト数 )を指す。 // 戻り値は、リターン時は、name バッファに書き込まれたバイト数が size に格納される。 // name が null の場合は、このカテゴリ名を格納するために必要なバイト数が size に格納される。 );
この関数は、BREW 3.1 から使用可能です。
[ public ] SFCError GetCategoryName( AEEAddrFieldID field // テキスト名を探すフィールド WCharPtr fieldName // 入力時は、有効な Wchar バッファへのポインタか、または項目のサイズを問い合わせるには null を指定する。 // 戻り値に、指定されたフィールドのテキスト名がこのバッファに格納される。 SInt32Ptr size // 入力時は、fieldName バッファのサイズ( バイト数 )を指す。 // 戻り値は、リターン時は、fieldName バッファに書き込まれたバイト数が size に格納される。 // fieldName が null の場合は、このカテゴリ名を格納するために必要なバイト数が size に格納される。 );
この関数は、BREW 3.1 から使用可能です。
[ public ] SFCError GetLastError(Void);
AEEError.h で定義されているエラー値を返します。
[ public ] UInt16 GetNumRecs(Void);
[ public ] UInt32 GetProperties(Void);
この関数は、BREW 2.1 でのみ使用可能です。
[ public ] SFBAddrRecSmp GetRecByID( UInt16 id // アドレス ブックから取得するレコードのID );
レコードのレコード ID は、SFBAddrRec::GetRecID を使用して取得できます。
[ public, static ] SFBAddrBookSmp NewInstance( SFCErrorPtr exception = null // エラー値 );
[ public, static ] SFBAddrBookSmp NewInstance( AEECLSID clsid = AEECLSID_ADDRBOOK // クラス ID SFCErrorPtr exception = null // エラー値 );
clsid 引数には、作成する IAddressBook インスタンスのClassIDを指定します。 BREW 2.0 では AEECLSID_ADDRBOOK のみ指定可能ですが、 BREW 2.1 では AEECLSID_RUIM も指定可能です。
[ public ] SFCError RemoveAllRecs(Void);
この関数はアドレス ブックに大きな影響を与えるため、 デバイスによってはサポートされていない場合もあります。 この関数がサポートされていない場合は、戻り値として SFERR_UNSUPPORTED が返されます。
この関数は、BREW 2.1 でのみ使用可能です。
Copyright(c) 2002 - 2024 Sophia Cradle Incorporated All Rights Reserved. |