Product Documentation

FairCom ISAM for C

Previous Topic

Next Topic

TransformXtdSegment

TransformXtdSegment() creates a binary sort key (segment) using an extended key segment definition. If successful, it returns the number of bytes used for the binary sort key.

Declaration

NINT TransformXtdSegment(NINT seghnd, pVOID src, NINT srclen,
NINT srctyp, pVOID dest, NINT destlen);

Description

Parameter

Description of use

seghnd

Handle returned by PutXtdKeySegmentDef() or GetXtdKeySegmentDef().

src

Pointer to data used to construct segment.

srclen

Size in bytes of the region pointed by src. However, srclen is ignored unless kseg_ssiz was set to ctKSEG_SSIZ_PROVIDED.

srctyp

srctyp should be set to one of the c-tree Plus field types (e.g., CT_STRING or CT_UNICODE). However, srctyp is ignored unless kseg_styp was set to ctKSEG_STYP_PROVIDED.

dest

Pointer to region in which binary sort key is constructed.

destlen

Size in bytes of the region pointed to by dest.

TOCIndex