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, bool 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_Error GSM_AddNote	(	GSM_StateMachine *	s,
		GSM_NoteEntry *	Note
	)

Adds note entry.

Parameters:

	s	State machine pointer.
	Note	Note to add.

Returns:

Error code

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.

GSM_Error GSM_DeleteAllNotes

(

GSM_StateMachine *

s

)

Deletes all notes entries.

Parameters:

s

State machine pointer.

Returns:

Error code

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

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.

GSM_Error GSM_GetNextNote	(	GSM_StateMachine *	s,
		GSM_NoteEntry *	Note,
		bool	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

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

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

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