Blame doc/html/GUPnPSearchCriteriaParser.html

Packit 712bc5
Packit 712bc5
<html>
Packit 712bc5
<head>
Packit 712bc5
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 712bc5
<title>GUPnPSearchCriteriaParser: GUPnP A/V Reference Manual</title>
Packit 712bc5
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit 712bc5
<link rel="home" href="index.html" title="GUPnP A/V Reference Manual">
Packit 712bc5
<link rel="up" href="ch01.html" title="GUPnP A/V">
Packit 712bc5
<link rel="prev" href="GUPnPCDSLastChangeParser.html" title="GUPnPCDSLastChangeParser">
Packit 712bc5
<link rel="next" href="GUPnPProtocolInfo.html" title="GUPnPProtocolInfo">
Packit 712bc5
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
Packit 712bc5
<link rel="stylesheet" href="style.css" type="text/css">
Packit 712bc5
</head>
Packit 712bc5
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 712bc5
Packit 712bc5
Packit 712bc5
Top  | 
Packit 712bc5
                  Description  | 
Packit 712bc5
                  Object Hierarchy  | 
Packit 712bc5
                  Signals
Packit 712bc5
Packit 712bc5
Home
Packit 712bc5
Up
Packit 712bc5
Prev
Packit 712bc5
Next
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

GUPnPSearchCriteriaParser

Packit 712bc5

GUPnPSearchCriteriaParser — A/V search criteria parser

Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Functions

Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
GUPnPSearchCriteriaParser *
Packit 712bc5
Packit 712bc5
Packit 712bc5
gupnp_search_criteria_parser_new ()
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
gboolean
Packit 712bc5
Packit 712bc5
Packit 712bc5
gupnp_search_criteria_parser_parse_text ()
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Signals

Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
void
Packit 712bc5
begin-parens
Packit 712bc5
Run Last
Packit 712bc5
Packit 712bc5
Packit 712bc5
void
Packit 712bc5
conjunction
Packit 712bc5
Run Last
Packit 712bc5
Packit 712bc5
Packit 712bc5
void
Packit 712bc5
disjunction
Packit 712bc5
Run Last
Packit 712bc5
Packit 712bc5
Packit 712bc5
void
Packit 712bc5
end-parens
Packit 712bc5
Run Last
Packit 712bc5
Packit 712bc5
Packit 712bc5
gboolean
Packit 712bc5
expression
Packit 712bc5
Run Last
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Types and Values

Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
 
Packit 712bc5
GUPnPSearchCriteriaParser
Packit 712bc5
Packit 712bc5
Packit 712bc5
enum
Packit 712bc5
GUPnPSearchCriteriaOp
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Object Hierarchy

Packit 712bc5
    GEnum
Packit 712bc5
    ╰── GUPnPSearchCriteriaOp
Packit 712bc5
    GObject
Packit 712bc5
    ╰── GUPnPSearchCriteriaParser
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Description

Packit 712bc5

GUPnPSearchCriteriaParser parses ContentDirectory search criteria

Packit 712bc5
strings.

Packit 712bc5

Note that no signals will be emitted if a wildcard is specified,

Packit 712bc5
and that the user is responsible for ensuring precedence of conjunction
Packit 712bc5
over disjunction.

Packit 712bc5
Packit 712bc5
Packit 712bc5

Functions

Packit 712bc5
Packit 712bc5

gupnp_search_criteria_parser_new ()

Packit 712bc5
GUPnPSearchCriteriaParser *
Packit 712bc5
gupnp_search_criteria_parser_new (void);
Packit 712bc5
Packit 712bc5

Returns

Packit 712bc5

A new GUPnPSearchCriteriaParser object.

Packit 712bc5
Packit 712bc5
Packit 712bc5

Packit 712bc5
Packit 712bc5

gupnp_search_criteria_parser_parse_text ()

Packit 712bc5
gboolean
Packit 712bc5
gupnp_search_criteria_parser_parse_text
Packit 712bc5
                               (GUPnPSearchCriteriaParser *parser,
Packit 712bc5
                                const char *text,
Packit 712bc5
                                GError **error);
Packit 712bc5

Parses text

Packit 712bc5
, emitting the various defined signals on the way. If an
Packit 712bc5
error occured error
Packit 712bc5
 will be set.

Packit 712bc5
Packit 712bc5

Parameters

Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

parser

Packit 712bc5

A GUPnPSearchCriteriaParser

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

text

Packit 712bc5

The search criteria string to be parsed

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

error

Packit 712bc5

The location where to store the error information if any, or NULL

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Returns

Packit 712bc5

TRUE on success.

Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Types and Values

Packit 712bc5
Packit 712bc5

GUPnPSearchCriteriaParser

Packit 712bc5
typedef struct _GUPnPSearchCriteriaParser GUPnPSearchCriteriaParser;
Packit 712bc5
Packit 712bc5

Packit 712bc5
Packit 712bc5

enum GUPnPSearchCriteriaOp

Packit 712bc5

The possible operators in SearchCriteria strings.

Packit 712bc5
Packit 712bc5

Members

Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

GUPNP_SEARCH_CRITERIA_OP_EQ

Packit 712bc5
Packit 712bc5

'='

Packit 712bc5
Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

GUPNP_SEARCH_CRITERIA_OP_NEQ

