CRUCAR.CPP
上传用户:bangxh
上传日期:2007-01-31
资源大小:42235k
文件大小:17k
源码类别:

Windows编程

开发平台:

Visual C++

  1. /*+==========================================================================
  2.   File:      CRUCAR.CPP
  3.   Summary:   Implementation file for the aggregatable COCruiseCar COM
  4.              object class.
  5.              CRUCAR showcases the construction of the COCruiseCar COM
  6.              object class with the IUnknown, ICar, and ICruise interfaces.
  7.              This is done through Aggregation reuse of COCar's ICar
  8.              interface features.  This multiple interface COM Object Class
  9.              is achieved via the technique of nested classes.
  10.              For a comprehensive tutorial code tour of this module's
  11.              contents and offerings see the tutorial LOCSERVE.HTM file.
  12.              For more specific technical details on the internal workings
  13.              see the comments dispersed throughout the module's source code.
  14.   Classes:   COCruiseCar.
  15.   Functions: none.
  16.   Origin:    11-14-95: atrent - Editor-inheritance from CRUCAR.CPP in
  17.                the DLLSERVE Tutorial Code Sample.
  18. ----------------------------------------------------------------------------
  19.   This file is part of the Microsoft COM Tutorial Code Samples.
  20.   Copyright (C) Microsoft Corporation, 1997.  All rights reserved.
  21.   This source code is intended only as a supplement to Microsoft
  22.   Development Tools and/or on-line documentation.  See these other
  23.   materials for detailed information regarding Microsoft code samples.
  24.   THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
  25.   KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  26.   IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
  27.   PARTICULAR PURPOSE.
  28. ==========================================================================+*/
  29. /*---------------------------------------------------------------------------
  30.   We include WINDOWS.H for all Win32 applications.
  31.   We include OLE2.H because we will be calling the COM/OLE Libraries.
  32.   We include APPUTIL.H because we will be building this application using
  33.     the convenient Virtual Window and Dialog classes and other
  34.     utility functions in the APPUTIL Library (ie, APPUTIL.LIB).
  35.   We include MICARS.H and CARGUIDS.H for the common car-related Interface
  36.     class, GUID, and CLSID specifications.
  37.   We include SERVER.H because it has the necessary internal class and
  38.     resource definitions for this DLL.
  39.   We include CAR.H because it has the class COCar declarations.
  40.   We include CRUCAR.H because it has the class COCruiseCar declarations.
  41. ---------------------------------------------------------------------------*/
  42. #include <windows.h>
  43. #include <ole2.h>
  44. #include <apputil.h>
  45. #include <micars.h>
  46. #include <carguids.h>
  47. #include "server.h"
  48. #include "car.h"
  49. #include "crucar.h"
  50. /*---------------------------------------------------------------------------
  51.   COCruiseCar's implementation of its main COM object class including
  52.   Constructor, Destructor, QueryInterface, AddRef, and Release.
  53. ---------------------------------------------------------------------------*/
  54. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  55.   Method:   COCruiseCar::COCruiseCar
  56.   Summary:  COCruiseCar Constructor. Note the member initializer:
  57.             "m_ImpICruise(this, pUnkOuter)" which is used to pass the
  58.             'this' and pUnkOuter pointers of this constructor function
  59.             to the constructor in the instantiation of the implementation
  60.             of the CImpICruise interface (which is nested inside this
  61.             present COCruiseCar Object Class).
  62.   Args:     IUnknown* pUnkOuter,
  63.               Pointer to the the outer Unknown.  NULL means this COM Object
  64.               is not being Aggregated.  Non NULL means it is being created
  65.               on behalf of an outside COM object that is reusing it via
  66.               aggregation.
  67.             CServer* pServer)
  68.               Pointer to the server's control object.
  69.   Modifies: m_cRefs, m_pUnkOuter.
  70.   Returns:  void
  71. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  72. COCruiseCar::COCruiseCar(
  73.   IUnknown* pUnkOuter,
  74.   CServer* pServer) :
  75.   m_ImpICruise(this, pUnkOuter)
  76. {
  77.   // Zero the COM object's reference count.
  78.   m_cRefs = 0;
  79.   // No AddRef necessary if non-NULL, as this present COM object's lifetime
  80.   // is totally coupled with the controlling Outer object's lifetime.
  81.   m_pUnkOuter = pUnkOuter;
  82.   // Zero the pointer to the aggregated COCar object's IUnknown
  83.   // interface (for delegation of IUnknown calls to it).
  84.   m_pUnkCar = NULL;
  85.   // Assign the pointer to the server's control object.
  86.   m_pServer = pServer;
  87.   LOGF1("L: COCruiseCar Constructor. m_pUnkOuter=0x%X.", m_pUnkOuter);
  88.   return;
  89. }
  90. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  91.   Method:   COCruiseCar::~COCruiseCar
  92.   Summary:  COCruiseCar Destructor.
  93.   Args:     void
  94.   Modifies: .
  95.   Returns:  void
  96. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  97. COCruiseCar::~COCruiseCar(void)
  98. {
  99.   LOG("L: COCruiseCar::Destructor.");
  100.   // Release the aggragated COCar object.
  101.   RELEASE_INTERFACE(m_pUnkCar);
  102.   return;
  103. }
  104. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  105.   Method:   COCruiseCar::Init
  106.   Summary:  COCruiseCar Initialization method.  Creates any subordinate
  107.             COM objects.
  108.   Args:     void
  109.   Modifies: m_pUnkCar, m_pICar, m_cRefs.
  110.   Returns:  HRESULT
  111.               Standard result code. NOERROR for success.
  112. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  113. HRESULT COCruiseCar::Init(void)
  114. {
  115.   HRESULT hr;
  116.   LOG("L: COCruiseCar::Init.");
  117.   // Set up the right pIUnknown for delegation.  If we are being
  118.   // aggregated then we pass the pUnkOuter in turn to any COM objects
  119.   // that we are aggregating.  m_pUnkOuter was set in the Constructor.
  120.   IUnknown* pUnkOuter = (NULL == m_pUnkOuter) ? this : m_pUnkOuter;
  121.   // We create an instance of the COCar object and do this via the
  122.   // Aggregation reuse technique.  Note we pass pUnkOuter as the
  123.   // Aggregation pointer.  It is the 'this' pointer to this present
  124.   // CruiseCar object if we are not being aggregated; otherwise it is the
  125.   // pointer to the outermost object's controlling IUnknown.  Following
  126.   // the rules of Aggregation we must ask for an IID_IUnknown interface.
  127.   // We cache the requested  pointer to the IUnknown of the new COCar COM
  128.   // object for later use in delegating IUnknown calls. Since we know that
  129.   // this LocCar component is housed in this very same server, we can
  130.   // specify an execution context of CLSCTX_INPROC_SERVER. This allows us
  131.   // to aggregate the COCar COM object. Though the object is in a local
  132.   // server, it will be instantiated and run within the same process of
  133.   // this present local server. If we specify CLSCTX_LOCAL_SERVER, COM
  134.   // will not currently permit the creation using aggregation across
  135.   // process boundaries and CoCreateInstance would return an error.
  136.   hr = CoCreateInstance(
  137.          CLSID_LocCar,
  138.          pUnkOuter,
  139.          CLSCTX_INPROC_SERVER,
  140.          IID_IUnknown,
  141.          (PPVOID)&m_pUnkCar);
  142.   if (SUCCEEDED(hr))
  143.   {
  144.     LOG("L: COCruiseCar::Init (New Aggregation of COCar) Succeeded.");
  145.   }
  146.   else
  147.   {
  148.     LOGERROR("L: COCruiseCar::Init (New Containment of COCar)",hr);
  149.   }
  150.   return (hr);
  151. }
  152. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  153.   Method:   COCruiseCar::QueryInterface
  154.   Summary:  QueryInterface of the COCruiseCar non-delegating
  155.             IUnknown implementation.
  156.   Args:     REFIID riid,
  157.               [in] GUID of the Interface being requested.
  158.             PPVOID ppv)
  159.               [out] Address of the caller's pointer variable that will
  160.               receive the requested interface pointer.
  161.   Modifies: *ppv.
  162.   Returns:  HRESULT
  163. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  164. STDMETHODIMP COCruiseCar::QueryInterface(
  165.                REFIID riid,
  166.                PPVOID ppv)
  167. {
  168.   HRESULT hr = E_NOINTERFACE;
  169.   *ppv = NULL;
  170.   if (IID_IUnknown == riid)
  171.   {
  172.     *ppv = this;
  173.     LOG("L: COCruiseCar::QueryInterface. 'this' pIUnknown returned.");
  174.   }
  175.   else if (IID_ICruise == riid)
  176.   {
  177.     // This ICruise interface is implemented in this COCruiseCar object and
  178.     // might be called a native interface of COCruiseCar.
  179.     *ppv = &m_ImpICruise;
  180.     LOG("L: COCruiseCar::QueryInterface. pICruise returned.");
  181.   }
  182.   if (NULL != *ppv)
  183.   {
  184.     // We've handed out a pointer to an interface so obey the COM rules
  185.     //   and AddRef its reference count.
  186.     ((LPUNKNOWN)*ppv)->AddRef();
  187.     hr = NOERROR;
  188.   }
  189.   else if (IID_ICar == riid)
  190.   {
  191.     LOG("L: COCruiseCar::QueryInterface. ICar delegating.");
  192.     // We didn't implement the ICar interface in this COCruiseCar object.
  193.     // The aggregated inner COCar object is contributing the ICar
  194.     // interface to this present composite or aggregating CruiseCar object.
  195.     // So, to satisfy a QI request for the ICar interface, we delegate
  196.     // the QueryInterface to the inner object's principal IUnknown.
  197.     hr = m_pUnkCar->QueryInterface(riid, ppv);
  198.   }
  199.   return (hr);
  200. }
  201. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  202.   Method:   COCruiseCar::AddRef
  203.   Summary:  AddRef of the COCruiseCar non-delegating IUnknown implementation.
  204.   Args:     void
  205.   Modifies: m_cRefs.
  206.   Returns:  ULONG
  207.               New value of m_cRefs (COM object's reference count).
  208. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  209. STDMETHODIMP_(ULONG) COCruiseCar::AddRef(void)
  210. {
  211.   m_cRefs++;
  212.   LOGF1("L: COCruiseCar::AddRef. New cRefs=%i.", m_cRefs);
  213.   return m_cRefs;
  214. }
  215. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  216.   Method:   COCruiseCar::Release
  217.   Summary:  Release of the COCruiseCar non-delegating IUnknown
  218.             implementation.
  219.   Args:     void
  220.   Modifies: m_cRefs.
  221.   Returns:  ULONG
  222.               New value of m_cRefs (COM object's reference count).
  223. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  224. STDMETHODIMP_(ULONG) COCruiseCar::Release(void)
  225. {
  226.   ULONG ulCount = --m_cRefs;
  227.   LOGF1("L: COCruiseCar::Release. New cRefs=%i.", m_cRefs);
  228.   if (0 == m_cRefs)
  229.   {
  230.     // We've reached a zero reference count for this COM object.
  231.     // So we tell the server housing to decrement its global object
  232.     // count so that the server will be unloaded if appropriate.
  233.     if (NULL != m_pServer)
  234.       m_pServer->ObjectsDown();
  235.     // We artificially bump the main ref count.  This fulfills one of
  236.     // the rules of aggregated objects and ensures that an indirect
  237.     // recursive call to this release won't occur because of other
  238.     // delegating releases that might happen in our own destructor.
  239.     m_cRefs++;
  240.     delete this;
  241.   }
  242.   return ulCount;
  243. }
  244. /*---------------------------------------------------------------------------
  245.   COCruiseCar's nested implementation of the ICruise interface including
  246.   Constructor, Destructor, QueryInterface, AddRef, Release,
  247.   Engage, and Adjust.
  248. ---------------------------------------------------------------------------*/
  249. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  250.   Method:   COCruiseCar::CImpICruise::CImpICruise
  251.   Summary:  Constructor for the CImpICruise interface instantiation.
  252.   Args:     COCruiseCar* pBackObj,
  253.               Back pointer to the parent outer object.
  254.             IUnknown* pUnkOuter)
  255.               Pointer to the outer Unknown.  For delegation.
  256.   Modifies: m_cRefI, m_pBackObj, m_pUnkOuter.
  257.   Returns:  void
  258. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  259. COCruiseCar::CImpICruise::CImpICruise(
  260.   COCruiseCar* pBackObj,
  261.   IUnknown* pUnkOuter)
  262. {
  263.   // Init the Interface Ref Count (used for debugging only).
  264.   m_cRefI = 0;
  265.   // Init the Back Object Pointer to point to the outer object.
  266.   m_pBackObj = pBackObj;
  267.   // Init the CImpICruise interface's delegating Unknown pointer.  We use
  268.   // the Back Object pointer for IUnknown delegation here if we are not
  269.   // being aggregated.  If we are being aggregated we use the supplied
  270.   // pUnkOuter for IUnknown delegation.  In either case the pointer
  271.   // assignment requires no AddRef because the CImpICruise lifetime is
  272.   // quaranteed by the lifetime of the parent object in which
  273.   // CImpICruise is nested.
  274.   if (NULL == pUnkOuter)
  275.   {
  276.     m_pUnkOuter = pBackObj;
  277.     LOG("L: COCruiseCar::CImpICruise Constructor. Non-Aggregating.");
  278.   }
  279.   else
  280.   {
  281.     m_pUnkOuter = pUnkOuter;
  282.     LOG("L: COCruiseCar::CImpICruise Constructor. Aggregating.");
  283.   }
  284.   return;
  285. }
  286. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  287.   Method:   COCruiseCar::CImpICruise::~CImpICruise
  288.   Summary:  Destructor for the CImpICruise interface instantiation.
  289.   Args:     void
  290.   Modifies: .
  291.   Returns:  void
  292. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  293. COCruiseCar::CImpICruise::~CImpICruise(void)
  294. {
  295.   LOG("L: COCruiseCar::CImpICruise Destructor.");
  296.   return;
  297. }
  298. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  299.   Method:   COCruiseCar::CImpICruise::QueryInterface
  300.   Summary:  The QueryInterface IUnknown member of this ICruise interface
  301.             implementation that delegates to m_pUnkOuter, whatever it is.
  302.   Args:     REFIID riid,
  303.               [in] GUID of the Interface being requested.
  304.             PPVOID ppv)
  305.               [out] Address of the caller's pointer variable that will
  306.               receive the requested interface pointer.
  307.   Modifies: .
  308.   Returns:  HRESULT
  309.               Returned by the delegated outer QueryInterface call.
  310. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  311. STDMETHODIMP COCruiseCar::CImpICruise::QueryInterface(
  312.                REFIID riid,
  313.                PPVOID ppv)
  314. {
  315.   LOG("L: COCruiseCar::CImpICruise::QueryInterface. Delegating.");
  316.   // Delegate this call to the outer object's QueryInterface.
  317.   return m_pUnkOuter->QueryInterface(riid, ppv);
  318. }
  319. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  320.   Method:   COCruiseCar::CImpICruise::AddRef
  321.   Summary:  The AddRef IUnknown member of this ICruise interface
  322.             implementation that delegates to m_pUnkOuter, whatever it is.
  323.   Args:     void
  324.   Modifies: m_cRefI.
  325.   Returns:  ULONG
  326.               Returned by the delegated outer AddRef call.
  327. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  328. STDMETHODIMP_(ULONG) COCruiseCar::CImpICruise::AddRef(void)
  329. {
  330.   // Increment the Interface Reference Count.
  331.   ++m_cRefI;
  332.   LOGF1("L: COCruiseCar::CImpICruise::Addref. Delegating. New cI=%i.", m_cRefI);
  333.   // Delegate this call to the outer object's AddRef.
  334.   return m_pUnkOuter->AddRef();
  335. }
  336. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  337.   Method:   COCruiseCar::CImpICruise::Release
  338.   Summary:  The Release IUnknown member of this ICruise interface
  339.             implementation that delegates to m_pUnkOuter, whatever it is.
  340.   Args:     void
  341.   Modifies: m_cRefI.
  342.   Returns:  ULONG
  343.               Returned by the delegated outer Release call.
  344. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  345. STDMETHODIMP_(ULONG) COCruiseCar::CImpICruise::Release(void)
  346. {
  347.   // Decrement the Interface Reference Count.
  348.   --m_cRefI;
  349.   LOGF1("L: COCruiseCar::CImpICruise::Release. Delegating. New cI=%i.",m_cRefI);
  350.   // Delegate this call to the outer object's Release.
  351.   return m_pUnkOuter->Release();
  352. }
  353. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  354.   Method:   COCruiseCar::CImpICruise::Engage
  355.   Summary:  The Engage member method of this ICruise interface
  356.             implementation.  A simple empty method on a COCruiseCar COM
  357.             object for tutorial purposes.  Presumably if this Car object
  358.             were modeling a real Car then the Engage method would turn
  359.             the Cruise control system on or off.
  360.   Args:     BOOL bOnOff)
  361.               TRUE for On; FALSE for Off.
  362.   Modifies: .
  363.   Returns:  HRESULT
  364.               NOERROR
  365. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  366. STDMETHODIMP COCruiseCar::CImpICruise::Engage(
  367.                BOOL bOnOff)
  368. {
  369.   LOGF1("L: COCruiseCar::CImpICruise::Engage. Called. bOnOff=%i.",bOnOff);
  370.   return NOERROR;
  371. }
  372. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  373.   Method:   COCruiseCar::CImpICruise::Adjust
  374.   Summary:  The Adjust member method of this ICruise interface
  375.             implementation.  A simple empty method on a COCruiseCar COM
  376.             object for tutorial purposes.  Presumably if this Car object
  377.             were modeling a real Car then the Adjust method would allow
  378.             notching the cruise set speed up or down by increments of 3 mph.
  379.   Args:     BOOL bUpDown)
  380.               TRUE for Up; FALSE for Down.
  381.   Modifies: .
  382.   Returns:  HRESULT
  383.               NOERROR
  384. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  385. STDMETHODIMP COCruiseCar::CImpICruise::Adjust(
  386.                BOOL bUpDown)
  387. {
  388.   LOGF1("L: COCruiseCar::CImpICruise::Adjust. Called. bUpDown=%i.",bUpDown);
  389.   return NOERROR;
  390. }