Note

Data Structures
struct	GSM_NoteEntry

Functions
GSM_Error	GSM_DecodeVNOTE (char *Buffer, size_t *Pos, GSM_NoteEntry *Note)
GSM_Error	GSM_EncodeVNTFile (char *Buffer, const size_t buff_len, size_t *Length, GSM_NoteEntry *Note)
GSM_Error	GSM_GetNotesStatus (GSM_StateMachine *s, GSM_ToDoStatus *status)
GSM_Error	GSM_GetNote (GSM_StateMachine *s, GSM_NoteEntry *Note)
GSM_Error	GSM_GetNextNote (GSM_StateMachine *s, GSM_NoteEntry *Note, gboolean start)
GSM_Error	GSM_SetNote (GSM_StateMachine *s, GSM_NoteEntry *Note)
GSM_Error	GSM_AddNote (GSM_StateMachine *s, GSM_NoteEntry *Note)
GSM_Error	GSM_DeleteNote (GSM_StateMachine *s, GSM_NoteEntry *Note)
GSM_Error	GSM_DeleteAllNotes (GSM_StateMachine *s)

Detailed Description

Notes manipulations.

Function Documentation

GSM_AddNote()

GSM_Error GSM_AddNote	(	GSM_StateMachine *	s,
		GSM_NoteEntry *	Note
	)

Adds note entry.

Parameters

s	State machine pointer.
Note	Note to add.

Returns

Error code

Adds note entry.

Definition at line 1592 of file api.c.

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

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();
        PRINT_NOTE_INFO();

        err = s->Phone.Functions->AddNote(s, Note);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_DecodeVNOTE()

GSM_Error GSM_DecodeVNOTE	(	char *	Buffer,
		size_t *	Pos,
		GSM_NoteEntry *	Note
	)

Decodes vNote from buffer.

Parameters

Buffer	Buffer to decode.
Pos	Current position in buffer (will be updated).
Note	Storage for note entry.

Returns

Error code.

Definition at line 2030 of file gsmcal.c.

References CopyUnicodeString(), ERR_EMPTY, ERR_NONE, FALSE, MyGetLine(), ReadVCALText(), GSM_NoteEntry::Text, TRUE, and UnicodeLength().

{
        unsigned char   Line[2000],Buff[2000];
        int          Level = 0;
        GSM_Error       error;
        gboolean        empty = TRUE;

        Note->Text[0] = 0;
        Note->Text[1] = 0;

        while (1) {
                error = MyGetLine(Buffer, Pos, Line, strlen(Buffer), sizeof(Line), TRUE);
                if (error != ERR_NONE) return error;
                if (strlen(Line) == 0) break;
                switch (Level) {
                case 0:
                        if (strstr(Line,"BEGIN:VNOTE")) Level = 1;
                        empty = TRUE;
                        break;
                case 1:
                        if (strstr(Line,"END:VNOTE")) {
                                if (UnicodeLength(Note->Text) == 0) return ERR_EMPTY;
                                return ERR_NONE;
                        }
                        if (ReadVCALText(Line, "BODY",        Buff, FALSE, NULL)) {
                                CopyUnicodeString(Note->Text, Buff);
                                empty = FALSE;
                        }
                        break;
                }
        }
        if (empty) return ERR_EMPTY;

        return ERR_NONE;
}

GSM_DeleteAllNotes()

GSM_Error GSM_DeleteAllNotes

(

GSM_StateMachine *

s

)

Deletes all notes entries.

Parameters

s	State machine pointer.

Returns

Error code

Deletes all notes entries.

Definition at line 1620 of file api.c.

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

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->DeleteAllNotes(s);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_DeleteNote()

GSM_Error GSM_DeleteNote	(	GSM_StateMachine *	s,
		GSM_NoteEntry *	Note
	)

Deletes note entry.

Parameters

s	State machine pointer.
Note	Note to delete, must contain position.

Returns

Error code

Deletes note entry.

Definition at line 1606 of file api.c.

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

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();
        PRINT_NOTE_INFO();

        err = s->Phone.Functions->DeleteNote(s, Note);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_EncodeVNTFile()

GSM_Error GSM_EncodeVNTFile	(	char *	Buffer,
		const size_t	buff_len,
		size_t *	Length,
		GSM_NoteEntry *	Note
	)

Encodes vNote to buffer.

Parameters

	Buffer	Storage for data.
[in]	buff_len	Size of output buffer.
	Length	Pointer to current position in data (will be incremented).
	Note	Note to encode.

Returns

Error code.

Definition at line 2066 of file gsmcal.c.

References ERR_NONE, FALSE, GSM_NoteEntry::Text, VC_StoreLine(), and VC_StoreText().

{
        GSM_Error error;

        error = VC_StoreLine(Buffer, buff_len, Length,  "BEGIN:VNOTE");
        if (error != ERR_NONE) return error;
        error = VC_StoreLine(Buffer, buff_len, Length,  "VERSION:1.1");
        if (error != ERR_NONE) return error;
        error = VC_StoreText(Buffer, buff_len, Length, Note->Text, "BODY", FALSE);
        if (error != ERR_NONE) return error;
        error = VC_StoreLine(Buffer, buff_len, Length,  "END:VNOTE");
        if (error != ERR_NONE) return error;

        return ERR_NONE;
}

GSM_GetNextNote()

GSM_Error GSM_GetNextNote	(	GSM_StateMachine *	s,
		GSM_NoteEntry *	Note,
		gboolean	start
	)

Retrieves note entry. This is useful for continuous reading of all notes entries.

Parameters

s	State machine pointer.
Note	Storage for note, if start is FALSE, should contain data from previous read (at least position).
start	Whether we're doing initial read or continue in reading.

Returns

Error code

Retrieves note entry. This is useful for continuous reading of all notes entries.

Definition at line 1563 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, GSM_Phone_Functions::GetNextNote, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, PRINT_NOTE_INFO, and PRINT_START.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();
        PRINT_START();
        PRINT_NOTE_INFO();

        err = s->Phone.Functions->GetNextNote(s, Note, start);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_GetNote()

GSM_Error GSM_GetNote	(	GSM_StateMachine *	s,
		GSM_NoteEntry *	Note
	)

Retrieves notes entry.

Parameters

s	State machine pointer.
Note	Storage for note.

Returns

Error code

Retrieves notes entry.

Definition at line 1548 of file api.c.

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

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();
        PRINT_NOTE_INFO();

        err = s->Phone.Functions->GetNote(s, Note);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_GetNotesStatus()

GSM_Error GSM_GetNotesStatus	(	GSM_StateMachine *	s,
		GSM_ToDoStatus *	status
	)

Retrieves notes status (number of used entries).

Parameters

s	State machine pointer.
status	Storage for status.

Returns

Error code

Retrieves notes status (number of used entries).

Definition at line 1535 of file api.c.

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

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->GetNotesStatus(s, status);
        PRINT_LOG_ERROR(err);
        return err;
}

GSM_SetNote()

GSM_Error GSM_SetNote	(	GSM_StateMachine *	s,
		GSM_NoteEntry *	Note
	)

Sets note entry

Parameters

s	State machine pointer.
Note	New note values, needs to contain valid position.

Returns

Error code

Sets note entry

Definition at line 1578 of file api.c.

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

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();
        PRINT_NOTE_INFO();

        err = s->Phone.Functions->SetNote(s, Note);
        PRINT_LOG_ERROR(err);
        return err;
}