DbiDeleteDriver

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

DbiDeleteDriver

Return to chapter overview

C syntax

DBIResult DbiDeleteDriver ( [hCfg], pszDriverName, bSave );

Delphi syntax

function DbiDeleteDriver (hCfg: hDBICfg; pszDriverName: PChar; bSave: Bool): DBIResult stdcall;

Description

DbiDeleteDriver deletes a driver from the configuration file specified by the parameter hCfg.

Parameters

hCfg                Type: hDBICfg                (Input)
Specifies the configuration file to be used. This parameter is required to be NULL, indicating that the alias is removed from the configuration file for the current session.

pszDriverName                Type: pCHAR                (Input)
Pointer to the driver name. This is the name of the new driver that is to be removed.

bSave                Type: BOOL                (Input)
If TRUE, saves the change to the configuration file.

Usage

This function removes a driver that is either defined for use in the current session or stored in the configuration file. (See the DbiAddDriver parameter bPersistent.)

Prerequisites

DbiInit must be called prior to calling DbiDeleteDriver.

DbiResult

Meaning

DBIERR_INVALIDPARAM

Null driver name.

DBIERR_NONE

The driver was deleted successfully.

DBIERR_OBJNOTFOUND

No driver was found matching pszDriverName.

See Also

DbiInit, DbiOpenCfgInfoList, DbiAddDriver