sx_TagArea

<< Click to Display Table of Contents >>

Navigation:  Apollo API Listing >

sx_TagArea

VB Declaration

Declare Function sx_TagArea Lib "Apollo9.dll"

(ByVal cpTagName As Any)

As Integer

C Declaration

SHORT FAR PASCAL sx_TagArea

(BYTEP cpTagName);

Description

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

Parameters

cpTagName: 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 (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 sx_SetOrder.

VB Example

iPrevTag = sx_SetOrder(sx_TagArea("name"))

C Example

// close and kill IDX index if its a conditional index

if (sx_IndexType() == INDEX_CONDITIONAL)

{

lstrcpy((LPSTR) caIndex, (LPSTR) sx_IndexName(sx_IndexOrd()));

sx_IndexClose();

unlink(caIndex);

}

sx_SetOrder(sx_TagArea("last"));

See Also

sx_IndexOrd, sx_IndexTag, sx_SetOrder, sx_TagName