SFBCallHistory

Wrapper Class for the ICallHistory interface.

#include <SFBCallHistory.h.hpp>

class SFBCallHistory : public SFBBase;

SFMTYPEDEFWRAPPER(SFBCallHistory)

Inheritance diagram

Version

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

Reference

BREW API ICallHistory

Member

Public Functions
`SFCError`	AddEntry( `AEECallHistoryEntry const *` entry ) Add a new entry to the Call History list.
`SFCError`	Clear( `Void` ) Delete all entries from the Call History list in the current storage.
`SFCError`	EnumInit( `Void` ) Initialize or resets the enumeration in the Call History list.
`AEECallHistoryEntry const *`	EnumNext( `SInt32Ptr` err ) Retrieve the next entry in the Call History list.
static `SFBCallHistorySmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new instance of SFBCallHistory class.
static `SFBCallHistorySmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new instance of SFBCallHistory class.
`SFCError`	UpdateEntry( `AEECallHistoryEntry const *` entry ) Replace the current call history entry with the one provided.

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

SFBCallHistory::AddEntry

Add a new entry to the Call History list.

[ public ]
SFCError AddEntry(
    AEECallHistoryEntry const * entry   // new entry
);

Description

If the maximum number of entries is reached, the function will typically delete the oldest entry in the list before adding the new entry.

Reference

BREW API ICALLHISTORY_AddEntry

SFBCallHistory::Clear

Delete all entries from the Call History list in the current storage.

[ public ]
SFCError Clear(Void);

Reference

BREW API ICALLHISTORY_Clear

SFBCallHistory::EnumInit

Initialize or resets the enumeration in the Call History list.

[ public ]
SFCError EnumInit(Void);

Reference

BREW API ICALLHISTORY_EnumInit

SFBCallHistory::EnumNext

Retrieve the next entry in the Call History list.

[ public ]
AEECallHistoryEntry const * EnumNext(
    SInt32Ptr err   // pointer to an integer to hold any error value, set to: 
                    // success if successful 
                    // or at end of enumeration EFAILED or another BREW error if an error occurs
);

Reference

BREW API ICALLHISTORY_EnumNext

SFBCallHistory::NewInstance

Create a new instance of SFBCallHistory class.

[ public, static ]
SFBCallHistorySmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBCallHistorySmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBCallHistory::UpdateEntry

Replace the current call history entry with the one provided.

[ public ]
SFCError UpdateEntry(
    AEECallHistoryEntry const * entry   // new data to replace existing entry
);

Reference

BREW API ICALLHISTORY_UpdateEntry