This documentation is archived and is not being maintained.

AfxCheckError 

This function tests the passed SCODE to see if it is an error.


void AFXAPI AfxCheckError(
   SCODE sc 
);
throw CMemoryException*
throw COleException*

If it is an error, the function throws an exception. If the passed SCODE is E_OUTOFMEMORY, the function throws a CMemoryException by calling AfxThrowMemoryException. Otherwise, the function throws a COleException by calling AfxThrowOleException.

This function can be used to check the return values of calls to OLE functions in your application. By testing the return value with this function in your application, you can properly react to error conditions with a minimal amount of code.

NoteNote

This function has the same effect in debug and non-debug builds.

LPDISPATCH pDisp = NULL;
AfxCheckError(CoCreateInstance(CLSID,
 NULL, CLSCTX_LOCAL_SERVER, IID_IDispatch,
 (LPVOID) &pDisp));
// if there was an error, an exception has already been thrown
// we can start using the returned pointer
COleDispatchDriver disp(pDisp);
// and so on...
Show: