|
INVHELP.CPP (BROWSE OLE Sample)
/*************************************************************************
-
- Automation Controller helper functions
-
- invhelp.cpp
-
-
- Written by Microsoft Product Support Services, Windows Developer Support
- (c) Copyright Microsoft Corp. 1994 All Rights Reserved
-
- ***********************************************************************/
#include <windows.h>
#include <windowsx.h>
#ifdef WIN16
#include <ole2.h>
#include <compobj.h>
#include <dispatch.h>
#include <variant.h>
#include <olenls.h>
#endif
#include <stdarg.h>
#ifdef WIN16
#define LPCTSTR LPCSTR
#define LPOLESTR LPSTR
#endif
HRESULT CountArgsInFormat(LPCTSTR pszFmt, UINT FAR *pn);
LPCTSTR GetNextVarType(LPCTSTR pszFmt, VARTYPE FAR* pvt);
/*
* CreateObject
*
* Purpose:
* Creates an instance of the Automation object and obtains it's IDispatch
interface.
* Uses Unicode with OLE.
*
* Parameters:
* pszProgID ProgID of Automation object
* ppdisp Returns IDispatch of Automation object
*
* Return Value:
* HRESULT indicating success or failure
*/
HRESULT CreateObject(LPOLESTR pszProgID, IDispatch FAR* FAR* ppdisp)
{
CLSID clsid; // CLSID of automation object
HRESULT hr;
LPUNKNOWN punk = NULL; // IUnknown of automation object
LPDISPATCH pdisp = NULL; // IDispatch of automation object
*ppdisp = NULL;
// Retrieve CLSID from the progID that the user specified
hr = CLSIDFromProgID(pszProgID, &clsid);
if (FAILED(hr))
goto error;
// Create an instance of the automation object and ask for the IDispatch
interface
hr = CoCreateInstance(clsid, NULL, CLSCTX_SERVER,
IID_IUnknown, (void FAR* FAR*)&punk);
if (FAILED(hr))
goto error;
hr = punk->QueryInterface(IID_IDispatch, (void FAR* FAR*)&pdisp);
if (FAILED(hr))
goto error;
*ppdisp = pdisp;
punk->Release();
return NOERROR;
error:
if (punk) punk->Release();
if (pdisp) pdisp->Release();
return hr;
}
/*
* Invoke
*
* Purpose:
* Invokes a property accessor function or method of an automation object.
Uses Unicode with OLE.
*
* Parameters:
* pdisp IDispatch* of automation object.
* wFlags Specfies if property is to be accessed or method to be
invoked.
* Can hold DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT,
DISPATCH_METHOD,
* DISPATCH_PROPERTYPUTREF or
DISPATCH_PROPERTYGET|DISPATCH_METHOD.
* pvRet NULL if caller excepts no result. Otherwise returns result.
* pexcepinfo Returns exception info if DISP_E_EXCEPTION is returned. Can
be NULL if
* caller is not interested in exception information.
* pnArgErr If return is DISP_E_TYPEMISMATCH, this returns the index (in
reverse
* order) of argument with incorrect type. Can be NULL if
caller is not interested
* in this information.
* pszName Name of property or method.
* pszFmt Format string that describes the variable list of parameters
that
* follows. The format string can contain the follwoing
characters.
* & = mark the following format character as VT_BYREF
* b = VT_BOOL
* i = VT_I2
* I = VT_I4
* r = VT_R2
* R = VT_R4
* c = VT_CY
* s = VT_BSTR (far string pointer can be passed, BSTR will be
allocated by this function).
* e = VT_ERROR
* d = VT_DATE
* v = VT_VARIANT. Use this to pass data types that are not
described in
* the format string. (For example SafeArrays).
* D = VT_DISPATCH
* U = VT_UNKNOWN
*
* ... Arguments of the property or method. Arguments are described
by pszFmt.
* ****FAR POINTERS MUST BE PASSED FOR POINTER ARGUMENTS in
Win16.****
* Return Value:
* HRESULT indicating success or failure
*
* Usage examples:
*
* HRESULT hr;
* LPDISPATCH pdisp;
* BSTR bstr;
* short i;
* BOOL b;
* VARIANT v, v2;
*
*1. bstr = SysAllocString(OLESTR(""));
* hr = Invoke(pdisp, DISPATCH_METHOD, NULL, NULL, NULL, OLESTR("method1"),
* TEXT("bis&b&i&s"), TRUE, 2, (LPOLESTR)OLESTR("param"), (BOOL
FAR*)&b, (short FAR*)&i, (BSTR FAR*)&bstr);
*
*2. VariantInit(&v);
* V_VT(&v) = VT_R8;
* V_R8(&v) = 12345.6789;
* VariantInit(&v2);
* hr = Invoke(pdisp, DISPATCH_METHOD, NULL, NULL, NULL, OLESTR("method2"),
* TEXT("v&v"), v, (VARIANT FAR*)&v2);
*/
HRESULT
Invoke(LPDISPATCH pdisp,
WORD wFlags,
LPVARIANT pvRet,
EXCEPINFO FAR* pexcepinfo,
UINT FAR* pnArgErr,
LPOLESTR pszName,
LPCTSTR pszFmt,
...)
{
va_list argList;
va_start(argList, pszFmt);
DISPID dispid;
HRESULT hr;
VARIANTARG* pvarg = NULL;
if (pdisp == NULL)
return ResultFromScode(E_INVALIDARG);
// Get DISPID of property/method
hr = pdisp->GetIDsOfNames(IID_NULL, &pszName, 1, LOCALE_USER_DEFAULT,
&dispid);
if(FAILED(hr))
return hr;
DISPPARAMS dispparams;
_fmemset(&dispparams, 0, sizeof dispparams);
// determine number of arguments
if (pszFmt != NULL)
CountArgsInFormat(pszFmt, &dispparams.cArgs);
// Property puts have a named argument that represents the value that the
property is
// being assigned.
DISPID dispidNamed = DISPID_PROPERTYPUT;
if (wFlags & DISPATCH_PROPERTYPUT)
{
if (dispparams.cArgs == 0)
return ResultFromScode(E_INVALIDARG);
dispparams.cNamedArgs = 1;
dispparams.rgdispidNamedArgs = &dispidNamed;
}
if (dispparams.cArgs != 0)
{
// allocate memory for all VARIANTARG parameters
pvarg = new VARIANTARG[dispparams.cArgs];
if(pvarg == NULL)
return ResultFromScode(E_OUTOFMEMORY);
dispparams.rgvarg = pvarg;
_fmemset(pvarg, 0, sizeof(VARIANTARG) * dispparams.cArgs);
// get ready to walk vararg list
LPCTSTR psz = pszFmt;
pvarg += dispparams.cArgs - 1; // params go in opposite order
while (psz = GetNextVarType(psz, &pvarg->vt))
{
if (pvarg < dispparams.rgvarg)
{
hr = ResultFromScode(E_INVALIDARG);
goto cleanup;
}
switch (pvarg->vt)
{
case VT_I2:
V_I2(pvarg) = va_arg(argList, short);
break;
case VT_I4:
V_I4(pvarg) = va_arg(argList, long);
break;
case VT_R4:
V_R4(pvarg) = va_arg(argList, float);
break;
case VT_DATE:
case VT_R8:
V_R8(pvarg) = va_arg(argList, double);
break;
case VT_CY:
V_CY(pvarg) = va_arg(argList, CY);
break;
case VT_BSTR:
V_BSTR(pvarg) = SysAllocString(va_arg(argList, OLECHAR FAR*));
if (pvarg->bstrVal == NULL)
{
hr = ResultFromScode(E_OUTOFMEMORY);
pvarg->vt = VT_EMPTY;
goto cleanup;
}
break;
case VT_DISPATCH:
V_DISPATCH(pvarg) = va_arg(argList, LPDISPATCH);
break;
case VT_ERROR:
V_ERROR(pvarg) = va_arg(argList, SCODE);
break;
case VT_BOOL:
V_BOOL(pvarg) = va_arg(argList, BOOL) ? -1 : 0;
break;
case VT_VARIANT:
*pvarg = va_arg(argList, VARIANTARG);
break;
case VT_UNKNOWN:
V_UNKNOWN(pvarg) = va_arg(argList, LPUNKNOWN);
break;
case VT_I2|VT_BYREF:
V_I2REF(pvarg) = va_arg(argList, short FAR*);
break;
case VT_I4|VT_BYREF:
V_I4REF(pvarg) = va_arg(argList, long FAR*);
break;
case VT_R4|VT_BYREF:
V_R4REF(pvarg) = va_arg(argList, float FAR*);
break;
case VT_R8|VT_BYREF:
V_R8REF(pvarg) = va_arg(argList, double FAR*);
break;
case VT_DATE|VT_BYREF:
V_DATEREF(pvarg) = va_arg(argList, DATE FAR*);
break;
case VT_CY|VT_BYREF:
V_CYREF(pvarg) = va_arg(argList, CY FAR*);
break;
case VT_BSTR|VT_BYREF:
V_BSTRREF(pvarg) = va_arg(argList, BSTR FAR*);
break;
case VT_DISPATCH|VT_BYREF:
V_DISPATCHREF(pvarg) = va_arg(argList, LPDISPATCH FAR*);
break;
case VT_ERROR|VT_BYREF:
V_ERRORREF(pvarg) = va_arg(argList, SCODE FAR*);
break;
case VT_BOOL|VT_BYREF:
{
BOOL FAR* pbool = va_arg(argList, BOOL FAR*);
*pbool = 0;
V_BOOLREF(pvarg) = (VARIANT_BOOL FAR*)pbool;
}
break;
case VT_VARIANT|VT_BYREF:
V_VARIANTREF(pvarg) = va_arg(argList, VARIANTARG FAR*);
break;
case VT_UNKNOWN|VT_BYREF:
V_UNKNOWNREF(pvarg) = va_arg(argList, LPUNKNOWN FAR*);
break;
default:
{
hr = ResultFromScode(E_INVALIDARG);
goto cleanup;
}
break;
}
--pvarg; // get ready to fill next argument
} //while
} //if
// Initialize return variant, in case caller forgot. Caller can pass NULL
if return
// value is not expected.
if (pvRet)
VariantInit(pvRet);
// make the call
hr = pdisp->Invoke(dispid, IID_NULL, LOCALE_USER_DEFAULT, wFlags,
&dispparams, pvRet, pexcepinfo, pnArgErr);
cleanup:
// cleanup any arguments that need cleanup
if (dispparams.cArgs != 0)
{
VARIANTARG FAR* pvarg = dispparams.rgvarg;
UINT cArgs = dispparams.cArgs;
while (cArgs--)
{
switch (pvarg->vt)
{
case VT_BSTR:
VariantClear(pvarg);
break;
}
++pvarg;
}
}
delete dispparams.rgvarg;
va_end(argList);
return hr;
}
HRESULT CountArgsInFormat(LPCTSTR pszFmt, UINT FAR *pn)
{
*pn = 0;
if(pszFmt == NULL)
return NOERROR;
while (*pszFmt)
{
if (*pszFmt == '&')
pszFmt++;
switch(*pszFmt)
{
case 'b':
case 'i':
case 'I':
case 'r':
case 'R':
case 'c':
case 's':
case 'e':
case 'd':
case 'v':
case 'D':
case 'U':
++*pn;
pszFmt++;
break;
case '\0':
default:
return ResultFromScode(E_INVALIDARG);
}
}
return NOERROR;
}
LPCTSTR GetNextVarType(LPCTSTR pszFmt, VARTYPE FAR* pvt)
{
*pvt = 0;
if (*pszFmt == '&')
{
*pvt = VT_BYREF;
pszFmt++;
if (!*pszFmt)
return NULL;
}
switch(*pszFmt)
{
case 'b':
*pvt |= VT_BOOL;
break;
case 'i':
*pvt |= VT_I2;
break;
case 'I':
*pvt |= VT_I4;
break;
case 'r':
*pvt |= VT_R4;
break;
case 'R':
*pvt |= VT_R8;
break;
case 'c':
*pvt |= VT_CY;
break;
case 's':
*pvt |= VT_BSTR;
break;
case 'e':
*pvt |= VT_ERROR;
break;
case 'd':
*pvt |= VT_DATE;
break;
case 'v':
*pvt |= VT_VARIANT;
break;
case 'U':
*pvt |= VT_UNKNOWN;
break;
case 'D':
*pvt |= VT_DISPATCH;
break;
case '\0':
return NULL; // End of Format string
default:
return NULL;
}
return ++pszFmt;
}
| Last news from Greatis Software |
 |
