stbpvrmsg.c File Reference

PVR message database access functions. More...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <techtype.h>
#include <dbgfuncs.h>
#include "stbhwos.h"
#include "stbheap.h"
#include "stbgc.h"
#include "stbuni.h"

Classes
struct	s_pvr_message

Macros
#define	STB_PVR_MSG_PRINT(x)

Typedefs
typedef struct s_pvr_message	S_PVR_MESSAGE

Functions
BOOLEAN	STB_PVRInitialiseMessages (void)
	Initialises file that provides messages for recording er. More...
BOOLEAN	STB_PVRAddMessage (U8BIT *message)
	Adds a message to the end of the list of existing messages. More...
BOOLEAN	STB_PVRCheckMessages (void)
	Check for new messages and clear the new message flag. More...
U16BIT	STB_PVRGetNumMessages (void)
	Returns the number of messages. More...
BOOLEAN	STB_PVRDeleteMessage (U16BIT handle)
	Deletes a message from the list. More...
U16BIT	STB_PVRGetMessages (U16BIT **handle_array)
	Returns an allocated array of the message handles and number of messages currently in the list. More...
BOOLEAN	STB_PVRGetMessageInfo (U16BIT handle, U16BIT *date, U8BIT *hour, U8BIT *min)
	Gets date/time for the message with the given handle. More...
U8BIT *	STB_PVRGetMessageText (U16BIT handle)
	Returns a pointer to the text for the message with the given handle. More...

Detailed Description

PVR message database access functions.

Date

Nov 2007

Author

Chris Aldworth

Function Documentation

BOOLEAN STB_PVRAddMessage

(

U8BIT *

message

)

Adds a message to the end of the list of existing messages.

---

Parameters

message

- The message to be written

Returns

TRUE if successful, otherwise FALSE

BOOLEAN STB_PVRCheckMessages

(

void

)

Check for new messages and clear the new message flag.

---

Returns

TRUE if there is a new message, otherwise FALSE

BOOLEAN STB_PVRDeleteMessage

(

U16BIT

handle

)

Deletes a message from the list.

---

Parameters

handle

- message handle

Returns

TRUE if the message is found and deleted, FALSE otherwise

BOOLEAN STB_PVRGetMessageInfo	(	U16BIT	handle,
		U16BIT *	date,
		U8BIT *	hour,
		U8BIT *	min
	)

Gets date/time for the message with the given handle.

---

Parameters

handle	- message handle
date	- pointer to value in which to return the date of the message
hour	- pointer to value in which to return the hour of the message
min	- pointer to value in which to return the min of the message

Returns

TRUE if the message is found, FALSE otherwise

U16BIT STB_PVRGetMessages

(

U16BIT **

handle_array

)

Returns an allocated array of the message handles and number of messages currently in the list.

---

Parameters

handle_array

- pointer to an array that's allocated by the function and is filled with the handles of all messages

Returns

Number of messages

U8BIT* STB_PVRGetMessageText

(

U16BIT

handle

)

Returns a pointer to the text for the message with the given handle.

---

Parameters

handle

- message handle

Returns

pointer to message text (this is not a copy and shouldn't be deleted)

U16BIT STB_PVRGetNumMessages

(

void

)

Returns the number of messages.

---

Returns

number of messages

BOOLEAN STB_PVRInitialiseMessages

(

void

)

Initialises file that provides messages for recording er.

---

Parameters

None

Returns

TRUE if successful, otherwise FALSE