SFBAddrRec

Wrapper Class for the IAddrRec interface.

#include <SFBAddrRec.h.hpp>

class SFBAddrRec : public SFBBase;

SFMTYPEDEFWRAPPER(SFBAddrRec)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
O	O	O	O

Reference

BREW API IAddrRec

Member

Public Functions
`SFCError`	AddField( `AEEAddrField*` addrField ) Add a new field to this record.
`AEEAddrCat`	GetCategory( `Void` ) Return the category of this address record.
`AEEAddrField*`	GetField( `SInt32` fieldIndex ) Retrieve information about the field at the given index.
`SInt32`	GetFieldCount( `Void` ) Return the count of the number of fields found in this record.
`SFCError`	GetLastError( `Void` ) Return the error that has occurred with the most recent address record operation on this SFBAddrRec Interface.
`UInt16`	GetRecID( `Void` ) Return the record ID of the record pointed to by this IAddrRec Interface.
`SFCError`	RemoveField( `SInt32` fieldIndex ) Remove the field at the given index position. The index is zero based.
`SFCError`	RemoveRec( `Void` ) Remove the address record from the address book.
`SFCError`	SetCategory( `AEEAddrCat` category ) Set the address category of this address record.
`SFCError`	UpdateAllFields( `AEEAddrField*` addrField , `SInt32` fieldCount ) Update all the fields in this record. It replaces all the fields in this record with the new fields passed to this function.
`SFCError`	UpdateField( `SInt32` fieldIndex , `AEEAddrField*` addrField ) Update the field at the given index position. The index is zero based.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBAddrRec::AddField

Add a new field to this record.

[ public ]
SFCError AddField(
    AEEAddrField* addrField   // the new field to be added to this record
);

Reference

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

SFBAddrRec::GetCategory

Return the category of this address record.

[ public ]
AEEAddrCat GetCategory(Void);

Reference

BREW API IADDRREC_GetCategory | AEEAddrCat

SFBAddrRec::GetField

Retrieve information about the field at the given index.

[ public ]
AEEAddrField* GetField(
    SInt32 fieldIndex   // specifies the index of the field whose information is to be retrieved. 
                        // this index is 0 (zero) based
);

Description

The index is zero based and ranges from zero to NumFields -1 (where NumFields is the number of fields in this record). The pointer returned by this function must not be freed or tampered with by the caller. It is automatically freed when this record is released. If modifications need to be made to this field, the function IADDRREC_UpdateField() must be called for the modifications to take effect.

Reference

BREW API IADDRREC_GetField | AEEAddrField

SFBAddrRec::GetFieldCount

Return the count of the number of fields found in this record.

[ public ]
SInt32 GetFieldCount(Void);

Reference

IADDRREC_GetFieldCount

SFBAddrRec::GetLastError

Return the error that has occurred with the most recent address record operation on this SFBAddrRec Interface.

[ public ]
SFCError GetLastError(Void);

Reference

BREW API IADDRREC_GetLastError

SFBAddrRec::GetRecID

Return the record ID of the record pointed to by this IAddrRec Interface.

[ public ]
UInt16 GetRecID(Void);

Reference

BREW API IADDRREC_GetRecID

SFBAddrRec::RemoveField

Remove the field at the given index position. The index is zero based.

[ public ]
SFCError RemoveField(
    SInt32 fieldIndex   // specifies the index position at which the field is to be deleted
);

Reference

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

SFBAddrRec::RemoveRec

Remove the address record from the address book.

[ public ]
SFCError RemoveRec(Void);

Reference

BREW API IADDRREC_RemoveRec

SFBAddrRec::SetCategory

Set the address category of this address record.

[ public ]
SFCError SetCategory(
    AEEAddrCat category   // new address category
);

Reference

BREW API IADDRREC_SetCategory | AEEAddrCat

SFBAddrRec::UpdateAllFields

Update all the fields in this record. It replaces all the fields in this record with the new fields passed to this function.

[ public ]
SFCError UpdateAllFields(
    AEEAddrField* addrField   // specifies the updated information for the fields. 
                              // replace all the existing fields with these new fields
    SInt32 fieldCount         // specifies the number of fields in pFields array that need to be added to the record
);

Reference

BREW API IADDRREC_UpdateAllFields | AEEAddrField | SFBAddrRec::UpdateField

SFBAddrRec::UpdateField

Update the field at the given index position. The index is zero based.

[ public ]
SFCError UpdateField(
    SInt32 fieldIndex         // specifies the index at which the new field is to be updated
    AEEAddrField* addrField   // specifies the updated information for the field.
                              // replace the existing field at this index with this new field
);

Reference

BREW API IADDRREC_UpdateField | AEEAddrField | SFBAddrRec::UpdateAllFields