Question

How to fail gracefully Outlook COM

Asked by: purplepomegranite

I have a COM written to be used in conjunction with a VB Outlook add-in.  One problem I would like to resolve is to properly handle invalid parameters being passed to the add-in.  For example, one function is as below.  This function takes a MAPIFolder and returns an array containing information about the folder (i.e. all subfolders, recursed).

The problem occurs when an invalid object is passed as a parameter (e.g. the folder object is VB Nothing, or unset).  This currently causes a GPF.  While I have made all possible checks in the VB code before calling this routine, I would rather the C++ function failed gracefully.

So... How do I check for a valid object so that I can simply return immediately if not supplied?

STDMETHODIMP CPMapiWrapper::EnumerateFolders(VARIANT pFolderItem,  VARIANT *pFolderList,  VARIANT *result)
{
	SAFEARRAY* arr = NULL;
	LPUNKNOWN unk = NULL;
 
	if (pFolderItem.vt == (VT_DISPATCH | VT_BYREF)) unk = getMapiobjectProperty(*(pFolderItem.ppdispVal));
	else if (pFolderItem.vt == (VT_DISPATCH)) unk = getMapiobjectProperty(pFolderItem.pdispVal);
	else return E_INVALIDARG;
	if (!unk) return E_NOINTERFACE;
 
	if (V_ISARRAY(pFolderList))
 	{
 	   // Check dimensions of the array.
 	   arr = V_ISBYREF(pFolderList)? *V_ARRAYREF(pFolderList): V_ARRAY(pFolderList);
       if (SafeArrayGetDim(arr) != 2) return E_INVALIDARG;
 	}
 
	if (!arr) 
	{
		return E_NOINTERFACE;
	}
 
	HRESULT hr = enumerateFolders(unk, arr, result);
	unk->Release();
 
	return hr;
}

                                  
1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:
12:
13:
14:
15:
16:
17:
18:
19:
20:
21:
22:
23:
24:
25:
26:
27:

Select allOpen in new window

This Question has been solved and asker verified All Experts Exchange premium technology solutions are available to subscription members.

Subscribe now for full access to Experts Exchange and get

Instant Access to this Solution

  • Plus...
  • 30 Day FREE access, no risk, no obligation
  • Collaborate with the world's top tech experts
  • Unlimited access to our exclusive solution database
  • Never be left without tech help again

Subscribe Now

Asked On
2009-10-05 at 15:48:47ID24787298
Tags

Outlook MAPI COM

Topics

C++ Programming Language

,

Windows ATL / WTL / COM Programming

Participating Experts
1
Points
500
Comments
10

Trusted by hundreds of thousands everyday for fast, accurate and reliable tech support.

  • "The time we save is the biggest benefit of Experts Exchange to Warner Bros. What could take multiple guys 2 hours or more each to find is accessed in around 15 minutes on Experts Exchange." Mike Kapnisakis, Warner Bros.
  • "Our team likes having a resource that is more secure than just using Google and most experts using this service really know their stuff. It's nice to look here first versus using Google." Dayna Sellner, Lockheed Martin
  • "Anytime that I've been stumped with a problem, 9 out of 10 times Experts Exchange has either the accepted solution or an open discussion of the potential solution to the problem." Kenny Red, eBay Inc.

See what Experts Exchange can do for you.

Got a question?

We've got the answer.

Experts Exchange has been collecting answers to technology questions since 1996…3 million and counting! If you have a question, chances are we already have your answer.

Screenshot of Experts Exchange Knowledgebase

Need individual assistance?

Our experts are ready to help.

If you can't find the exact answer you're looking for, ask our exclusive community of 50,000 experts. You’ll get a personalized answer from a trusted professional.

Screenshot of Experts Exchange Knowledgebase

Want to learn from the best?

Read articles from industry experts.

Thousands of free tech tips, tricks, how-to’s and tutorials are available in our peer reviewed articles section. See for yourself how smart our experts are, no login required.

Screenshot of an Article

Working on a long term project?

Store your work and research.

Save solutions to your questions, answers you’ve discovered through searching plus helpful articles in your personal knowledgebase for easy future access.

Screenshot of Experts Exchange Knowledgebase

Access the answers to your technology questions today.

Subscribe Now

30-day free trial. Register in 60 seconds.

What Makes Experts Exchange Unique?

