home *** CD-ROM | disk | FTP | other *** search
/ Tricks of the Windows Gam…ming Gurus (2nd Edition) / Disc2.iso / msdn_vcb / samples / vc98 / sdk / com / oleaut / browseh / function.cpp < prev    next >
Encoding:
C/C++ Source or Header  |  1997-07-31  |  8.1 KB  |  297 lines
  1. /*************************************************************************
  2. **
  3. **  This is a part of the Microsoft Source Code Samples.
  4. **
  5. **  Copyright (C) 1992-1997 Microsoft Corporation. All rights reserved.
  6. **
  7. **  This source code is only intended as a supplement to Microsoft Development
  8. **  Tools and/or WinHelp documentation.  See these sources for detailed
  9. **  information regarding the Microsoft samples programs.
  10. **
  11. **  OLE Automation TypeLibrary Browse Helper Sample
  12. **
  13. **  function.cpp
  14. **
  15. **  CFunction implementation
  16. **
  17. **  Written by Microsoft Product Support Services, Windows Developer Support
  18. **
  19. *************************************************************************/
  20.  
  21. #include <windows.h>
  22. #include <windowsx.h>
  23. #ifdef WIN16   
  24.   #include <ole2.h>
  25.   #include <compobj.h>    
  26.   #include <dispatch.h> 
  27.   #include <variant.h>
  28.   #include <olenls.h>  
  29. #endif 
  30. #include "browseh.h"  
  31.  
  32. /*
  33.  * CFunction::Create
  34.  *
  35.  * Purpose:
  36.  *  Creates an instance of the Function automation object and initializes it.
  37.  *
  38.  * Parameters:       
  39.  *  ptinfo        TypeInfo of which this Function is an element of.
  40.  *  nIndex          Index of function in containing TypeInfo.
  41.  *  ppFunction    Returns Function automation object.
  42.  *
  43.  * Return Value:
  44.  *  HRESULT
  45.  *
  46.  */
  47. HRESULT 
  48. CFunction::Create(LPTYPEINFO ptinfo, unsigned short nIndex, CFunction FAR* FAR* ppFunction) 
  49. {   
  50.     HRESULT hr;
  51.     CFunction FAR* pFunction = NULL;      
  52.     CTypeDesc FAR* pTypeDesc = NULL;
  53.      
  54.     *ppFunction = NULL;
  55.     
  56.     // Create object.
  57.     pFunction = new CFunction();
  58.     if (pFunction == NULL)
  59.     {
  60.         hr = E_OUTOFMEMORY; 
  61.         goto error;
  62.     }    
  63.     
  64.     // Load type information for the application object from type library. 
  65.     hr = pFunction->LoadTypeInfo(IID_IFunction);
  66.     if (FAILED(hr))
  67.         goto error; 
  68.     
  69.     hr = ptinfo->GetFuncDesc(nIndex, &pFunction->m_pfuncdesc);   
  70.     if (FAILED(hr))
  71.         goto error;
  72.     // Function return type.
  73.     hr = CTypeDesc::Create(ptinfo, &pFunction->m_pfuncdesc->elemdescFunc.tdesc, &pTypeDesc);
  74.     if (FAILED(hr))
  75.         goto error;
  76.     pTypeDesc->QueryInterface(IID_IDispatch, (LPVOID FAR*)&pFunction->m_pdispTypeDesc);
  77.     
  78.     hr = ptinfo->GetDocumentation(pFunction->m_pfuncdesc->memid, &pFunction->m_bstrName, &pFunction->m_bstrDocumentation,
  79.              &pFunction->m_ulHelpContext, &pFunction->m_bstrHelpFile); 
  80.     if (FAILED(hr))
  81.         goto error;   
  82.         
  83.     ptinfo->AddRef();
  84.     pFunction->m_ptinfoFunction = ptinfo;
  85.  
  86. #ifdef _DEBUG  
  87.     lstrcpyn(pFunction->m_szClassName, TEXT("Function"), 100);
  88. #endif 
  89.         
  90.     *ppFunction = pFunction;
  91.     return NOERROR;
  92.     
  93. error:                        
  94.     if (pFunction == NULL) return E_OUTOFMEMORY;
  95.     if (pFunction->m_pfuncdesc) ptinfo->ReleaseFuncDesc(pFunction->m_pfuncdesc);    
  96.     if (pFunction->m_ptinfoFunction) pFunction->m_ptinfoFunction->Release();
  97.     if (pFunction->m_bstrName) SysFreeString(pFunction->m_bstrName);
  98.     if (pFunction->m_bstrDocumentation) SysFreeString(pFunction->m_bstrDocumentation);
  99.     if (pFunction->m_bstrHelpFile) SysFreeString(pFunction->m_bstrHelpFile);
  100.          
  101.     // Set to NULL to prevent destructor from attempting to free again  
  102.     pFunction->m_ptinfoFunction = NULL;
  103.     pFunction->m_pfuncdesc = NULL;
  104.     pFunction->m_bstrName = NULL;
  105.     pFunction->m_bstrDocumentation = NULL;
  106.     pFunction->m_bstrHelpFile = NULL;
  107.     
  108.     delete pFunction;
  109.     return hr;
  110. }
  111.  
  112. /*
  113.  * CFunction::CFunction
  114.  *
  115.  * Purpose:
  116.  *  Constructor for CFunction object. Initializes members to NULL.
  117.  *
  118.  */
  119. CFunction::CFunction()
  120. {
  121.     m_bstrName = NULL;
  122.     m_bstrDocumentation = NULL;
  123.     m_bstrHelpFile = NULL;
  124.     m_pdispParameters = NULL;    
  125.     m_ptinfoFunction = NULL;
  126.     m_pfuncdesc = NULL;  
  127.     m_pdispTypeDesc = NULL;
  128. }
  129.  
  130. /*
  131.  * CFunction::~CFunction
  132.  *
  133.  * Purpose:
  134.  *  Destructor for CFunction object. 
  135.  *
  136.  */
  137. CFunction::~CFunction()
  138. {    
  139.      if (m_bstrName) SysFreeString(m_bstrName);
  140.      if (m_bstrDocumentation) SysFreeString(m_bstrDocumentation);
  141.      if (m_bstrHelpFile) SysFreeString(m_bstrHelpFile);
  142.      if (m_pdispParameters) m_pdispParameters->Release();        
  143.      if (m_pfuncdesc && m_ptinfoFunction) m_ptinfoFunction->ReleaseFuncDesc(m_pfuncdesc);
  144.      if (m_ptinfoFunction) m_ptinfoFunction->Release();      
  145.      if (m_pdispTypeDesc) m_pdispTypeDesc->Release();
  146. }
  147.  
  148. STDMETHODIMP_(REFCLSID)
  149. CFunction::GetInterfaceID()
  150. {
  151.     return IID_IFunction;
  152. }
  153.  
  154. STDMETHODIMP_(BSTR)
  155. CFunction::get_Name()
  156. {
  157.     return SysAllocString(m_bstrName);
  158. } 
  159.  
  160. STDMETHODIMP_(BSTR)
  161. CFunction::get_Documentation()     
  162. {
  163.     return SysAllocString(m_bstrDocumentation);
  164. }  
  165.  
  166. STDMETHODIMP_(long)
  167. CFunction::get_HelpContext()     
  168. {
  169.     return (long)m_ulHelpContext;
  170. }
  171.  
  172. STDMETHODIMP_(BSTR)
  173. CFunction::get_HelpFile()     
  174. {
  175.     return SysAllocString(m_bstrHelpFile);
  176. }   
  177.  
  178.  
  179. STDMETHODIMP_(ITypeDesc FAR*)
  180. CFunction::get_ReturnType()
  181. {   
  182.     m_pdispTypeDesc->AddRef();
  183.     return (ITypeDesc FAR*)m_pdispTypeDesc;
  184. }
  185.  
  186.  
  187. STDMETHODIMP_(ICollection FAR*)
  188. CFunction::get_Parameters()
  189. {   
  190.     HRESULT hr;        
  191.     CParameter FAR* pParameter;
  192.     CCollection FAR* pCollection = NULL;
  193.     LPDISPATCH pdisp;
  194.     BSTR FAR* rgbstrNames = NULL;  
  195.     unsigned int cNames;       
  196.     unsigned short n = 0;
  197.     
  198.     // Create a collection of parameters and return it.
  199.     if (m_pdispParameters == NULL)
  200.     {   
  201.         rgbstrNames = new BSTR[m_pfuncdesc->cParams+1];
  202.         if (rgbstrNames == NULL)
  203.             {RaiseException(IDS_OutOfMemory); return NULL;}  
  204.         
  205.         // Get the name of the function and its parameters
  206.         hr = m_ptinfoFunction->GetNames(m_pfuncdesc->memid, rgbstrNames, 
  207.                               m_pfuncdesc->cParams+1, &cNames);
  208.         if (FAILED(hr))
  209.             {RaiseException(IDS_Unexpected); goto error;}     
  210.         SysFreeString(rgbstrNames[0]);
  211.         
  212.         // Create a parameter collection
  213.         hr = CCollection::Create(m_pfuncdesc->cParams, 0, &pCollection);  
  214.         if (FAILED(hr))
  215.             {RaiseException(IDS_Unexpected); goto error;}        
  216.         
  217.         // The value being assigned to a property does not have a name. Call it 'Value'
  218.         if (m_pfuncdesc->invkind & INVOKE_PROPERTYPUT)
  219.             rgbstrNames[n+1] = SysAllocString(OLESTR("Value"));
  220.         // Add parameters to the parameter collection
  221.         for (n=0; n<m_pfuncdesc->cParams; n++)
  222.         {
  223.             hr = CParameter::Create(m_ptinfoFunction, 
  224.                    rgbstrNames[n+1], 
  225.                    &m_pfuncdesc->lprgelemdescParam[n].tdesc, 
  226.                    &m_pfuncdesc->lprgelemdescParam[n].idldesc,
  227.                    &pParameter);
  228.             if (FAILED(hr))
  229.                 {RaiseException(IDS_Unexpected); goto error;}     
  230.             SysFreeString(rgbstrNames[n+1]);
  231.             pParameter->QueryInterface(IID_IDispatch, (void FAR* FAR*)&pdisp);
  232.             pCollection->Add(pdisp);
  233.             pdisp->Release();  
  234.         }
  235.         pCollection->QueryInterface(IID_IDispatch, (void FAR* FAR*)&pdisp);
  236.         m_pdispParameters = pdisp;   
  237.         delete rgbstrNames;
  238.     }    
  239.     m_pdispParameters->AddRef();
  240.     return (ICollection FAR*)m_pdispParameters;       
  241.     
  242. error:  
  243.     if (pCollection) delete pCollection;  
  244.     if (rgbstrNames) 
  245.         for (; n<m_pfuncdesc->cParams; n++)
  246.             SysFreeString(rgbstrNames[n+1]);     
  247.     return NULL;
  248. } 
  249.  
  250. STDMETHODIMP_(MEMBERID)
  251. CFunction::get_Memberid()
  252. {
  253.     return m_pfuncdesc->memid;
  254. }
  255.  
  256. STDMETHODIMP_(CALLCONV)
  257. CFunction::get_CallConvention()
  258. { 
  259.     return m_pfuncdesc->callconv;
  260. }
  261.  
  262. STDMETHODIMP_(FUNCKIND)
  263. CFunction::get_FuncKind()
  264. { 
  265.     return m_pfuncdesc->funckind;
  266. }
  267.  
  268. STDMETHODIMP_(INVOKEKIND)
  269. CFunction::get_InvocationKind()
  270. { 
  271.     return m_pfuncdesc->invkind;
  272. }
  273.  
  274. STDMETHODIMP_(short)
  275. CFunction::get_NumberOfOptionalParams()
  276. {
  277.     return m_pfuncdesc->cParamsOpt;
  278. }
  279.  
  280. STDMETHODIMP_(short)
  281. CFunction::get_OffsetInVtbl()
  282. {
  283.     return m_pfuncdesc->oVft;
  284. }
  285.  
  286. STDMETHODIMP_(unsigned short)
  287. CFunction::get_FuncFlags()
  288. {
  289.     return m_pfuncdesc->wFuncFlags;
  290. }
  291.  
  292. STDMETHODIMP_(OBJTYPE)
  293. CFunction::get_Kind()
  294. {   
  295.     return TYPE_FUNCTION;
  296. }
  297.