Category

Data Structures
struct	GSM_Category
struct	GSM_CategoryStatus

Enumerations
enum	GSM_CategoryType { Category_ToDo = 1, Category_Phonebook }

Functions
GSM_Error	GSM_GetCategory (GSM_StateMachine *s, GSM_Category *Category)
GSM_Error	GSM_AddCategory (GSM_StateMachine *s, GSM_Category *Category)
GSM_Error	GSM_GetCategoryStatus (GSM_StateMachine *s, GSM_CategoryStatus *Status)
GSM_Error	GSM_GetDateTime (GSM_StateMachine *s, GSM_DateTime *date_time)
GSM_Error	GSM_SetDateTime (GSM_StateMachine *s, GSM_DateTime *date_time)

Detailed Description

Categories handling.

Enumeration Type Documentation

GSM_CategoryType

enum GSM_CategoryType

Type of category

Enumerator
Category_ToDo	Todo entry category
Category_Phonebook	Phonebook entry category

Definition at line 28 of file gammu-category.h.

             {
        Category_ToDo = 1,
        Category_Phonebook
} GSM_CategoryType;

Function Documentation

GSM_AddCategory()

GSM_Error GSM_AddCategory	(	GSM_StateMachine *	s,
		GSM_Category *	Category
	)

Adds category to phone.

Parameters

s	State machine pointer.
Category	New category, containing its type and location.

Returns

Error code

Adds category to phone.

Definition at line 476 of file api.c.

References GSM_Phone_Functions::AddCategory, CHECK_PHONE_CONNECTION, GSM_Phone::Functions, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->AddCategory(s, Category);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_GetCategory()

GSM_Error GSM_GetCategory	(	GSM_StateMachine *	s,
		GSM_Category *	Category
	)

Reads category from phone.

Parameters

s	State machine pointer.
Category	Storage for category, containing its type and location.

Returns

Error code

Reads category from phone.

Definition at line 463 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetCategory, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->GetCategory(s, Category);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_GetCategoryStatus()

GSM_Error GSM_GetCategoryStatus	(	GSM_StateMachine *	s,
		GSM_CategoryStatus *	Status
	)

Reads category status (number of used entries) from phone.

Parameters

s	State machine pointer.
Status	Category status, fill in type before calling.

Returns

Error code

Reads category status (number of used entries) from phone.

Definition at line 489 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetCategoryStatus, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->GetCategoryStatus(s, Status);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_GetDateTime()

GSM_Error GSM_GetDateTime	(	GSM_StateMachine *	s,
		GSM_DateTime *	date_time
	)

Reads date and time from phone.

Parameters

s	State machine pointer.
date_time	Storage for date.

Returns

Error code

Reads date and time from phone.

Definition at line 229 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetDateTime, _GSM_StateMachine::Phone, and PRINT_LOG_ERROR.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->GetDateTime(s, date_time);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_SetDateTime()

GSM_Error GSM_SetDateTime	(	GSM_StateMachine *	s,
		GSM_DateTime *	date_time
	)

Sets date and time in phone.

Parameters

s	State machine pointer.
date_time	Date to set.

Returns

Error code

Sets date and time in phone.

Definition at line 242 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, and GSM_Phone_Functions::SetDateTime.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->SetDateTime(s, date_time);
        PRINT_LOG_ERROR(err);
        return err;
}