DVBCore  17.9.0
Open Source DVB Engine
 All Data Structures Files Functions Typedefs Macros Pages
stbpvrmsg.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2007 Ocean Blue Software Ltd
4  *
5  * This file is part of a DTVKit Software Component
6  * You are permitted to copy, modify or distribute this file subject to the terms
7  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
8  *
9  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
10  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
11  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
12  *
13  * If you or your organisation is not a member of DTVKit then you have access
14  * to this source code outside of the terms of the licence agreement
15  * and you are expected to delete this and any associated files immediately.
16  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
17  *******************************************************************************/
24 /* pre-processor mechanism so multiple inclusions don't cause compilation error*/
25 #ifndef _STBPVRMSG_H
26 
27 #define _STBPVRMSG_H
28 
29 #include "techtype.h"
30 
31 /*---Global Function prototypes for public use---------------------------------*/
32 
33 BOOLEAN STB_PVRInitialiseMessages(void);
34 BOOLEAN STB_PVRAddMessage(U8BIT *message);
35 BOOLEAN STB_PVRDeleteMessage(U16BIT handle);
36 BOOLEAN STB_PVRCheckMessages(void);
37 U16BIT STB_PVRGetNumMessages(void);
38 U16BIT STB_PVRGetMessages(U16BIT **handle_array);
39 BOOLEAN STB_PVRGetMessageInfo(U16BIT handle, U16BIT *date, U8BIT *hour, U8BIT *min);
40 U8BIT* STB_PVRGetMessageText(U16BIT handle);
41 
42 #endif /* _STBPVRMSG_H */
43 
44 /*****************************************************************************
45  * End of file
46  *****************************************************************************/
U16BIT STB_PVRGetNumMessages(void)
Returns the number of messages.
Definition: stbpvrmsg.c:209
BOOLEAN STB_PVRDeleteMessage(U16BIT handle)
Deletes a message from the list.
Definition: stbpvrmsg.c:242
BOOLEAN STB_PVRGetMessageInfo(U16BIT handle, U16BIT *date, U8BIT *hour, U8BIT *min)
Gets date/time for the message with the given handle.
Definition: stbpvrmsg.c:361
U8BIT * STB_PVRGetMessageText(U16BIT handle)
Returns a pointer to the text for the message with the given handle.
Definition: stbpvrmsg.c:397
System Wide Global Technical Data Type Definitions.
BOOLEAN STB_PVRInitialiseMessages(void)
Initialises file that provides messages for recording er.
Definition: stbpvrmsg.c:85
BOOLEAN STB_PVRAddMessage(U8BIT *message)
Adds a message to the end of the list of existing messages.
Definition: stbpvrmsg.c:111
BOOLEAN STB_PVRCheckMessages(void)
Check for new messages and clear the new message flag.
Definition: stbpvrmsg.c:191
U16BIT STB_PVRGetMessages(U16BIT **handle_array)
Returns an allocated array of the message handles and number of messages currently in the list...
Definition: stbpvrmsg.c:311