DbiTranslateRecordStructure

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

DbiTranslateRecordStructure

Return to chapter overview

C syntax

DBIResult DBIFN DbiTranslateRecordStructure (pszSrcDriverType, iFlds, pfldsSrc, pszDstDriverType, pszLangDriver, pfldsDst, bCreatable);

Delphi syntax

function DbiTranslateRecordStructure (pszSrcDriverType: PChar; iFlds: Word; pfldsSrc: pFLDDesc; pszDstDriverType: PChar; pszLangDriver: PChar; pfldsDst: pFLDDesc; bCreateable: Bool): DBIResult stdcall;

Description

DbiTranslateRecordStructure translates the source driver's physical or logical fields to equivalent physical or logical fields of the destination driver.

Parameters

pszSrcDriverType                Type: pCHAR                (Input)
Pointer to the source driver type. If NULL, it is assumed that the source fields are logical with a NULL driver type.

iFlds                Type: UINT16                (Input)
Specifies the number of fields.

pfldsSrc                Type: pFLDDesc                (Input)
Pointer to an array of the logical or physical types of the source fields.

pszDstDriverType                Type: pCHAR                (Input)
Pointer to the destination driver type. If NULL, it is assumed that the destination fields are logical with a NULL driver type.

pszLangDriver                Type: pCHAR                (Input)
Pointer to the destination driver's language driver name. This language driver is used to validate the destination field names after the translation.

pfldsDst                Type: pFLDDesc                (Output)
Pointer to an array of the destination fields.

bCreatable                Type: BOOL                (Input)
If True, map to creatable fields only

Usage

This function takes the logical or physical fields of the source driver and attempts to map them to equivalent logical or physical fields of the destination driver. If an exact match is not found, the function attempts to map to the closest possible logical or physical fields of the destination driver. If a close match is not found, this returns the error DBIERR_NOTSUPPORTED.

DbiResult

Meaning

DBIERR_NONE

The translation was successfully completed.

DBIERR_NOTSUPPORTED

Returned if source fields cannot be translated into equivalent destination fields.

See also

DbiOpenFieldXlt, DbiCloseFieldXlt, DbiTranslateField