SftBox/OCX 4.5

SftBoxItems.FindDataTag Method

Softel vdm, Inc.

Searches item data (Item.DataTag property).

Syntax       

VB.NET

FoundIndex = object.FindDataTag(ByVal vData As Object, ByVal StartIndex As Integer, ByVal EndIndex As Integer)  As Integer

VB

FoundIndex = object.FindDataTag(ByVal vData As Variant, ByVal StartIndex As Long, ByVal EndIndex As Long)  As Long

C#.NET

int FoundIndex = object.FindDataTag(object vData, int StartIndex, int EndIndex);

VC++

long FoundIndex = object->FindDataTag(const _variant_t& vData, long StartIndex, long EndIndex);

C

HRESULT object->raw_FindDataTag(VARIANT vData, long StartIndex, long EndIndex, long* FoundIndex);

Delphi

FoundIndex := object.FindDataTag(vData : OleVariant; StartIndex : Integer; EndIndex : Integer)   : Integer;

object

A SftBoxItems object.

vData

The data to be searched.

StartIndex

The zero-based index of the item where the search is to begin (including the item at StartIndex). Specify StartIndex as -1 and EndIndex as -1 to search all items.

EndIndex

The zero-based index of the item where the search is to begin (including the item at StartIndex). Specify StartIndex as -1 and EndIndex as -1 to search all items.

FoundIndex

Returns the zero-based index of the item found. -1 is returned if no match was found.

Comments

The FindDataTag method searches item data (Item.DataTag property).

The data described by vData is compared to the Item.DataTag property of all items involved in the search. The search starts at the item described by StartIndex. If an item with a matching Item.DataTag property is found, its zero-based index is returned, otherwise -1 is returned.


Feedback / comments / error reports for this topic
© 2008 - Softel vdm, Inc. - www.softelvdm.com