SFBKDDIAddr

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

#include <SFBKDDIAddr.h.hpp>

class SFBKDDIAddr : public SFBBase;

SFMTYPEDEFWRAPPER(SFBKDDIAddr)

継承図

バージョン

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

SFBKDDIAddr クラスを利用するには、TARGET_EXTENSION_KDDI マクロを設定する必要があります。

#define TARGET_EXTENSION_KDDI
#include <SophiaFramework.hpp>

参照

KDDI 日本拡張インターフェース IAddr

メンバ

パブリック関数
`SFCError`	Get( `UInt16` memoryNo , `UInt32` fieldMask , `ADDR_BOOK_RECORD*` addrBookRecord ) アドレス帳から指定したメモリ番号のレコードを取得する。
`SFCError`	GetInfo( `ADDR_BOOK_INFO*` addrBookInfo ) アドレス帳の情報を取得する。
`SFCError`	GetMemNoStatus( `MEMORY_NO_STATUS*` memoryNoStatus ) メモリ番号の状態を取得します。
static `SFBKDDIAddrSmp`	NewInstance( `SFCErrorPtr` exception = null ) SFBKDDIAddr クラスのインスタンスを生成します。
static `SFBMediaSVGSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) SFBKDDIAddr クラスのインスタンスを生成します。
`SFCError`	Put( `UInt16Ptr` memoryNo , `UInt32` fieldMask , `ADDR_BOOK_RECORD*` addrBookRecord , `Bool` update ) 指定したレコードをアドレス帳に書き込みます。

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

SFBKDDIAddr::Get

アドレス帳から指定したメモリ番号のレコードを取得する。

[ public ]
SFCError Get(
    UInt16 memoryNo                    // 取得すべきレコードのメモリ番号
    UInt32 fieldMask                   // 取得すべきフィールドに対応したビットマスク
    ADDR_BOOK_RECORD* addrBookRecord   // 取得したレコードが格納される領域のポインタ
);

戻り値

KDDI_SUCCESS　　　成功

KDDI_EFAILED　　　失敗

KDDI_EBADPARAM　　メモリ番号が不正

KDDI_ERESTRICTED　アドレス帳アクセスが制限されている

KDDI_ESECRET　　　シークレットレコードにアクセス

参照

KDDI 日本拡張インターフェース IADDR_Get

SFBKDDIAddr::GetInfo

アドレス帳の情報を取得する。

[ public ]
SFCError GetInfo(
    ADDR_BOOK_INFO* addrBookInfo   // アドレス帳情報が返される
);

戻り値

KDDI_SUCCESS　　　　成功

KDDI_EFAILED　　　　失敗

KDDI_ERESTRICTED　　アドレス帳へのアクセスが制限されている

参照

KDDI 日本拡張インターフェース IADDR_GetInfo

SFBKDDIAddr::GetMemNoStatus

メモリ番号の状態を取得します。

[ public ]
SFCError GetMemNoStatus(
    MEMORY_NO_STATUS* memoryNoStatus   // MEMORY_NO_STATUSの配列
);

戻り値

KDDI_SUCCESS　　　成功

KDDI_EFAILED　　　失敗

KDDI_ERESTRICTED　アドレス帳へのアクセスが制限されている

解説

SFBKDDIAddr::GetMemNoStatus 関数を呼び出す前に、IADDR_GetInfo 関数を使って移動機で利用可能な最大メモリ番号を取得し、全体が格納できるだけのメモリ領域を確保し、MemoryNoStatus 引数を指定します。

参照

KDDI 日本拡張インターフェース IADDR_GetMemNoStatus

SFBKDDIAddr::NewInstance

SFBKDDIAddr クラスのインスタンスを生成します。

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

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

SFBKDDIAddr::Put

指定したレコードをアドレス帳に書き込みます。

[ public ]
SFCError Put(
    UInt16Ptr memoryNo                 // メモリ番号を指定する
    UInt32 fieldMask                   // 取得するフィールドを指定するビットマスク
    ADDR_BOOK_RECORD* addrBookRecord   // 取得したレコードが格納される
    Bool update                        // 更新か新規かを指定する
);

戻り値

KDDI_SUCCESS　　　　成功

KDDI_EFAILED　　　　失敗

KDDI_EALREADY 　　　既に登録済み

KDDI_EBADPARAM　　　メモリ番号が不正

KDDI_ERESTRICTED　　アドレス帳アクセスが制限されている

KDDI_ESECRET　　　　シークレットレコードにアクセス

KDDI_EFULL　　　　　空きメモリ番号がない

参照

KDDI 日本拡張インターフェース IADDR_Put