include/osregistry.h

   1 /*
   2  * Copyright (C) Volition, Inc. 1999.  All rights reserved.
   3  *
   4  * All source code herein is the property of Volition, Inc. You may not sell
   5  * or otherwise commercially exploit the source or things you created based on
   6  * the source.
   7  */
   8
   9 #ifndef _FS2_REGISTRY_HEADER_FILE
  10 #define _FS2_REGISTRY_HEADER_FILE
  11
  12 #include <stdlib.h>
  13
  14 // ------------------------------------------------------------------------------------------------------------
  15 // REGISTRY DEFINES/VARS
  16 //
  17
  18 // exectuable defines
  19 extern const char *Osreg_company_name;
  20 extern const char *Osreg_class_name;
  21 extern const char *Osreg_app_name;
  22 extern const char *Osreg_title;
  23
  24 // ------------------------------------------------------------------------------------------------------------
  25 // REGISTRY FUNCTIONS
  26 //
  27
  28
  29 // initialize the registry. setup default keys to use
  30 void os_init_registry_stuff(const char *company, const char *app, const char *version);
  31
  32 // Removes a value from to the INI file.  Passing
  33 // name=NULL will delete the section.
  34 void os_config_remove( const char *section, const char *name );
  35
  36 // Writes a string to the registry
  37 void os_config_write_string( const char *section, const char *name, const char *value );
  38
  39 // same as previous function except we don't use the application name to build up the keyname
  40 void os_config_write_string2( const char *section, const char *name, const char *value );
  41
  42 // Writes an unsigned int to the INI file.
  43 void os_config_write_uint( const char *section, const char *name, unsigned int value );
  44
  45 // Reads a string from the INI file.  If default is passed,
  46 // and the string isn't found, returns ptr to default otherwise
  47 // returns NULL;    Copy the return value somewhere before
  48 // calling os_read_string again, because it might reuse the
  49 // same buffer.
  50 const char * os_config_read_string( const char *section, const char *name, const char *default_value=NULL );
  51
  52 // same as previous function except we don't use the application name to build up the keyname
  53 const char * os_config_read_string2( const char *section, const char *name, const char *default_value=NULL );
  54
  55 // Reads a string from the INI file.  Default_value must
  56 // be passed, and if 'name' isn't found, then returns default_value
  57 unsigned int  os_config_read_uint( const char *section, const char *name, unsigned int default_value );
  58
  59 // uses Ex versions of Windows registry functions
  60 const char * os_config_read_string_ex( const char *keyname, const char *name, const char *default_value );
  61
  62 #endif
  63