|
Nostalgia .Net |
|
.Net is powerful, but not all-powerful, so sometimes we need to use Win32 API for our .Net applications. It's simple enough with Platform Invoke if you have Win32 skill, but we do not always have time to dig the ancient documentation, declare the special types that are compatible with Win32, find the values of the Win32's constants and so on. Nostalgia .Net offers several simple-to-use classes, and components that will allow you to forget about the headache of Win32 and just use the power of Win32 in your application the same way as you use the native. Net classes. More » |
| Recommended software for developers |
 |
|
Ultimate Pack |
|
Component pack for Delphi and C++ Builder that contains runtime form designer, runtime object inspector, print suite and much more for the very special price. More » |
 |
|
Form Designer .Net |
|
Unique runtime form design solution that allows to edit any form in .Net WinForms application at runtime with full source codes for only 300 euro! More » |
 |
|
Print Suite .Net |
|
Print Suite .Net is a set of components for easy printing texts, images and grids from your WinForms applications. Full C# source codes are available More » |
 |
|
Gradient Controls .Net |
|
Gradient Controls .Net offers controls with gradient background feature. Labels, panels and so on... Full C# source codes are available More » |
 |
|
Greatis iGrid |
|
iGrid plots drawing grid right over your desktop, so you can use it everywhere, with any drawing application without any special plugins for different graphic editors. More » |
All the contacts and projectsDmitry Vasiliev (just.dmitry)
Related LinksSoftware for Visual Studio .NET developers Software for Delphi and C++ Builder developers Software for Visual Basic 6 developers Delphi Tips&Tricks MegaDetailed.NET More Online Helps Win32 Programmer's Reference Win32 Multimedia Programmer's Reference OLE Programmer's Reference Microsoft Windows Pen API Programmer's Reference Microsoft Windows Sockets 2 Reference Microsoft Windows Telephony API (TAPI) Programmer's Reference Unix Manual Pages
|