Packit 712bc5
Packit 712bc5

'!='

Packit 712bc5
Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

GUPNP_SEARCH_CRITERIA_OP_LESS

Packit 712bc5
Packit 712bc5

'<'

Packit 712bc5
Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

GUPNP_SEARCH_CRITERIA_OP_LEQ

Packit 712bc5
Packit 712bc5

'<='

Packit 712bc5
Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

GUPNP_SEARCH_CRITERIA_OP_GREATER

Packit 712bc5
Packit 712bc5

'>'

Packit 712bc5
Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

GUPNP_SEARCH_CRITERIA_OP_GEQ

Packit 712bc5
Packit 712bc5

'>='

Packit 712bc5
Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

GUPNP_SEARCH_CRITERIA_OP_CONTAINS

Packit 712bc5
Packit 712bc5

'contains'

Packit 712bc5
Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

GUPNP_SEARCH_CRITERIA_OP_DOES_NOT_CONTAIN

Packit 712bc5
Packit 712bc5

'doesNotContain'

Packit 712bc5
Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

GUPNP_SEARCH_CRITERIA_OP_DERIVED_FROM

Packit 712bc5
Packit 712bc5

'derivedFrom'

Packit 712bc5
Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

GUPNP_SEARCH_CRITERIA_OP_EXISTS

Packit 712bc5
Packit 712bc5

'exists'

Packit 712bc5
Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Signal Details

Packit 712bc5
Packit 712bc5

The “begin-parens” signal

Packit 712bc5
void
Packit 712bc5
user_function (GUPnPSearchCriteriaParser *parser,
Packit 712bc5
               gpointer                   user_data)
Packit 712bc5

The ::begin_parens signal is emitted to mark the beginning of a

Packit 712bc5
parenthetical expression.

Packit 712bc5
Packit 712bc5

Parameters

Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

parser

Packit 712bc5

The GUPnPSearchCriteriaParser that received the signal

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

user_data

Packit 712bc5

user data set when the signal handler was connected.

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Flags: Run Last

Packit 712bc5
Packit 712bc5

Packit 712bc5
Packit 712bc5

The “conjunction” signal

Packit 712bc5
void
Packit 712bc5
user_function (GUPnPSearchCriteriaParser *parser,
Packit 712bc5
               gpointer                   user_data)
Packit 712bc5

The ::conjuction signal is emitted whenever a conjuction marker

Packit 712bc5
(and) is parsed.

Packit 712bc5
Packit 712bc5

Parameters

Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

parser

Packit 712bc5

The GUPnPSearchCriteriaParser that received the signal

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

user_data

Packit 712bc5

user data set when the signal handler was connected.

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Flags: Run Last

Packit 712bc5
Packit 712bc5

Packit 712bc5
Packit 712bc5

The “disjunction” signal

Packit 712bc5
void
Packit 712bc5
user_function (GUPnPSearchCriteriaParser *parser,
Packit 712bc5
               gpointer                   user_data)
Packit 712bc5

The ::disjuction signal is emitted whenever a disjuction marker

Packit 712bc5
(or&rpar is parsed.

Packit 712bc5
Packit 712bc5

Parameters

Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

parser

Packit 712bc5

The GUPnPSearchCriteriaParser that received the signal

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

user_data

Packit 712bc5

user data set when the signal handler was connected.

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Flags: Run Last

Packit 712bc5
Packit 712bc5

Packit 712bc5
Packit 712bc5

The “end-parens” signal

Packit 712bc5
void
Packit 712bc5
user_function (GUPnPSearchCriteriaParser *parser,
Packit 712bc5
               gpointer                   user_data)
Packit 712bc5

The ::end_parens signal is emitted to mark the end of a parenthetical

Packit 712bc5
expression.

Packit 712bc5
Packit 712bc5

Parameters

Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

parser

Packit 712bc5

The GUPnPSearchCriteriaParser that received the signal

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

user_data

Packit 712bc5

user data set when the signal handler was connected.

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Flags: Run Last

Packit 712bc5
Packit 712bc5

Packit 712bc5
Packit 712bc5

The “expression” signal

Packit 712bc5
gboolean
Packit 712bc5
user_function (GUPnPSearchCriteriaParser *parser,
Packit 712bc5
               gchar                     *property,
Packit 712bc5
               GUPnPSearchCriteriaOp      op,
Packit 712bc5
               gchar                     *value,
Packit 712bc5
               gpointer                   error,
Packit 712bc5
               gpointer                   user_data)
Packit 712bc5

The ::expression signal is emitted whenever an expression is parsed.

Packit 712bc5
Set error
Packit 712bc5
 and return FALSE if an error occurred.

Packit 712bc5
Packit 712bc5

Parameters

Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

parser

Packit 712bc5

The GUPnPSearchCriteriaParser that received the signal

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

property

Packit 712bc5

The property

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

op

Packit 712bc5

The operator as GUPnPSearchCriteriaOp

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

value

Packit 712bc5

The value as string

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

error

Packit 712bc5

Place-holder for any possible errors from handler

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5

user_data

Packit 712bc5

user data set when the signal handler was connected.

Packit 712bc5
 
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Flags: Run Last

Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5
Packit 712bc5

Generated by GTK-Doc V1.25
Packit 712bc5
</body>
Packit 712bc5
</html>