stbpvrmsg.h File Reference

PVR messages database access functions header file. More...

#include "techtype.h"

Go to the source code of this file.

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_PVRDeleteMessage (U16BIT handle)
	Deletes a message from the list. 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...
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 messages database access functions header file.

Date

Nov 2007

Author

Chris Aldworth

Definition in file stbpvrmsg.h.

Function Documentation

STB_PVRAddMessage()

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

Definition at line 111 of file stbpvrmsg.c.

STB_PVRCheckMessages()

BOOLEAN STB_PVRCheckMessages

(

void

)

Check for new messages and clear the new message flag.

---

Returns

TRUE if there is a new message, otherwise FALSE

Definition at line 191 of file stbpvrmsg.c.

STB_PVRDeleteMessage()

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

Definition at line 242 of file stbpvrmsg.c.

STB_PVRGetMessageInfo()

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

Definition at line 361 of file stbpvrmsg.c.

STB_PVRGetMessages()

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

Definition at line 311 of file stbpvrmsg.c.

STB_PVRGetMessageText()

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)

Definition at line 397 of file stbpvrmsg.c.

STB_PVRGetNumMessages()

U16BIT STB_PVRGetNumMessages

(

void

)

Returns the number of messages.

---

Returns

number of messages

Definition at line 209 of file stbpvrmsg.c.

STB_PVRInitialiseMessages()

BOOLEAN STB_PVRInitialiseMessages

(

void

)

Initialises file that provides messages for recording er.

---

Parameters

None

Returns

TRUE if successful, otherwise FALSE

Definition at line 85 of file stbpvrmsg.c.