dvb/inc/ap_epgsearch.h File Reference

macros and function prototypes for public use More...

Go to the source code of this file.

Data Structures
struct	s_ags_time_range
Typedefs
typedef enum e_ags_match_type	E_AGS_MATCH_TYPE
typedef enum e_ags_match_action	E_AGS_MATCH_ACTION
typedef enum e_ags_search_fields	E_AGS_SEARCH_FIELDS
typedef enum e_ags_search_days	E_AGS_SEARCH_DAYS
typedef struct s_ags_time_range	S_AGS_TIME_RANGE
Enumerations
enum	e_ags_match_type {   AGS_MATCH_ANY_WORD = 0, AGS_MATCH_ALL_WORDS = 1, AGS_MATCH_EXACT_PHRASE = 2, AGS_MATCH_CONTAINS_PHRASE = 3,   AGS_MATCH_NOT_EQUAL = 4, AGS_MATCH_IGNORE_CASE = 0x80 }
enum	e_ags_match_action { AGS_ACTION_NONE = 0, AGS_ACTION_SET_TIMER = 1, AGS_ACTION_SET_ALARM = 2 }
enum	e_ags_search_fields { AGS_SEARCH_ALL = 0xff, AGS_SEARCH_TITLE = 0x01, AGS_SEARCH_DESC = 0x02, AGS_SEARCH_EXT_DESC = 0x04 }
enum	e_ags_search_days {   AGS_DAYS_ALL = 0xff, AGS_DAYS_WEEKDAYS = 0x1f, AGS_DAYS_WEEKENDS = 0x60, AGS_DAYS_MONDAY = 0x01,   AGS_DAYS_TUESDAY = 0x02, AGS_DAYS_WEDNESDAY = 0x04, AGS_DAYS_THURSDAY = 0x08, AGS_DAYS_FRIDAY = 0x10,   AGS_DAYS_SATURDAY = 0x20, AGS_DAYS_SUNDAY = 0x40 }
Functions
void *	AGS_OpenSearch (U8BIT *search_str, E_AGS_SEARCH_FIELDS search_fields, E_AGS_MATCH_TYPE match_type, E_AGS_SEARCH_DAYS search_days, S_AGS_TIME_RANGE *search_times, E_AGS_MATCH_ACTION match_action)
	Opens an EPG Search.
BOOLEAN	AGS_GetNextResult (void *ags_handle, U16BIT *event_id, void **serv_ptr)
	Gets the next matching result for an open search.
void	AGS_CloseSearch (void *ags_handle)
	Closes an open search and frees all associated resources.

---

Detailed Description

macros and function prototypes for public use

Date:

13/08/2011

Author:

Ocean Blue

---

Function Documentation

void AGS_CloseSearch

(

void *

ags_handle

)

Closes an open search and frees all associated resources.

Parameters:

ags_handle

The handle of the open search

BOOLEAN AGS_GetNextResult	(	void *	ags_handle,
		U16BIT *	event_id,
		void **	serv_ptr
	)

Gets the next matching result for an open search.

Parameters:

ags_handle	The handle of the open search
event_id	Caller's event id var to be set with matching result
serv_ptr	Caller's service pointer to be set with matching result

Returns:

BOOLEAN, TRUE=Match Found, FALSE=No more matches

void* AGS_OpenSearch	(	U8BIT *	search_str,
		E_AGS_SEARCH_FIELDS	search_fields,
		E_AGS_MATCH_TYPE	match_type,
		E_AGS_SEARCH_DAYS	search_days,
		S_AGS_TIME_RANGE *	search_times,
		E_AGS_MATCH_ACTION	match_action
	)

Opens an EPG Search.

Parameters:

search_str	The search string to compare
search_fields	The EPG parts to match
match_type	The type of comparison to make on the string
search_days	Which days of the week to search
search_times	Time range in which to search (NULL for any)
match_action	The action to perform on a search match

Returns:

Handle for search, NULL if failed