NokSync

KaarPoSoft

• Developing
• Manual
• Features

• Classes
• Globals
• Files
• Translating
• Developing
• Building

NokiaPhonebook Class Reference

#include <NokiaPhonebook.h>

Inheritance diagram for NokiaPhonebook:

List of all members.

---

Detailed Description

Wrapper around PhonebookAdapterDS3::IPhonebook3.

Public Member Functions
void	Create (inout long hResult, inout long nmpResult)
	Initialize the INokiaPhonebook structure.
INokiaContact	CreateContact (inout long hResult, inout long nmpResult)
	Create empty contact.
void	DeleteContact (in long location, inout long hResult, inout long nmpResult)
	This deletes the phonebook entry from specified location.
void	Destroy (inout long hResult, inout long nmpResult)
	De-initialize the INokiaPhonebook structure.
INokiaContact	GetFirstContact (inout long hResult, inout long nmpResult)
	Get first contact in phone.
ACString	GetLastErrorString ()
	Return description of last error.
long	GetMemoryCapsFull (inout long hResult, inout long nmpResult)
	Get number of full memory locations.
INokiaContact	GetNextContact (inout long hResult, inout long nmpResult)
	Get next contact in phone.
void	SetContact (in long location, in INokiaContact contact, inout long hResult, inout long nmpResult)
	This method stores the contact in specified memory and location.
void	UpdateContact (in INokiaContact contact, inout long hResult, inout long nmpResult)
	This method stores (changes to) the contact.

---

Member Function Documentation

void INokiaPhonebook::Create	(	inout long	hResult,
		inout long	nmpResult
	)			[inherited]

Initialize the INokiaPhonebook structure.

Parameters:

	hResult	(see nsresult, hResult and nmpResult in NokSync)
	nmpResult	(see nsresult, hResult and nmpResult in NokSync)

INokiaContact INokiaPhonebook::CreateContact	(	inout long	hResult,
		inout long	nmpResult
	)			[inherited]

Create empty contact.

Parameters:

	hResult	(see nsresult, hResult and nmpResult in NokSync)
	nmpResult	(see nsresult, hResult and nmpResult in NokSync)

Returns:

The empty contact created

void INokiaPhonebook::DeleteContact	(	in long	location,
		inout long	hResult,
		inout long	nmpResult
	)			[inherited]

This deletes the phonebook entry from specified location.

Parameters:

	location	Input: Location of entry to delete
	hResult	(see nsresult, hResult and nmpResult in NokSync)
	nmpResult	(see nsresult, hResult and nmpResult in NokSync)

void INokiaPhonebook::Destroy	(	inout long	hResult,
		inout long	nmpResult
	)			[inherited]

De-initialize the INokiaPhonebook structure.

Parameters:

	hResult	(see nsresult, hResult and nmpResult in NokSync)
	nmpResult	(see nsresult, hResult and nmpResult in NokSync)

INokiaContact INokiaPhonebook::GetFirstContact	(	inout long	hResult,
		inout long	nmpResult
	)			[inherited]

Get first contact in phone.

Parameters:

	hResult	(see nsresult, hResult and nmpResult in NokSync)
	nmpResult	(see nsresult, hResult and nmpResult in NokSync)

Returns:

The first contact

ACString INokiaPhonebook::GetLastErrorString

(

)

[inherited]

Return description of last error.

Returns:

ACString

long INokiaPhonebook::GetMemoryCapsFull	(	inout long	hResult,
		inout long	nmpResult
	)			[inherited]

Get number of full memory locations.

Parameters:

	hResult	(see nsresult, hResult and nmpResult in NokSync)
	nmpResult	(see nsresult, hResult and nmpResult in NokSync)

Returns:

number of full memory locations (i.e. the number of contacts available)

INokiaContact INokiaPhonebook::GetNextContact	(	inout long	hResult,
		inout long	nmpResult
	)			[inherited]

Get next contact in phone.

Parameters:

	hResult	(see nsresult, hResult and nmpResult in NokSync)
	nmpResult	(see nsresult, hResult and nmpResult in NokSync)

Returns:

The next contact

void INokiaPhonebook::SetContact	(	in long	location,
		in INokiaContact	contact,
		inout long	hResult,
		inout long	nmpResult
	)			[inherited]

This method stores the contact in specified memory and location.

Parameters:

	location	Input: Where to store the contact. Zero for next available location
	contact	Input: The contact to store.
	hResult	(see nsresult, hResult and nmpResult in NokSync)
	nmpResult	(see nsresult, hResult and nmpResult in NokSync)

void INokiaPhonebook::UpdateContact	(	in INokiaContact	contact,
		inout long	hResult,
		inout long	nmpResult
	)			[inherited]

This method stores (changes to) the contact.

Parameters:

	contact	Input: The contact to update.
	hResult	(see nsresult, hResult and nmpResult in NokSync)
	nmpResult	(see nsresult, hResult and nmpResult in NokSync)

---

The documentation for this class was generated from the following file:

• NokiaPhonebook.h