Product Documentation

FairCom ISAM for C

Previous Topic

Next Topic

uTFRMKEY

Undo key segment translation to target key.

Short Name

uTFRMKEY()

Type

ISAM function

Declaration

pTEXT uTFRMKEY(FILNO keyno, pVOID tarptr)

Description

In V12 the file number typedef was formally changed from COUNT, a two-byte value to FILNO, a four-byte value. Refer to this link for compatibility details. Four Byte File Numbering

uTFRMKEY() undoes reversible key transformation, meaning it can reverse the TransformKey() transformations where possible. For example, an INTSEG() transformation can be undone but an uppercase conversion such as UREGSEG() transformation cannot be undone.

Return

uTFRMKEY() returns a pointer to the translated target key. Since the translation is performed in place, the return value is always equal to the target parameter, unless there is an error. A NULL value is returned if there is an error, and the value of isam_err will be:

Value

Symbolic Constant

Explanation

80

BKEY_ERR

tarptr is null or keyno is out of range.

199

NSCH_ERR

Segment mode requires a schema map.

433

SSCH_ERR

File referenced by schema-based segment is not defined.

See c-tree Error Codes for a complete listing of valid c-tree error values.

See also

CurrentISAMKey(), BuildKey(), TransformKey()

TOCIndex