Compartilhar via


AfxThrowOleDispatchException

Use esta função para gerar uma exceção dentro de uma função de automação OLE.

void AFXAPI AfxThrowOleDispatchException( 
   WORD wCode, 
   LPCSTR lpszDescription, 
   UINT nHelpID = 0  
); 
void AFXAPI AfxThrowOleDispatchException( 
   WORD wCode, 
   UINT nDescriptionID, 
   UINT nHelpID =   -1  
);

Parâmetros

  • wCode
    Um específico do código de erro ao aplicativo.

  • lpszDescription
    Verbal descrição do erro.

  • nDescriptionID
    ID de recurso da descrição do erro verbal.

  • nHelpID
    Um contexto de ajuda do arquivo de ajuda do aplicativo (.HLP).

Comentários

As informações fornecidas nesta função pode ser exibida pelo aplicativo à esquerda (Microsoft Visual Basic ou outro aplicativo cliente de automação OLE).

Exemplo

// Sort is method of automation class CStrArrayDoc 
long CStrArrayDoc::Sort(VARIANT* vArray)
{
   USES_CONVERSION;

   // Type check VARIANT parameter. It should contain a BSTR array 
   // passed by reference. The array must be passed by reference; it is 
   // an in-out-parameter. 

   // throwing COleDispatchException allows the EXCEPINFO structure of  
   // IDispatch::Invoke() to set 
   if (V_VT(vArray) != (VT_ARRAY | VT_BSTR))
      AfxThrowOleDispatchException(1001, 
         _T("Type Mismatch in Parameter. Pass a string array by reference"));

   // ... 
   // ... 

   return 0;
}

Requisitos

Header: <afxdisp.h>

Consulte também

Referência

Classe COleException

Conceitos

Macros e globais MFC