Members of the expert community talk about why the experience at Experts Exchange is different than what you will find anywhere else.

Trusted by the world's most respected brands.

image of each brand's logo

Faithfully serving IT professionals since 1996.

Experts Exchange Logo

Try it out and discover for yourself.

Subscribe Now

30-day free trial. Register in 60 seconds.

Related Solutions

  1. Closing a socket gracefully
    hello, i have made a small server that immitates a http server, but only returns services that are supported in the server. It could be done by individual CGI scripts, but for performance reason it is done like this. Everything goes just fine, i get a request, proces it, an...
  2. Showing XML gracefully.
    There is a stirng which is a xml file. and I want to show it on a new page gracefully. I tried like below. unfortunately it won't work. Thanks. var res = "<?xml version ...> <bla><bla>... bla bla bla~ "; var newWindow = window.open("",&...
  3. stopping sql server gracefully
    We are often patching our database servers. Reboot is often required. Is there any facility within sql server that allows us to stop sql server gracefully before we do a reboot? When I mean stop sql server gracefully, I mean that there will be a check to make sure no j...
  4. Disable PST checking if not closed gracefully.
    Is there a registry key or any other way to disable PST file checking in Outlook 2003? We have a remote user on an unstable wireless connection and he constantly gets kicked off our VPN. He needs to access some PST files in a remote office over the VPN. However, his wirele...
  5. Batch file to gracefully close
    I've got a lengthy batch file that makes some temporary files and it cleans up at the end. Problem is, if the user clicks the X on the command prompt, the program terminates and the batch file is killed, in mid-process. This hurts things for the next time the batch file runs....

Free Tech Articles

  1. WARNING: 5 Reasons why you should NEVER fix a computer for free.
    It is in our nature to love the puzzle. We are obsessed. The lot of us. We love puzzles. We love the challenge. We thrive on finding the answer. We hate disarray. It bothers us deep in our soul. W...
  2. SCCM OSD Basic troubleshooting
    SCCM 2007 OSD is a fantastic way to deploy operating systems, however, like most things SCCM issues can sometimes be difficult to resolve due to the sheer volume of logs to sift through and the dispe...
  3. Migrate Small Business Server 2003 to Exchange 2010 and Windows 2008 R2
    This guide is intended to provide step by step instructions on how to migrate from Small Business Server 2003 to Windows 2008 R2 with Exchange 2010. For this migration to work you will need the fo...
  4. Create a Win7 Gadget
    This article shows you how to create a simple "Gadget" -- a sort of mini-application supported by Windows 7 and Vista. Gadgets can be dropped anywhere on the desktop to provide instant information, ...
  5. Outlook continually prompting for username and password
    There have been a lot of questions recently regarding Outlook prompting for a username and password whilst using Exchange 2007. There are a few reasons why this would happen and I will try to cover t...
  6. Backup Exchange 2010 Information Store using Windows Backup
    There seems to be quite a lot of confusion around the ability to backup Exchange 2010 using the built in Windows Backup feature. This stems from the omission of this feature prior to Exchange 2007 s...

Cloud Class Webinars

  1. Avoiding Bugs in Microsoft Access
    Alison Balter takes and in-depth look at avoiding bugs in Access. In this webinar you will learn about using the immediate window to debug your applications, invoking the debugger, using breakpoints to troubleshoot, stepping through code, setting the next statement to execute, ...
  2. Top 10 Best New Features in Visio 2010
    Scott Helmers gives live demonstrations of the top 10 new features in Visio 2010. This webinar will teach you how to create compelling diagrams by adding shapes to the page with a single click, linking the shapes in a diagram to data in Excel (or SQL Server, or SharePoint), ...
  3. IT Consultant Business Secrets Revealed
    Michael Munger, Experts Exchange tech pro and IT consultant, pulls back the curtain on his very successful businesses and answers question on every IT consultant and business owner should know about. He shares secrets on what he did to solve the 5 most common problems in IT, ...
  4. Disaster Recovery and Business Continuity
    Quest CTO, Mike Billon, gives an overview of the steps involved in building a dunamic disaster recovery plan. Through case studies and an examination of software/hardware tooles for monitoring and testing, you'll gain a better understandin of where you are, where you want ...
  5. Organize Your Visio Diagrams with Containers and Lists
    Scott Helmers uses cross functional flowcharts, wireframe diagrams, data graphic legends and seating charts to teach you: how to ustilize all three new structured diagram components in Visio 2010, the best practices for organizeing shapes in previous version of Visio, how to organize ...
  6. How to Us Objects, Properties, Events and Methods in Microsoft Access
    Alison Dalter gives an in-depbth look at objects, properties, events and methods in Microsoft Access. In this webinar you will learn about using the object browser, referring to objects, working with properties and methods, working with object variables, understanding the ...

