dllaccesclient.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:8k
源码类别:

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: dllaccesclient.h,v 1.1.18.3 2004/07/09 01:43:51 hubbe Exp $
  3.  * 
  4.  * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
  5.  * 
  6.  * The contents of this file, and the files included with this file,
  7.  * are subject to the current version of the RealNetworks Public
  8.  * Source License (the "RPSL") available at
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed
  10.  * the file under the current version of the RealNetworks Community
  11.  * Source License (the "RCSL") available at
  12.  * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
  13.  * will apply. You may also obtain the license terms directly from
  14.  * RealNetworks.  You may not use this file except in compliance with
  15.  * the RPSL or, if you have a valid RCSL with RealNetworks applicable
  16.  * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
  17.  * the rights, obligations and limitations governing use of the
  18.  * contents of the file.
  19.  * 
  20.  * Alternatively, the contents of this file may be used under the
  21.  * terms of the GNU General Public License Version 2 or later (the
  22.  * "GPL") in which case the provisions of the GPL are applicable
  23.  * instead of those above. If you wish to allow use of your version of
  24.  * this file only under the terms of the GPL, and not to allow others
  25.  * to use your version of this file under the terms of either the RPSL
  26.  * or RCSL, indicate your decision by deleting the provisions above
  27.  * and replace them with the notice and other provisions required by
  28.  * the GPL. If you do not delete the provisions above, a recipient may
  29.  * use your version of this file under the terms of any one of the
  30.  * RPSL, the RCSL or the GPL.
  31.  * 
  32.  * This file is part of the Helix DNA Technology. RealNetworks is the
  33.  * developer of the Original Code and owns the copyrights in the
  34.  * portions it created.
  35.  * 
  36.  * This file, and the files included with this file, is distributed
  37.  * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
  38.  * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
  39.  * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
  40.  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
  41.  * ENJOYMENT OR NON-INFRINGEMENT.
  42.  * 
  43.  * Technology Compatibility Kit Test Suite(s) Location:
  44.  *    http://www.helixcommunity.org/content/tck
  45.  * 
  46.  * Contributor(s):
  47.  * 
  48.  * ***** END LICENSE BLOCK ***** */
  49. #ifndef _DLLACCESCLIENT_H_
  50. #define _DLLACCESCLIENT_H_
  51. /************************************************************************
  52.  *  Includes
  53.  */
  54. #include "hxcom.h"
  55. #include "hxdllaccess.h"
  56. #include "dllacces.h"
  57. class DLLAccessClient
  58. {
  59. public:
  60.     /////////////////////////////////////////////////////////////
  61.     // Function: 
  62.     //     DLLAccess
  63.     //
  64.     // Parameters:
  65.     //     None
  66.     //
  67.     // Returns:
  68.     //     Nothing
  69.     //
  70.     // Notes:
  71.     //     Default constructor initializes internal structures for
  72.     //     subsequent call to open()
  73.     //
  74.     DLLAccessClient()
  75. : m_pDllAccessServer(NULL)
  76.     {
  77. ;
  78.     }
  79.     /////////////////////////////////////////////////////////////
  80.     // Function:
  81.     //     DLLAccess
  82.     //
  83.     // Parameters:
  84.     //     dllName - Name of shared library
  85.     //
  86.     // Returns:
  87.     //     Nothing
  88.     //
  89.     // Notes:
  90.     //     Attempts to load library dllName. If unsuccessful, m_curError
  91.     //     is set to DLLAccess::NO_LOAD and platform specific error
  92.     //     info is stored in m_curStringError.
  93.     //     
  94.     DLLAccessClient(const char* dllName, 
  95.     UINT16 nLibType, 
  96.     IUnknown* pContext)
  97. : m_pDllAccessServer(NULL)
  98.     {
  99. open(dllName, nLibType, pContext);
  100.     }
  101.     //////////////////////////////////////////////////////////////
  102.     // Function:
  103.     //     ~DLLAccess
  104.     //
  105.     // Paramters:
  106.     //     None
  107.     //
  108.     // Returns:
  109.     //     Nothing
  110.     //
  111.     // Notes:
  112.     //     Unloads library from memory. See 'close' below.
  113.     //
  114.     ~DLLAccessClient();
  115.     ///////////////////////////////////////////////////////////////
  116.     // Function:
  117.     //     open(const char* dllName)
  118.     //
  119.     // Parameters:
  120.     //     dllName - Name of shared library
  121.     //
  122.     // Returns:
  123.     //     DLLAccess::OK if successful, else DLLAccess::NO_LOAD.
  124.     //     Platform specific error info is stored in m_curStringError.
  125.     //
  126.     // Notes:
  127.     //     
  128.     int open(const char* dllName, 
  129.      UINT16 nLibType, 
  130.      IUnknown* pContext);
  131.     ///////////////////////////////////////////////////////////////
  132.     // Function:
  133.     //     close()
  134.     //
  135.     // Parameters:
  136.     //     none
  137.     //
  138.     // Returns:
  139.     //     DLLAccess::OK if successful, else DLL_ACCESS::NO_LOAD.
  140.     //
  141.     // Notes:
  142.     //     Shared library usage is typically reference counted by the
  143.     //     OS: the library is actually unloaded when the reference count
  144.     //     reaches zero. Thus this call does not guarantee that the 
  145.     //     library will be removed from memory.
  146.     //
  147.     int close()
  148.     {
  149. return (SUCCEEDED(m_pDllAccessServer->Close()) ? 
  150.     DLLAccess::DLL_OK : DLLAccess::NO_LOAD);
  151.     }
  152.     ///////////////////////////////////////////////////////////////
  153.     // Function:
  154.     //     getSymbol(const char* symName)
  155.     //
  156.     // Parameters:
  157.     //     symName: symbol to retrieve from shared library
  158.     //
  159.     // Returns:
  160.     //     ptr to code in library if successful, else returns NULL
  161.     //     and m_curError is set to DLLAccess::BAD_SYMBOL.
  162.     //
  163.     // Notes:
  164.     //
  165.     void* getSymbol(const char* symName)
  166.     {
  167. return m_pDllAccessServer->GetSymbol(symName);
  168.     }
  169.     ///////////////////////////////////////////////////////////////
  170.     // Function:
  171.     //     getError
  172.     //
  173.     // Parameters:
  174.     //     none
  175.     //
  176.     // Returns:
  177.     //     value of m_curError
  178.     //
  179.     // Notes:
  180.     //     none
  181.     //
  182.     int getError()
  183.     {
  184. return m_pDllAccessServer->GetError();
  185.     }
  186.     ///////////////////////////////////////////////////////////////
  187.     // Function:
  188.     //     getErrorString
  189.     //
  190.     // Parameters:
  191.     //     none
  192.     //
  193.     // Returns:
  194.     //     value of m_curErrorString
  195.     //
  196.     // Notes:
  197.     //     none
  198.     //
  199.     const char* getErrorString() 
  200.     { 
  201. return m_pDllAccessServer->GetErrorString();
  202.     }
  203.     ///////////////////////////////////////////////////////////////
  204.     // Function:
  205.     //     getDLLName
  206.     //
  207.     // Parameters:
  208.     //     none
  209.     //
  210.     // Returns:
  211.     //     value of m_DLLName
  212.     //
  213.     // Notes:
  214.     //     none
  215.     //
  216.     const char* getDLLName()
  217.     {
  218. return m_pDllAccessServer->GetDllName();
  219.     }
  220.     ///////////////////////////////////////////////////////////////
  221.     // Function:
  222.     //     getVersion
  223.     //
  224.     // Parameters:
  225.     //     none
  226.     //
  227.     // Returns:
  228.     //     value of m_Version
  229.     //
  230.     // Notes:
  231.     //     none
  232.     //
  233.     const char* getVersion() 
  234.     { 
  235. return m_pDllAccessServer->GetDllVersion();
  236.     }
  237.     static void CreateName(const char* short_name, 
  238.    const char* long_name, 
  239.    char* out_buf,
  240.    UINT32& out_buf_len)
  241.     {
  242. DLLAccess::CreateName(short_name, 
  243.       long_name, 
  244.       out_buf,
  245.       out_buf_len);
  246.     }
  247.     // This overloaded version has been added to allow user to specify major and minor
  248.     // version of the DLL name you are trying to create. It will append major and minor version
  249.     // to the name. If you use the other function, then the major and minor versions of pnmisc
  250.     // will be used. See pnmisc.ver in that case.
  251.     static void CreateName(const char* short_name, 
  252.    const char* long_name, 
  253.    char* out_buf,
  254.    UINT32& out_buf_len, 
  255.    UINT32 nMajor, 
  256.    UINT32 nMinor)
  257.     {
  258. DLLAccess::CreateName(short_name, 
  259.       long_name, 
  260.       out_buf,
  261.       out_buf_len,
  262.       nMajor,
  263.       nMinor);
  264.     }
  265.     ///////////////////////////////////////////////////////////////
  266.     // Function:
  267.     //     isOpen
  268.     //
  269.     // Parameters:
  270.     //     none
  271.     //
  272.     // Returns:
  273.     //     value of m_isOpen
  274.     //
  275.     // Notes:
  276.     //     none
  277.     //
  278.     BOOL isOpen(void)
  279.     { 
  280. return m_pDllAccessServer->IsOpen();
  281.     }
  282.     
  283. private:
  284.     IHXDllAccess* m_pDllAccessServer;
  285. };
  286. #endif // _DLLACCESCLIENT_H_