SFBAddrRec

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

#include <SFBAddrRec.h.hpp>

class SFBAddrRec : public SFBBase;

SFMTYPEDEFWRAPPER(SFBAddrRec)

継承図

バージョン

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

参照

BREW API IAddrRec

メンバ

パブリック関数
`SFCError`	AddField( `AEEAddrField*` addrField ) レコードに新しいフィールドを追加します。
`AEEAddrCat`	GetCategory( `Void` ) アドレスレコードのカテゴリを取得します。
`AEEAddrField*`	GetField( `SInt32` fieldIndex ) 与えられたインデックスにおけるフィールドの情報を取得します。
`SInt32`	GetFieldCount( `Void` ) レコード内で見つかったフィールドの数を取得します。
`SFCError`	GetLastError( `Void` ) SFBAddrRec インターフェースでの最後のアドレスレコード操作で発生したエラーを取得します。
`UInt16`	GetRecID( `Void` ) SFBAddrRec インターフェースが指しているレコードのレコード ID を取得します。
`SFCError`	RemoveField( `SInt32` fieldIndex ) 与えられたインデックス位置にあるフィールドを削除します。
`SFCError`	RemoveRec( `Void` ) アドレスブックからアドレスレコードを削除します。
`SFCError`	SetCategory( `AEEAddrCat` category ) アドレスレコードのアドレスカテゴリを設定します。
`SFCError`	UpdateAllFields( `AEEAddrField*` addrField , `SInt32` fieldCount ) レコード内の全フィールドを更新します。
`SFCError`	UpdateField( `SInt32` fieldIndex , `AEEAddrField*` addrField ) 与えられたインデックス位置にあるフィールドを更新します。

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

SFBAddrRec::AddField

レコードに新しいフィールドを追加します。

[ public ]
SFCError AddField(
    AEEAddrField* addrField   // このレコードに追加する新しいフィールド
);

戻り値

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

参照

BREW API IADDRREC_AddField | AEEAddrField | SFBAddrRec::UpdateField | SFBAddrRec::RemoveField

SFBAddrRec::GetCategory

アドレスレコードのカテゴリを取得します。

[ public ]
AEEAddrCat GetCategory(Void);

参照

BREW API IADDRREC_GetCategory | AEEAddrCat

SFBAddrRec::GetField

与えられたインデックスにおけるフィールドの情報を取得します。

[ public ]
AEEAddrField* GetField(
    SInt32 fieldIndex   // 情報を取得するフィールドのインデックスを指定する
                        // このインデックスは 0( ゼロ )基準
);

参照

BREW API IADDRREC_GetField | AEEAddrField

SFBAddrRec::GetFieldCount

レコード内で見つかったフィールドの数を取得します。

[ public ]
SInt32 GetFieldCount(Void);

参照

IADDRREC_GetFieldCount

SFBAddrRec::GetLastError

SFBAddrRec インターフェースでの最後のアドレスレコード操作で発生したエラーを取得します。

[ public ]
SFCError GetLastError(Void);

戻り値

AEEError.h で定義されているエラー値を返します。

参照

BREW API IADDRREC_GetLastError

SFBAddrRec::GetRecID

SFBAddrRec インターフェースが指しているレコードのレコード ID を取得します。

[ public ]
UInt16 GetRecID(Void);

参照

BREW API IADDRREC_GetRecID

SFBAddrRec::RemoveField

与えられたインデックス位置にあるフィールドを削除します。

[ public ]
SFCError RemoveField(
    SInt32 fieldIndex   // 削除するフィールドのインデックス位置を指定する
);

戻り値

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

参照

BREW API IADDRREC_RemoveField | SFBAddrRec::UpdateField | SFBAddrRec::AddField

SFBAddrRec::RemoveRec

アドレスブックからアドレスレコードを削除します。

[ public ]
SFCError RemoveRec(Void);

戻り値

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

参照

BREW API IADDRREC_RemoveRec

SFBAddrRec::SetCategory

アドレスレコードのアドレスカテゴリを設定します。

[ public ]
SFCError SetCategory(
    AEEAddrCat category   // 新しいアドレス カテゴリ
);

戻り値

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

参照

BREW API IADDRREC_SetCategory | AEEAddrCat

SFBAddrRec::UpdateAllFields

レコード内の全フィールドを更新します。

[ public ]
SFCError UpdateAllFields(
    AEEAddrField* addrField   // フィールドの更新情報を指定する
                              // 既存の全フィールドがこれらの新しいフィールドで置き換えられる
    SInt32 fieldCount         // レコードに追加する必要のある、addrField 配列内のフィールドの数を指定する
);

戻り値

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

参照

BREW API IADDRREC_UpdateAllFields | AEEAddrField | SFBAddrRec::UpdateField

SFBAddrRec::UpdateField

与えられたインデックス位置にあるフィールドを更新します。

[ public ]
SFCError UpdateField(
    SInt32 fieldIndex         // 更新する新しいフィールドのインデックス位置を指定する
    AEEAddrField* addrField   // フィールドの更新情報を指定する
                              // 既存のフィールドがこの新しいフィールドで置き換えられる
);

戻り値

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

参照

BREW API IADDRREC_UpdateField | AEEAddrField | SFBAddrRec::UpdateAllFields