Join the Community

Give a Little. Get a Lot.

Join the community of experts here and help other tech pros by answering question in your area of expertise. You can earn FREE access to all Experts Exchange's premium features and resources.

Join the Community

Answers

 

by: fridomPosted on 2009-10-06 at 03:15:02ID: 25503380

probably something along
 if (pFolderItem.vt == (VT_EMPTY) or ....
   // fail with INVALID_ARG

the Variant type really is not for the faint of heart ;-)
see e.g
http://msdn.microsoft.com/en-us/library/ms221627.aspx

Regards
Friedrich

 

by: purplepomegranitePosted on 2009-10-06 at 03:23:00ID: 25503417

Thanks, I'll give it a go.  Faint of heart I'm not, but neither am I a C++ programmer!  Variants are the only option for the COM add-in due to interfacing with VB (or more importantly, due to the object types).

 

by: purplepomegranitePosted on 2009-10-06 at 04:09:05ID: 25503687

Unfortunately that isn't working.  I don't know if the below code helps - it shows what getMapiobjectProperty does.  It seems that even if I pass Nothing (from VB) as the MapiObject parameter, it is still passed as VT_DISPATCH, so I need to determine whether that is a valid object.

LPUNKNOWN CPMapiWrapper::getMapiobjectProperty(LPDISPATCH disp)
{
	DISPID		rgDispId;
	DISPPARAMS	dispparams = {NULL, NULL, 0, 0};
	VARIANT		vaResult;	
	LPOLESTR	pName = L"MAPIOBJECT";
	VariantInit(&vaResult);
 
	if (SUCCEEDED(disp->GetIDsOfNames(IID_NULL,&pName,1,LOCALE_SYSTEM_DEFAULT,&rgDispId)))
		if (SUCCEEDED(disp->Invoke(rgDispId, IID_NULL, 0, DISPATCH_PROPERTYGET, &dispparams, &vaResult, NULL, NULL)))
			if (vaResult.vt == VT_UNKNOWN)
			{
				return vaResult.punkVal;
			}
		
	return NULL;
}

                                              
1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:
12:
13:
14:
15:
16:
17:

Select allOpen in new window

 

by: fridomPosted on 2009-10-06 at 09:37:39ID: 25506966

I'm sorry but I do not understand your mail. What did you pass to this function? LPDISPATH surely is a valid IDispatch interface or not?
What should the MapiObject parameter be?
The code you show looks quite ok to me, the only code which  seems not to be ok is return NULL, This does not look ok to me but I may be wrong.

I do also not understand what you mean with this from your initial question
rameter (e.g. the folder object is VB Nothing, or unset)

should that be the first,second or third parameter.


I've the impression you use some wrapper around the MAPI stuff.

Common tasks are show here:
http://msdn.microsoft.com/en-us/library/ms528097(EXCHG.10).aspx

if you however do IDispatch programming with C/C++ you probably want to use the disphelper.c file also
http://disphelper.sourceforge.net/readme.htm

In your case you just have on parameter while accessing the getter but if you do have more parameter you also have to be sure that you pass in the the parmater in reverse order.

But that's another story. Without understanding where the problem is I can not do more than trying to give you hints. I'm still absolutly unsure what you like to achieve.

Regards
Friedrich

 

by: purplepomegranitePosted on 2009-10-06 at 10:14:42ID: 25507366

The null return is fine - if null is returned from the above function then the calling code returns an E_NOINTERFACE code.  I don't mind null returns, I can check for them - but what is happening is if I pass the VB value Nothing in as a parameter instead of the expected MAPIObject, then I get a GPF rather than an error (which is what I want).

There is no wrapper beyond the above code.  From VB, I would call EnumerateFolders passing a folder object as pFolderItem.  However, if I pass Nothing, I don't get an error, I get a crash, which is not what I want (obviously!).  The problem being that sometimes if there is an error elsewhere in the VB code, a parameter may end up being Nothing, so I just need an error returned.

