TagArea

<< Click to Display Table of Contents >>

Navigation:  Apollo VCL Components > Apollo VCL Component Reference > TApolloTable > TApolloTable Methods >

TagArea

Declaration

function TagArea( sTagName: String ): Integer;

Description

Retrieves the index select area of the named tag within a compound index.

Parameters

sTagName: The tag name assigned to the index when the tag was created. The name may be passed in upper or lower case. If a NULL string ('' or #0) is passed , the current tag select area is returned.

Return Value

An integer identifying the tag area within the compound index (CDX or NSX). This integer may be used as input to SetOrder.

Delphi Example

iPrevTag := ApTbl.SetOrder( ApTbl.TagArea( 'name' ));

C++Builder Example

iPrevTag = ApTbl->SetOrder( ApTbl->TagArea( "name" ));

See Also

IndexOrd, IndexTag, SetOrder, TagName

TagName