alp_ms_dml_statement_parameters Struct Reference
[Media Selector Data Model]

#include <mediaselector_api.h>

---

Detailed Description

Structure that defines a query for the alp_ms_dml_statement api-s. (Use the alp_ms_dml_statement_parameters_* methods to set it.).

Note:

None of the alp_ms_dml_statement_parameters_* methods make copies of their const char * parameters: It is your responsibility to be sure that pointers still point to valid strings at the time you call alp_ms_dml_statement_exec() or alp_ms_dml_statement_begin(). Similarly, you own the strings in the alp_ms_dml_statement_parameters block, and it is your responsibility to free them after you call alp_ms_dml_statement_exec() or alp_ms_dml_statement_begin() if necessary (obviously, you should not free static strings).

Data Fields
bool	ascending
	Ascending or descending result.
const char *	category
	A comma-separated list of categories to retrieve data from: like "all", "applications,audio", etc.
const char *	excludedCategories
	A comma-separated list of categories that you don't want to see. For example, including "audio" while excluding "voice,ringtones" will give you all audio files that are neither voice or ringtone files.
const char *	fields
	A comma-separated list of field names, like "id,title,size,icon".
const char *	filter
	A SQL where clause like eg "application.mimetype='application/msword'".
const char *	includedCategories
	A comma-separated list of categories that a file is in. For example, "audio" would give you all audio files.
int	limit
	Limit number of records returned (0 means no limit).
const char *	match
const char *	matchField
	Field to match against - match(sai), matchCategory(title) matches titles that start with sai.
const char *	regex
	Slow but powerful matching - applies POSIX regex (case insensitive, extended) to regexField.
const char *	regexField
	_ matches any 1 character and % matches 0-or-more of any character. (\ escapes _ and %.) Field to apply regex to match against
const char *	sortby
	"size", "artist", "audio.title", etc. NULL means no sorting.
int	start
	Records to skip: 0..n-1.

---

Field Documentation

bool ascending

Ascending or descending result.

const char* category

A comma-separated list of categories to retrieve data from: like "all", "applications,audio", etc.

const char* excludedCategories

A comma-separated list of categories that you don't want to see. For example, including "audio" while excluding "voice,ringtones" will give you all audio files that are neither voice or ringtone files.

const char* fields

A comma-separated list of field names, like "id,title,size,icon".

const char* filter

A SQL where clause like eg "application.mimetype='application/msword'".

const char* includedCategories

A comma-separated list of categories that a file is in. For example, "audio" would give you all audio files.

int limit

Limit number of records returned (0 means no limit).

const char* match

Flexible matching, e.g. "sai" to match "sailing".

const char* matchField

Field to match against - match(sai), matchCategory(title) matches titles that start with sai.

const char* regex

Slow but powerful matching - applies POSIX regex (case insensitive, extended) to regexField.

const char* regexField

_ matches any 1 character and % matches 0-or-more of any character. (\ escapes _ and %.) Field to apply regex to match against

const char* sortby

"size", "artist", "audio.title", etc. NULL means no sorting.

int start

Records to skip: 0..n-1.

---

The documentation for this struct was generated from the following file:

• include/alp/mediaselector_api.h

---

Generated on Wed Jul 30 07:06:41 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.