home *** CD-ROM | disk | FTP | other *** search
/ Tricks of the Windows Gam…ming Gurus (2nd Edition) / Disc2.iso / msdn_vcb / samples / vc98 / sdk / com / tutsamp / dllserve / sample.cpp < prev    next >
C/C++ Source or Header  |  1997-08-05  |  16KB  |  484 lines
  1. /*+==========================================================================
  2.   File:      SAMPLE.CPP
  3.  
  4.   Summary:   Implementation file for the COCarSample sample utility COM
  5.              object.  This object exposes the ISample interface
  6.              that is used to allow better integration of server with
  7.              client as a code sample (eg, set up trace logging from
  8.              server to client's log display).
  9.  
  10.              For a comprehensive tutorial code tour of this module's
  11.              contents and offerings see the tutorial DLLSERVE.HTM file.
  12.              For more specific technical details on the internal workings
  13.              see the comments dispersed throughout the module's source code.
  14.  
  15.   Classes:   COCarSample.
  16.  
  17.   Functions:
  18.  
  19.   Origin:    9-11-95: atrent - Editor-inheritance from COMOBJ.CPP in
  20.                the COMOBJ Tutorial Code Sample.
  21.  
  22. ----------------------------------------------------------------------------
  23.   This file is part of the Microsoft COM Tutorial Code Samples.
  24.  
  25.   Copyright (C) Microsoft Corporation, 1997.  All rights reserved.
  26.  
  27.   This source code is intended only as a supplement to Microsoft
  28.   Development Tools and/or on-line documentation.  See these other
  29.   materials for detailed information regarding Microsoft code samples.
  30.  
  31.   THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
  32.   KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  33.   IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
  34.   PARTICULAR PURPOSE.
  35. ==========================================================================+*/
  36.  
  37. /*---------------------------------------------------------------------------
  38.   We include WINDOWS.H for all Win32 applications.
  39.   We include OLE2.H because we will be calling the COM/OLE Libraries.
  40.   We include APPUTIL.H because we will be building this DLL using
  41.     the convenient Virtual Window and Dialog classes and other
  42.     utility functions in the APPUTIL Library (ie, APPUTIL.LIB).
  43.   We include ICARS.H and CARGUIDS.H for the common car-related Interface
  44.     class, GUID, and CLSID specifications.
  45.   We include SERVER.H for the object class declarations for the
  46.     CServer server control object.
  47.   We include SAMPLE.H for the object class declarations for the
  48.     COCarSample COM object.
  49. ---------------------------------------------------------------------------*/
  50. #include <windows.h>
  51. #include <ole2.h>
  52. #include <apputil.h>
  53. #include <icars.h>
  54. #include <carguids.h>
  55. #include "server.h"
  56. #include "sample.h"
  57.  
  58. /*---------------------------------------------------------------------------
  59.   Implementation the COCarSample COM object.  Used to expose a utility
  60.   server interface for the server as a code sample.  COCarSample exposes
  61.   the ISample interface.
  62. ---------------------------------------------------------------------------*/
  63.  
  64. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  65.   Method:   COCarSample::COCarSample
  66.  
  67.   Summary:  COCarSample Constructor. Note the member initializer:
  68.             "m_ImpISample(this, pUnkOuter, pServer)" which is used to pass
  69.             the 'this', pUnkOuter, and pServer pointers of this
  70.             constructor function to the constructor in the instantiation
  71.             of the implementation of the CImpISample interface (which is
  72.             nested inside this present COCarSample Object Class).
  73.  
  74.   Args:     IUnknown* pUnkOuter,
  75.               Pointer to the the outer Unknown.  NULL means this COM Object
  76.               is not being Aggregated.  Non NULL means it is being created
  77.               on behalf of an outside COM object that is reusing it via
  78.               aggregation.
  79.             CServer* pServer
  80.               Pointer to the server's control object.
  81.  
  82.   Modifies: m_cRefs, m_pUnkOuter.
  83.  
  84.   Returns:  void
  85. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  86. COCarSample::COCarSample(
  87.   IUnknown* pUnkOuter,
  88.   CServer* pServer) :
  89.   m_ImpISample(this, pUnkOuter, pServer)
  90. {
  91.   // Zero the COM object's reference count.
  92.   m_cRefs = 0;
  93.  
  94.   // No AddRef necessary if non-NULL, as we're nested.
  95.   m_pUnkOuter = pUnkOuter;
  96.  
  97.   // Init the pointer to the server's control object.
  98.   m_pServer = pServer;
  99.  
  100.   LOGF1("S: COCarSample Constructor. m_pUnkOuter=0x%X.", m_pUnkOuter);
  101.  
  102.   return;
  103. }
  104.  
  105.  
  106. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  107.   Method:   COCarSample::~COCarSample
  108.  
  109.   Summary:  COCarSample Destructor.
  110.  
  111.   Args:     void
  112.  
  113.   Modifies: .
  114.  
  115.   Returns:  void
  116. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  117. COCarSample::~COCarSample(void)
  118. {
  119.   LOG("S: COCarSample::Destructor.");
  120.  
  121.   return;
  122. }
  123.  
  124.  
  125. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  126.   Method:   COCarSample::QueryInterface
  127.  
  128.   Summary:  QueryInterface of the COCarSample non-delegating
  129.             IUnknown implementation.
  130.  
  131.   Args:     REFIID riid,
  132.               [in] GUID of the Interface being requested.
  133.             PPVOID ppv)
  134.               [out] Address of the caller's pointer variable that will
  135.               receive the requested interface pointer.
  136.  
  137.   Modifies: .
  138.  
  139.   Returns:  HRESULT
  140. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  141. STDMETHODIMP COCarSample::QueryInterface(
  142.                REFIID riid,
  143.                PPVOID ppv)
  144. {
  145.   HRESULT hr = E_NOINTERFACE;
  146.   *ppv = NULL;
  147.  
  148.   if (IID_IUnknown == riid)
  149.   {
  150.     *ppv = this;
  151.     LOG("S: COCarSample::QueryInterface. 'this' pIUnknown returned.");
  152.   }
  153.   else if (IID_ISample == riid)
  154.   {
  155.     *ppv = &m_ImpISample;
  156.     LOG("S: COCarSample::QueryInterface. pISample returned.");
  157.   }
  158.  
  159.   if (NULL != *ppv)
  160.   {
  161.     // We've handed out a pointer to the interface so obey the COM rules
  162.     // and AddRef the reference count.
  163.     ((LPUNKNOWN)*ppv)->AddRef();
  164.     hr = NOERROR;
  165.   }
  166.  
  167.   return (hr);
  168. }
  169.  
  170.  
  171. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  172.   Method:   COCarSample::AddRef
  173.  
  174.   Summary:  AddRef of the COCarSample non-delegating IUnknown implementation.
  175.  
  176.   Args:     void
  177.  
  178.   Modifies: m_cRefs.
  179.  
  180.   Returns:  ULONG
  181.               New value of m_cRefs (COM object's reference count).
  182. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  183. STDMETHODIMP_(ULONG) COCarSample::AddRef(void)
  184. {
  185.   m_cRefs++;
  186.  
  187.   LOGF1("S: COCarSample::AddRef. New cRefs=%i.", m_cRefs);
  188.  
  189.   return m_cRefs;
  190. }
  191.  
  192.  
  193. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  194.   Method:   COCarSample::Release
  195.  
  196.   Summary:  Release of the COCarSample non-delegating IUnknown
  197.             implementation.
  198.  
  199.   Args:     void
  200.  
  201.   Modifies: m_cRefs.
  202.  
  203.   Returns:  ULONG
  204.               New value of m_cRefs (COM object's reference count).
  205. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  206. STDMETHODIMP_(ULONG) COCarSample::Release(void)
  207. {
  208.   m_cRefs--;
  209.  
  210.   LOGF1("S: COCarSample::Release. New cRefs=%i.", m_cRefs);
  211.  
  212.   if (0 == m_cRefs)
  213.   {
  214.     // We've reached a zero reference count for this COM object.
  215.     // So we tell the server housing to decrement its global object
  216.     // count so that the server will be unloaded if appropriate.
  217.     if (NULL != m_pServer)
  218.       m_pServer->ObjectsDown();
  219.  
  220.     // We artificially bump the main ref count to prevent reentrancy
  221.     // via the main object destructor.  Not really needed in this
  222.     // COCarSample but a good practice because we are aggregatable and
  223.     // may at some point in the future add something entertaining like
  224.     // some Releases to the COCarSample destructor.
  225.     m_cRefs++;
  226.     delete this;
  227.   }
  228.  
  229.   return m_cRefs;
  230. }
  231.  
  232.  
  233. /*---------------------------------------------------------------------------
  234.   COCarSample's nested implementation of the ISample interface
  235.   including Constructor, Destructor, QueryInterface, AddRef, Release,
  236.   Init, and AboutBox methods.
  237. ---------------------------------------------------------------------------*/
  238.  
  239. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  240.   Method:   COCarSample::CImpISample::CImpISample
  241.  
  242.   Summary:  Constructor for the CImpISample interface instantiation.
  243.  
  244.   Args:     COCarSample* pBackObj,
  245.               Back pointer to the parent outer object.
  246.             IUnknown* pUnkOuter,
  247.               Pointer to the outer Unknown.  For delegation.
  248.             CServer* pServer)
  249.               Pointer to the server's control object.
  250.  
  251.   Modifies: m_cRefI, m_pBackObj, m_pUnkOuter, m_pServer.
  252.  
  253.   Returns:  void
  254. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  255. COCarSample::CImpISample::CImpISample(
  256.   COCarSample* pBackObj,
  257.   IUnknown* pUnkOuter,
  258.   CServer* pServer)
  259. {
  260.   // Init the Interface Ref Count (used for debugging only).
  261.   m_cRefI = 0;
  262.  
  263.   // Init the Back Object Pointer to point to the outer object.
  264.   m_pBackObj = pBackObj;
  265.  
  266.   // Init the pointer to the server control object.
  267.   m_pServer = pServer;
  268.  
  269.   // Init the CImpISample interface's delegating Unknown pointer.  We use
  270.   // the Back Object pointer for IUnknown delegation here if we are not
  271.   // being aggregated.  If we are being aggregated we use the supplied
  272.   // pUnkOuter for IUnknown delegation.  In either case the pointer
  273.   // assignment requires no AddRef because the CImpISample lifetime is
  274.   // quaranteed by the lifetime of the parent object in which
  275.   // CImpISample is nested.
  276.   if (NULL == pUnkOuter)
  277.   {
  278.     m_pUnkOuter = pBackObj;
  279.     LOG("S: COCarSample::CImpISample Constructor. Non-Aggregating.");
  280.   }
  281.   else
  282.   {
  283.     m_pUnkOuter = pUnkOuter;
  284.     LOG("S: COCarSample::CImpISample Constructor. Aggregating.");
  285.   }
  286.  
  287.   return;
  288. }
  289.  
  290.  
  291. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  292.   Method:   COCarSample::CImpISample::~CImpISample
  293.  
  294.   Summary:  Destructor for the CImpISample interface instantiation.
  295.  
  296.   Args:     void
  297.  
  298.   Modifies: .
  299.  
  300.   Returns:  void
  301. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  302. COCarSample::CImpISample::~CImpISample(void)
  303. {
  304.   LOG("S: COCarSample::CImpISample Destructor.");
  305.  
  306.   return;
  307. }
  308.  
  309.  
  310. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  311.   Method:   COCarSample::CImpISample::QueryInterface
  312.  
  313.   Summary:  The QueryInterface IUnknown member of this ISample interface
  314.             implementation that delegates to m_pUnkOuter, whatever it is.
  315.  
  316.   Args:     REFIID riid,
  317.               [in] GUID of the Interface being requested.
  318.             PPVOID ppv)
  319.               [out] Address of the caller's pointer variable that will
  320.               receive the requested interface pointer.
  321.  
  322.   Modifies: .
  323.  
  324.   Returns:  HRESULT
  325.               Returned by the delegated outer QueryInterface call.
  326. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  327. STDMETHODIMP COCarSample::CImpISample::QueryInterface(
  328.                REFIID riid,
  329.                PPVOID ppv)
  330. {
  331.   LOG("S: COCarSample::CImpISample::QueryInterface. Delegating.");
  332.  
  333.   // Delegate this call to the outer object's QueryInterface.
  334.   return m_pUnkOuter->QueryInterface(riid, ppv);
  335. }
  336.  
  337.  
  338. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  339.   Method:   COCarSample::CImpISample::AddRef
  340.  
  341.   Summary:  The AddRef IUnknown member of this ISample interface
  342.             implementation that delegates to m_pUnkOuter, whatever it is.
  343.  
  344.   Args:     void
  345.  
  346.   Modifies: m_cRefI.
  347.  
  348.   Returns:  ULONG
  349.               Returned by the delegated outer AddRef call.
  350. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  351. STDMETHODIMP_(ULONG) COCarSample::CImpISample::AddRef(void)
  352. {
  353.   // Increment the Interface Reference Count.
  354.   ++m_cRefI;
  355.  
  356.   LOGF1("S: COCarSample::CImpISample::Addref. Delegating. New cI=%i.", m_cRefI);
  357.  
  358.   // Delegate this call to the outer object's AddRef.
  359.   return m_pUnkOuter->AddRef();
  360. }
  361.  
  362.  
  363. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  364.   Method:   COCarSample::CImpISample::Release
  365.  
  366.   Summary:  The Release IUnknown member of this ISample interface
  367.             implementation that delegates to m_pUnkOuter, whatever it is.
  368.  
  369.   Args:     void
  370.  
  371.   Modifies: .
  372.  
  373.   Returns:  ULONG
  374.               Returned by the delegated outer Release call.
  375. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  376. STDMETHODIMP_(ULONG) COCarSample::CImpISample::Release(void)
  377. {
  378.   // Decrement the Interface Reference Count.
  379.   --m_cRefI;
  380.  
  381.   LOGF1("S: COCarSample::CImpISample::Release. Delegating. New cI=%i.", m_cRefI);
  382.  
  383.   // Delegate this call to the outer object's Release.
  384.   return m_pUnkOuter->Release();
  385. }
  386.  
  387.  
  388. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  389.   Method:   COCarSample::CImpISample::Init
  390.  
  391.   Summary:  Initialize the COCarSample object to enable trace logging
  392.             from server to client.  This includes passing in a pointer
  393.             that points the Client EXE's MsgLog facility so that the
  394.             LOG* trace logging macros in the server will be logged in
  395.             the Client's message log window.
  396.  
  397.   Args:     HWND hWndParent
  398.               [in] Handle of a client's parent owning window.
  399.             PVOID pvMsgLog
  400.               [in] Pointer to the Client's MsgLog object.  If NULL
  401.               then setup independent logging window for this DLL.
  402.  
  403.   Modifies: .
  404.  
  405.   Returns:  HRESULT
  406.               Standard result code. NOERROR for success.
  407. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  408. STDMETHODIMP COCarSample::CImpISample::Init(
  409.                HWND hWndParent,
  410.                PVOID pvMsgLog)
  411. {
  412.   HRESULT hr = NOERROR;
  413.  
  414.   // Init this DLL's MsgBox facility.
  415.   g_pServer->m_pMsgBox->Init(g_pServer->m_hDllInst, hWndParent);
  416.  
  417.   if (NULL != pvMsgLog)
  418.   {
  419.     // Set up a pointer to the client EXE's Message Log facility so
  420.     // that any LOG macros used in this DLL will log to the host EXE's
  421.     // log window.
  422.     g_pMsgLog = (CMsgLog *)pvMsgLog;
  423.     LOG("S: --- DLLSERVE.DLL now logging to Client ---");
  424.   }
  425.   else
  426.   {
  427.     // But if pvMsgLog is passed in as NULL then Create an independent
  428.     // logging facility for this DLL (use the client EXE's main window
  429.     // as the parent window).
  430.     CMsgLog* pMsgLog = new CMsgLog;
  431.  
  432.     if (NULL != pMsgLog)
  433.     {
  434.       if (pMsgLog->Create(g_pServer->m_hDllInst, hWndParent, FALSE))
  435.       {
  436.         g_pMsgLog = pMsgLog;
  437.         LOG("S: --- DLLSERVE.DLL now logging ---");
  438.       }
  439.       else
  440.         delete pMsgLog;
  441.     }
  442.   }
  443.  
  444.   return hr;
  445. }
  446.  
  447.  
  448. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  449.   Method:   COCarSample::CImpISample::AboutBox
  450.  
  451.   Summary:  The AboutBox method commands the Server to display its own
  452.             About dialog box (using resources stored in this DLL itself.
  453.  
  454.   Args:     HWND hWnd
  455.               [in] Handle of window (ie of client) that is to be parent of
  456.               the About dialog window.
  457.  
  458.   Modifies: .
  459.  
  460.   Returns:  HRESULT
  461.               Standard result code.
  462. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  463. HRESULT COCarSample::CImpISample::AboutBox(
  464.           HWND hWnd)
  465. {
  466.   HRESULT hr = NOERROR;
  467.  
  468.   LOG("S: COCarSample::CImpISample::AboutBox.");
  469.  
  470.   // Define one of those nifty APPUTIL CAboutBox modal dialog objects.
  471.   CAboutBox dlgAboutBox;
  472.  
  473.   // Show the standard About Box dialog for this DLL by telling the dialog
  474.   // C++ object to show itself by invoking its ShowDialog method.
  475.   // Pass it this DLL instance and the parent window handle.  Use a dialog
  476.   // resource ID for the dialog stored in this DLL module's resources.
  477.   dlgAboutBox.ShowDialog(
  478.     m_pServer->m_hDllInst,
  479.     MAKEINTRESOURCE(IDD_ABOUTBOX),
  480.     hWnd);
  481.  
  482.   return hr;
  483. }
  484.