scilab/modules/windows_tools/src/c/registry.h

   1 /*
   2 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
   3 * Copyright (C) INRIA - Allan CORNET
   4 *
   5 * This file must be used under the terms of the CeCILL.
   6 * This source file is licensed as described in the file COPYING, which
   7 * you should have received as part of this distribution.  The terms
   8 * are also available at
   9 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  10 *
  11 */
  12
  13 /*--------------------------------------------------------------------------*/
  14 #ifndef __REGISTY_H__
  15 #define __REGISTY_H__
  16
  17 #include <Windows.h>
  18 #include "BOOL.h" /* BOOL */
  19
  20 /**
  21 * WindowsQueryRegistry
  22 * Query a value in a registry key
  23 * @param[in] ParamIn1 (HKEY)
  24 * @param[in] ParamIn2 (SUBKEY)
  25 * @param[in] ParamIn3 (value name)
  26 * @param[out] ParamOut1 (value REG_SZ format)
  27 * @param[out] ParamOut2 (value int)
  28 * @param[out] OuputIsREG_SZ
  29 * @return TRUE or FALSE
  30 */
  31 BOOL WindowsQueryRegistry(char *ParamIn1, char *ParamIn2, char *ParamIn3, char *ParamOut1, int *ParamOut2, BOOL *OuputIsREG_SZ);
  32
  33 /**
  34 * WindowsQueryRegistryValuesList
  35 * Query a list of values in a registry key
  36 * @param[in] ParamIn1 (HKEY)
  37 * @param[in] ParamIn2 (SUBKEY)
  38 * @param[in] dimMax
  39 * @param[out] ListKeys (values)
  40 * @return TRUE or FALSE
  41 */
  42 BOOL WindowsQueryRegistryValuesList(char *ParamIn1, char *ParamIn2, int dimMax, char **ListKeys);
  43
  44 /**
  45 * WindowsQueryRegistryKeysList
  46 * Query a list of values in a registry key
  47 * @param[in] ParamIn1 (HKEY)
  48 * @param[in] ParamIn2 (SUBKEY)
  49 * @param[in] dimMax
  50 * @param[out] ListKeys (values)
  51 * @return TRUE or FALSE
  52 */
  53 BOOL WindowsQueryRegistryKeysList(char *ParamIn1, char *ParamIn2, int dimMax, char **ListKeys);
  54
  55
  56 /**
  57 * WindowsQueryRegistryNumberOfElementsInList
  58 * get numbers of elements in a list
  59 * @param[in] ParamIn1 (HKEY)
  60 * @param[in] ParamIn2 (SUBKEY)
  61 * @param[out] Number
  62 * @return TRUE or FALSE
  63 */
  64 BOOL WindowsQueryRegistryNumberOfValuesInList(char *ParamIn1, char *ParamIn2, int *Number);
  65
  66 /**
  67 * WindowsQueryRegistryNumberOfKeysInList
  68 * get numbers of Key in a list
  69 * @param[in] ParamIn1 (HKEY)
  70 * @param[in] ParamIn2 (SUBKEY)
  71 * @param[out] Number
  72 * @return TRUE or FALSE
  73 */
  74 BOOL WindowsQueryRegistryNumberOfKeysInList(char *ParamIn1, char *ParamIn2, int *Number);
  75
  76 /**
  77 * GetHkeyrootFromString
  78 * convert string value to HKEY
  79 * @param[in] string example "HKEY_CLASSES_ROOT"
  80 * @return HKEY
  81 */
  82 HKEY GetHkeyrootFromString(char *string);
  83
  84
  85 #endif /* __REGISTY_H__ */
  86 /*--------------------------------------------------------------------------*/