include/realmedia/rmacfg.h

   1 /****************************************************************************
   2  *
   3  *  $Id: rmacfg.h 7 2003-05-30 02:18:02Z gabest $
   4  *
   5  *  Copyright (C) 1995-1999 RealNetworks, Inc. All rights reserved.
   6  *
   7  *  http://www.real.com/devzone
   8  *
   9  *  This program contains proprietary
  10  *  information of Progressive Networks, Inc, and is licensed
  11  *  subject to restrictions on use and distribution.
  12  *
  13  *  Server Configuration File Interface
  14  *
  15  */
  16
  17 #ifndef _RMACFG_H_
  18 #define _RMACFG_H_
  19
  20 typedef _INTERFACE  IRMABuffer                  IRMABuffer;
  21
  22 /****************************************************************************
  23  *
  24  *  Interface:
  25  *
  26  *      IRMAConfigFile
  27  *
  28  *  Purpose:
  29  *
  30  *  IID_IRMAConfigFile:
  31  *
  32  *      {00001c00-0901-11d1-8B06-00A024406D59}
  33  *
  34  */
  35 DEFINE_GUID(IID_IRMAConfigFile, 0x00001c00, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
  36                                 0xa0, 0x24, 0x40, 0x6d, 0x59);
  37
  38 #undef INTERFACE
  39 #define INTERFACE IRMAConfigFile
  40
  41 DECLARE_INTERFACE_(IRMAConfigFile, IUnknown)
  42 {
  43     /*
  44      *  IUnknown methods
  45      */
  46     STDMETHOD(QueryInterface)           (THIS_
  47                                          REFIID riid,
  48                                          void** ppvObj) PURE;
  49
  50     STDMETHOD_(ULONG,AddRef)          (THIS) PURE;
  51
  52     STDMETHOD_(ULONG,Release)         (THIS) PURE;
  53
  54     /*
  55      *  IRMAConfigFile methods
  56      */
  57     /************************************************************************
  58      *  Method:
  59      *      IRMAConfigFile::LoadFrom
  60      *  Purpose:
  61      *
  62      *      LoadFrom tells the server to load the config file specified,
  63      *      and sets that file as the default for future Reloads and Saves
  64      */
  65     STDMETHOD(LoadFrom)                 (THIS_
  66                                          IRMABuffer* filename) PURE;
  67
  68     /************************************************************************
  69      *  Method:
  70      *      IRMAConfigFile::Reload
  71      *  Purpose:
  72      *
  73      *      Reload causes the current default config file to be reloaded.
  74      */
  75     STDMETHOD(Reload)                   (THIS) PURE;
  76
  77     /************************************************************************
  78      *  Method:
  79      *      IRMAConfigFile::Save
  80      *  Purpose:
  81      *
  82      *      Save causes the current configuration to be written to the
  83      *      current default file.
  84      */
  85     STDMETHOD(Save)                     (THIS) PURE;
  86
  87     /************************************************************************
  88      *  Method:
  89      *      IRMAConfigFile::SaveAs
  90      *  Purpose:
  91      *
  92      *      SaveAs writes the configuration to the named file, and sets that
  93      *      file as the default.
  94      */
  95     STDMETHOD(SaveAs)                   (THIS_
  96                                          IRMABuffer* pFilename) PURE;
  97
  98     /************************************************************************
  99      *  Method:
 100      *      IRMAConfigFile::GetFilename
 101      *  Purpose:
 102      *
 103      *      GetFilename returns the current default file
 104      */
 105     STDMETHOD(GetFilename)              (THIS_
 106                                          REF(IRMABuffer*) pFilename) PURE;
 107
 108     /************************************************************************
 109      *  Method:
 110      *      IRMAConfigFile::SetFilename
 111      *  Purpose:
 112      *
 113      *      SetFilename sets the current default file, but does not read it
 114      *      or change its contents.
 115      */
 116     STDMETHOD(SetFilename)              (THIS_
 117                                          IRMABuffer* pFilename) PURE;
 118 };
 119
 120 /****************************************************************************
 121  *
 122  *  Interface:
 123  *
 124  *      IRMARegConfig
 125  *
 126  *  Purpose:
 127  *
 128  *  IID_IRMARegConfig:
 129  *
 130  *      {00001c01-0901-11d1-8B06-00A024406D59}
 131  *
 132  */
 133 DEFINE_GUID(IID_IRMARegConfig, 0x00001c01, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 134                                 0xa0, 0x24, 0x40, 0x6d, 0x59);
 135
 136 #undef INTERFACE
 137 #define INTERFACE IRMARegConfig
 138
 139 DECLARE_INTERFACE_(IRMARegConfig, IUnknown)
 140 {
 141     /*
 142      *  IUnknown methods
 143      */
 144     STDMETHOD(QueryInterface)           (THIS_
 145                                          REFIID riid,
 146                                          void** ppvObj) PURE;
 147
 148     STDMETHOD_(ULONG,AddRef)          (THIS) PURE;
 149
 150     STDMETHOD_(ULONG,Release)         (THIS) PURE;
 151
 152     /************************************************************************
 153      *  Method:
 154      *      IRMARegConfig::WriteKey
 155      *  Purpose:
 156      *
 157      *      Write out the registry from the passed in keyname to the
 158      *  currently active permanent config storage area (ex. config file,
 159      *  registry).
 160      */
 161     STDMETHOD(WriteKey)              (THIS_
 162                                         const char* pKeyName) PURE;
 163
 164 };
 165
 166 #endif /* _RMACFG_H_ */