uTFRMKEY

Undo key segment translation to target key.

Short Name

uTFRMKEY()

Type

ISAM function

Declaration

pTEXT uTFRMKEY(COUNT keyno, pVOID tarptr)

Description

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 Plus Error Codes for a complete listing of valid c-tree Plus error values.