xHarbour Reference Documentation > Function Reference xHarbour Developers Network  

RddRegister()

Registers a user defined Replaceable Database Driver (RDD).

Syntax

RddRegister( <cRddName>, <nRddType> ) --> nErrorCode

Arguments

<cRddName>
This is a character string holding the name of the RDD to register in xHarbour's RDD system.
<nRddType>
This is a numeric value indicating the type of the RDD to register. #define constants contained in RDDSYS.CH are used for this parameter.

Types of RDDs
ConstantValueDescription
RDT_FULL1RDDs with full functionality
RDT_TRANSFER2RDDs having only import/export capabilities

Return

The function returns a numeric error code indicating a successfull RDD registration.

Return values of RddRegister()
ValueDescription
0RDD is successfully registered
1RDD is already registered
>1RDD is not registered due to error

Description

RddRegister() registers a user-defined RDD in xHarbour's RDD system. The easiest way of registration is to call the function from within an INIT PROCEDURE, so that the registration occurs automatically at program start.

Refer to the files in \source\rdd\usrrdd\rdds for examples of RDD registration.

Info

See also:RddInfo(), UsrRdd_ID()
Category: Database drivers , User-defined RDD , xHarbour extensions
Header:usrrdd.ch
Source:rdd\dbcmd.c
LIB:lib\xhb.lib
DLL:dll\xhbdll.dll


Copyright © 2006-2007 xHarbour.com Inc. All rights reserved.
http://www.xHarbour.com
Created by docmaker.exe