/****************************** Module Header *******************************
*
* Module Name: deleteconfigvalue.e
*
* E wrapper routine to access the NEPMD library DLL.
* Include of nepmdlib.e.
*
* Copyright (c) Netlabs EPM Distribution Project 2002
*
* $Id$
*
* ===========================================================================
*
* This file is part of the Netlabs EPM Distribution package and is free
* software.  You can redistribute it and/or modify it under the terms of the
* GNU General Public License as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* Netlabs EPM Distribution.  This library is distributed in the hope that it
* will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
* General Public License for more details.
*
****************************************************************************/

/*
@@NepmdDeleteConfigValue@PROTOTYPE
NepmdDeleteConfigValue( Handle, ConfPath)

@@NepmdDeleteConfigValue@CATEGORY@CONFIG

@@NepmdDeleteConfigValue@SYNTAX
This function deletes a value from the configuration repository of the
[=TITLE] installation.

@@NepmdDeleteConfigValue@PARM@Handle
This parameter determines the handle obtained by a previous call
to [.IDPNL_EFUNC_NEPMDOPENCONFIG].

Use *-3* or *HINI__NEPMDPROFILE* to automatically insert the value of the
universal var *nepmd__hini*.
That's the handle returned by the initial opening of NEPMD.INI.

You may pass an *empty string* or *-9* to
[.IDPNL_REGISTRY_IMPLICITOPEN implicitely open and close]
the configuration repository before and after this call.

@@NepmdDeleteConfigValue@PARM@ConfPath
This parameter specifies the [.IDPNL_REGISTRY_NAMESPACE path] under which
the configuration value is to be deleted.

@@NepmdDeleteConfigValue@RETURNS
*NepmdDeleteConfigValue* returns nothing.

This procedure sets the implicit universal var *rc*. rc is set to an
[inf:cp2 "Errors" OS/2 error code] or to zero for no error.

@@NepmdDeleteConfigValue@TESTCASE
You can test this function from the *EPM* commandline by
executing:
.sl
- *NepmdDeleteConfigValue*
  - or
- *DeleteConfigValue*

Executing this command will delete
the configuration value with the pathname
.sl compact
- *\NEPMD\Test\Nepmdlib\TestKey*
.el
from the configuration repository of the [=TITLE]
and display the result within the status area.

@@
*/
; ---------------------------------------------------------------------------
; Allow editor command to call function
; ---------------------------------------------------------------------------
compile if NEPMD_LIB_TEST

defc NepmdDeleteConfigValue, DeleteConfigValue

   call NepmdDeleteConfigValue( '', NEPMD_TEST_CONFIGPATH)

   if (rc > 0) then
      sayerror 'Config value not deleted, rc = 'rc'.'
   else
      sayerror 'Config value "'NEPMD_TEST_CONFIGPATH'" successfully deleted.'
   endif

compile endif

; ---------------------------------------------------------------------------
; Procedure: NepmdDeleteConfigValue
; ---------------------------------------------------------------------------
; E syntax:
;    NepmdDeleteConfigValue( Handle, ConfPath)
; ---------------------------------------------------------------------------
; C prototype:
;    APIRET EXPENTRY NepmdDeleteConfigValue( HCONFIG hconfig,
;                                            PSZ pszRegPath);
; ---------------------------------------------------------------------------

defproc NepmdDeleteConfigValue( Handle, ConfPath)

   -- For -3, use the handle returned by the initial OpenConfig of NEPMD.INI.
   if Handle = HINI_NEPMDPROFILE then
      Handle = helperNepmdGetConfigHandle()
   elseif Handle = '' then
      Handle = -9
   endif

   -- Prepare parameters for C routine
   ConfPath = ConfPath\0

   -- Call C routine
   LibFile = helperNepmdGetlibfile()
   rc = dynalink32( LibFile,
                    "NepmdDeleteConfigValue",
                    atol( Handle)      ||
                    address( ConfPath))

   helperNepmdCheckliberror( LibFile, rc)

   return