I don't know how to explain it any further... EnumerateFolders is the function presented via COM to VB.

I presume the:
if (!unk) return E_NOINTERFACE;
Is in fact checking whether unk is null, and if so returning E_NOINTERFACE?!  

 

by: purplepomegranitePosted on 2009-10-06 at 10:16:15ID: 25507388

Nothing in VB is a value, or in the case of an object (which this is) it means that it doesn't in fact refer to ANY object.
http://msdn.microsoft.com/en-us/library/0x9tb07z%28VS.80%29.aspx

 

by: fridomPosted on 2009-10-06 at 23:18:14ID: 25512570

Check before the call to
STDMETHODIMP CPMapiWrapper::EnumerateFolders

Have you tried?
Checking pFolderItem on NULL and/or VT_EMPTY or the like?

Regards
Friedrich

 

by: purplepomegranitePosted on 2009-10-07 at 01:43:44ID: 25513208

I test for VT_EMPTY (but this test doesn't catch it).  When I try testing for NULL (with either pFolderItem==NULL, or !pFolderItem syntax) I receive a compile error:

error C2678: binary '==' : no operator defined which takes a left-hand operand of type 'struct tagVARIANT' (or there is no a
cceptable conversion)

Thing is, as I only catch VARIANTS that are either VT_DISPATCH or VT_DISPATCH | VT_BYREF, anything that isn't that type will result in an error.  Which means that NOTHING is still being passed as VT_DISPATCH.  

 

by: purplepomegranitePosted on 2009-10-07 at 01:46:14ID: 25513218

Based on writing the above, I suddenly realised that I should be testing the I_DISPATCH interface.  The VARIANT is passed (as VT_dispatch), but the pointer to the I_DISPATCH is NULL when VB passes Nothing.

So, I modified the function below, and it now returns an error instead of crashing - which was the required result. :-)

LPUNKNOWN CPMapiWrapper::getMapiobjectProperty(LPDISPATCH disp)
{
	DISPID		rgDispId;
	DISPPARAMS	dispparams = {NULL, NULL, 0, 0};
	VARIANT		vaResult;	
	LPOLESTR	pName = L"MAPIOBJECT";
	VariantInit(&vaResult);
	
	if (!disp) return NULL;
	if (SUCCEEDED(disp->GetIDsOfNames(IID_NULL,&pName,1,LOCALE_SYSTEM_DEFAULT,&rgDispId)))
		if (SUCCEEDED(disp->Invoke(rgDispId, IID_NULL, 0, DISPATCH_PROPERTYGET, &dispparams, &vaResult, NULL, NULL)))
			if (vaResult.vt == VT_UNKNOWN)
			{
				return vaResult.punkVal;
			}
		
	return NULL;
}

                                              
1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:
12:
13:
14:
15:
16:
17:
18:

Select allOpen in new window

 

by: fridomPosted on 2009-10-07 at 05:14:52ID: 25514484

Well that was what I meant check it before calling. I though you had tested on NULL because that seems to be the same in VARIANTS AFAIKT. So I assumed you did that, but it's find that you figured it out yourself. Well done

Regards
Friedrich

20120131-EE-VQP-002

3 Ways to Join

30-Day Free Trial

The Experts

98% positive feedback on 31,087 answers since March 2000. angeliii is a Microsoft Most Valuable Professional for his work with MS SQL Server & Develoment.

He has also proven his knowledge of Visual Basic Programming, PHP Scripting and Oracle Databases.

The Experts

97% positive feedback on 10,752 answers since July 2000. lrmoore has more than 18 years experience in the networking industry.

The six-time Mircosoft MVPs specialties include firewalls, virtual private networking, and network management.

Testimonials

"...and excellent source for support... Kind of like having your very own IT dept." Electriciansnet

Testimonials

"I was apprehensive at signing up at first. However... it has already made my life as an IT administrator much easier." JaCrews

Testimonials

"WOW! You guys have great, active, and knowledgeable people on here." moore50

Business Clients

Business Clients

In the Press

"If you’ve got a question... Experts Exchange can supply an answer.”

In the Press

"...an invaluable aid for both IT professionals and those who require tech support."

In the Press

"where IT professionals provide quick answers on just about any topic"

Business Account Plans

Loading Advertisement...