FindListItem function

The FindListItem function will search for data in a certain column and return the row identifier if found.

Syntax

int __stdcall FindListItem(
	__in	void *list,
	__in	int columnId,
	__in	void *item,
	__in	int len,
	__in	int flags,
	__in	int startFromRow
);

Parameters

list [in]

A pointer to a list. This pointer is returned by GetPluginData and is initialized by SetControlPanelOptions (if one of the options was type TD_LIST).

columnId [in]

The identifier of the column to search in. The first column is identified by 0, not 1.

item [in]

A pointer to the item to compaire the items in the selected column to. The type of every item is defined in the member type of structure UserValueOption, the member that holds this structure is defined in structure MultiColumnList, named columns.

len [in]

The length, in bytes, of the buffer pointed to by the item parameter.

flags [in]

This parameter can be zero or a combination of the following values.

Value	Meaning
FLI_CASE_SENSITIVE 0x1	The selected column contains a string (unicode or ascii) and should be compaired case sensitive.
FLI_COMPARE_ONLY_ONE_ROW 0x2	Only compare the item from row startFromRow and return the result.

startFromRow [in]

The identifier to the row to start searching for the item. This function searches backwards, if this parameter is set to zero this function will start with searching starting at the last row. The first row is identified by 1, however the function immediately decrees this value with one, this means if you want to search row 1 you have to set this parameter to 2.

Return value

If no error occurs and the item is found the function returns a identifier to the row containing the found item. If the function fails it will returns zero.

Requirements

Should be exported by	-
Minimum supported API	1.00
Header	tvsserver_base.h