<< Click to Display Table of Contents >> Navigation:  »No topics above this level« DbiDeleteAlias

C syntax

DBIResult DbiDeleteAlias ( [hCfg], pszAliasName );

Delphi syntax

function DbiDeleteAlias (hCfg: hDBICfg; pszAliasName: PChar): DBIResult stdcall;

Description

DbiDeleteAlias deletes an alias 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.

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

Usage

This function removes an alias that is either defined for use in the current session or stored in the configuration file. (See the DbiAddAlias parameter bPersistent.)

Prerequisites

DbiInit must be called prior to calling DbiDeleteAlias.

See Also

DbiInit, DbiOpenCfgInfoList, DbiAddAlias