hxclreg.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:11k
源码类别:

Symbian

开发平台:

C/C++

  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  35. #ifndef _HXCLIENTREG_H_
  36. #define _HXCLIENTREG_H_
  37. struct IHXRegistry;
  38. class  CommonRegistry;
  39. class HXClientRegistry : public IHXRegistry
  40. {
  41. protected:
  42.     virtual ~HXClientRegistry();
  43.     PRIVATE_DESTRUCTORS_ARE_NOT_A_CRIME
  44.     LONG32 m_lRefCount;
  45.     CommonRegistry* m_pPropDB;
  46.     IUnknown* m_pContext;
  47. public:
  48.     HXClientRegistry();
  49.     void Init    (IUnknown* pContext);
  50.     void Close   (void);
  51.     /*
  52.      * IUnknown methods
  53.      */
  54.     STDMETHOD(QueryInterface) (THIS_
  55. REFIID riid,
  56. void** ppvObj);
  57.     STDMETHOD_(ULONG32,AddRef) (THIS);
  58.     STDMETHOD_(ULONG32,Release) (THIS);
  59.     /*
  60.      * IHXRegistry methods
  61.      */
  62.     /************************************************************************
  63.      *  Method:
  64.      *      IHXRegistry::CreatePropWatch
  65.      *  Purpose:
  66.      *      Create a new IUnknown object which can then be queried for the
  67.      *  right kind of IHXPropWatch object.
  68.      */
  69.     STDMETHOD(CreatePropWatch) (THIS_
  70. REF(IHXPropWatch*) pPropWatch);
  71.     /************************************************************************
  72.      *  Method:
  73.      *      HXRegistry::AddComp
  74.      *  Purpose:
  75.      *      Add a COMPOSITE property to the registry and return its hash
  76.      *  key value if successful. It returns ZERO (0) if an error occured
  77.      *  during the operation.
  78.      */
  79.     STDMETHOD_(UINT32, AddComp) (THIS_
  80. const char* pName);
  81.     /************************************************************************
  82.      *  Method:
  83.      *      HXRegistry::AddInt
  84.      *  Purpose:
  85.      *      Add an INTEGER property with name in "pName" and value in 
  86.      *  "iValue" to the registry. The return value is the id to
  87.      *  the newly added Property or ZERO if there was an error.
  88.      */
  89.     STDMETHOD_(UINT32, AddInt) (THIS_
  90. const char* pName, 
  91. const INT32 iValue);
  92.     /************************************************************************
  93.      *  Method:
  94.      *      HXRegistry::GetInt
  95.      *  Purpose:
  96.      *      Retreive an INTEGER value from the registry given its Property
  97.      *  name "pName" or by its id "id". If the Property 
  98.      *  is found, it will return HXR_OK, otherwise it returns HXR_FAIL.
  99.      */
  100.     STDMETHOD(GetIntByName) (THIS_
  101. const char* pName,
  102. REF(INT32) nValue) const;
  103.     STDMETHOD(GetIntById) (THIS_
  104. const UINT32 id,
  105. REF(INT32) nValue) const;
  106.     /************************************************************************
  107.      *  Method:
  108.      *      HXRegistry::SetIntByXYZ
  109.      *  Purpose:
  110.      *      Modify a Property's INTEGER value in the registry given the
  111.      *  Property's name "pName" or its id "id". If the value 
  112.      *  was set, it will return HXR_OK, otherwise it returns HXR_FAIL.
  113.      */
  114.     STDMETHOD(SetIntByName) (THIS_
  115. const char* pName, 
  116. const INT32 iValue);
  117.     STDMETHOD(SetIntById) (THIS_
  118. const UINT32 id,
  119. const INT32 iValue);
  120.     /************************************************************************
  121.      *  Method:
  122.      *      HXRegistry::AddStr
  123.      *  Purpose:
  124.      *      Add an STRING property with name in "pName" and value in 
  125.      *  "pcValue" to the registry.
  126.      */
  127.     STDMETHOD_(UINT32, AddStr) (THIS_
  128. const char* pName, 
  129. IHXBuffer* pValue);
  130.     /************************************************************************
  131.      *  Method:
  132.      *      HXRegistry::GetStrByXYZ
  133.      *  Purpose:
  134.      *      Retreive an STRING value from the registry given its Property
  135.      *  name "pName" or by its id "id". If the Property 
  136.      *  is found, it will return HXR_OK, otherwise it returns HXR_FAIL.
  137.      */
  138.     STDMETHOD(GetStrByName) (THIS_
  139. const char*     pName,
  140. REF(IHXBuffer*)    pValue) const;
  141.     STDMETHOD(GetStrById) (THIS_
  142. const UINT32     id,
  143. REF(IHXBuffer*)    pValue) const;
  144.     /************************************************************************
  145.      *  Method:
  146.      *      HXRegistry::SetStrByXYZ
  147.      *  Purpose:
  148.      *      Modify a Property's STRING value in the registry given the
  149.      *  Property's name "pName" or its id "id". If the value 
  150.      *  was set, it will return HXR_OK, otherwise it returns HXR_FAIL.
  151.      */
  152.     STDMETHOD(SetStrByName) (THIS_
  153. const char* pName, 
  154. IHXBuffer* pValue);
  155.     STDMETHOD(SetStrById) (THIS_
  156. const UINT32 id,
  157. IHXBuffer* pValue);
  158.     /************************************************************************
  159.      *  Method:
  160.      *      HXRegistry::AddBuf
  161.      *  Purpose:
  162.      *      Add an BUFFER property with name in "pName" and value in 
  163.      *  "pValue" to the registry.
  164.      */
  165.     STDMETHOD_(UINT32, AddBuf) (THIS_
  166. const char* pName, 
  167. IHXBuffer* pValue);
  168.     /************************************************************************
  169.      *  Method:
  170.      *      HXRegistry::GetStrByXYZ
  171.      *  Purpose:
  172.      *      Retreive the BUFFER from the registry given its Property
  173.      *  name "pName" or its id "id". If the Property 
  174.      *  is found, it will return HXR_OK, otherwise it returns HXR_FAIL.
  175.      */
  176.     STDMETHOD(GetBufByName) (THIS_
  177. const char* pName,
  178. REF(IHXBuffer*) ppValue) const;
  179.     STDMETHOD(GetBufById) (THIS_
  180. const UINT32 id,
  181. REF(IHXBuffer*) ppValue) const;
  182.     /************************************************************************
  183.      *  Method:
  184.      *      HXRegistry::SetBufByXYZ
  185.      *  Purpose:
  186.      *      Modify a Property's BUFFER in the registry given the
  187.      *  Property's name "pName" or its id "id". If the value 
  188.      *  was set, it will return HXR_OK, otherwise it returns HXR_FAIL.
  189.      */
  190.     STDMETHOD(SetBufByName) (THIS_
  191. const char* pName, 
  192. IHXBuffer* pValue);
  193.     STDMETHOD(SetBufById) (THIS_
  194. const UINT32 id,
  195. IHXBuffer* pValue);
  196.     /************************************************************************
  197.      *  Method:
  198.      *      HXRegistry::AddIntRef
  199.      *  Purpose:
  200.      *      Add an INTEGER REFERENCE property with name in "pName" and 
  201.      *  value in "iValue" to the registry. This property allows the user
  202.      *  to modify its contents directly, without having to go through the
  203.      *  registry.
  204.      */
  205.     STDMETHOD_(UINT32, AddIntRef) (THIS_
  206. const char* pName, 
  207. INT32*   piValue);
  208.     /************************************************************************
  209.      *  Method:
  210.      *      HXRegistry::DeleteByXYZ
  211.      *  Purpose:
  212.      *      Delete a Property from the registry using its name "pName"
  213.      *  or id "id".
  214.      */
  215.     STDMETHOD_(UINT32, DeleteByName) (THIS_
  216. const char* pName);
  217.     STDMETHOD_(UINT32, DeleteById) (THIS_
  218. const UINT32 id);
  219.     /************************************************************************
  220.      *  Method:
  221.      *      HXRegistry::GetTypeByXYZ
  222.      *  Purpose:
  223.      *      Returns the datatype of the Property given its name "pName"
  224.      *  or its id "id".
  225.      */
  226.     STDMETHOD_(HXPropType, GetTypeByName) (THIS_
  227. const char* pName) const;
  228.     STDMETHOD_(HXPropType, GetTypeById) (THIS_
  229. const UINT32 id) const;
  230.     /************************************************************************
  231.      *  Method:
  232.      *      HXRegistry::FindParentIdByXYZ
  233.      *  Purpose:
  234.      *      Returns the id value of the parent node if it exists.
  235.      *  If it fails, a ZERO value is returned.
  236.      */
  237.     STDMETHOD_(UINT32, FindParentIdByName) (THIS_
  238. const char* pName) const;
  239.     STDMETHOD_(UINT32, FindParentIdById) (THIS_
  240. const UINT32 id) const;
  241.     /************************************************************************
  242.      *  Method:
  243.      *      HXRegistry::GetPropName
  244.      *  Purpose:
  245.      *      Returns the Property name in the pName char buffer passed
  246.      *  as a parameter, given the Property's id "ulId".
  247.      */
  248.     STDMETHOD(GetPropName) (THIS_
  249. const UINT32 ulId,
  250. REF(IHXBuffer*) pName) const;
  251.     /************************************************************************
  252.      *  Method:
  253.      *      HXRegistry::GetId
  254.      *  Purpose:
  255.      *      Returns the Property's id given the Property name.
  256.      */
  257.     STDMETHOD_(UINT32, GetId) (THIS_
  258. const char* pName) const;
  259.     /************************************************************************
  260.      *  Method:
  261.      *      IHXRegistry::GetPropListOfRoot
  262.      *  Purpose:
  263.      *      Returns an array of a Properties under the root level of the 
  264.      *  registry's hierarchy.
  265.      */
  266.     STDMETHOD(GetPropListOfRoot)  (THIS_
  267. REF(IHXValues*) pValues) const;
  268.     /************************************************************************
  269.      *  Method:
  270.      *      IHXRegistry::GetPropListByXYZ
  271.      *  Purpose:
  272.      *      Returns an array of Properties immediately under the one with
  273.      *  name "pName" or id "id".
  274.      */
  275.     STDMETHOD(GetPropListByName)  (THIS_
  276.  const char* pName,
  277.  REF(IHXValues*) pValues) const;
  278.     STDMETHOD(GetPropListById)    (THIS_
  279.  const UINT32 id,
  280.  REF(IHXValues*) pValues) const;
  281.     /************************************************************************
  282.      *  Method:
  283.      *      HXRegistry::GetNumProps
  284.      *  Purpose:
  285.      *      Returns the count of the number of Properties within the
  286.      *  registry. If a property name of id is specified, then it
  287.      *  returns the number of Properties under it.
  288.      */
  289.     STDMETHOD_(INT32, GetNumPropsAtRoot) (THIS) const;
  290.     STDMETHOD_(INT32, GetNumPropsByName)(THIS_
  291. const char* pName) const;
  292.     STDMETHOD_(INT32, GetNumPropsById) (THIS_
  293. const UINT32 id) const;
  294. };
  295. #endif /*_HXCLIENTREG_H_*/