EXCEPINFO
Describes an exception that occurred during
IDispatch::Invoke. See the reference page for "
IDispatch::Invoke" for more information on exceptions.
typedef struct FARSTRUCT tagEXCEPINFO {
unsigned short wCode; // An error code describing the error.
unsigned short wReserved;
BSTR bstrSource; // Source of the exception.
BSTR bstrDescription; // Textual description of the error.
BSTR bstrHelpFile; // Help file path.
unsigned long dwHelpContext; // Help context ID.
/* Pointer to function that fills in Help and description info */
HRESULT (STDAPICALLTYPE FAR* pfnDeferredFillIn)
(struct tagEXCEPINFO FAR*);
SCODE scode; // An SCODE describing the error.
} EXCEPINFO, FAR* LPEXCEPINFO;
The following table describes the fields of the EXCEPINFO structure:
Name
| Type
| Description
|
wCode
| unsigned short
| An error code identifying the error. Error codes should be greater than 1000.
Either this field or the scode field must be filled in; the other must be set to 0.
|
wReserved
| unsigned short
| Reserved; should be set to 0.
|
bstrSource
| BSTR
| A textual, human-readable name of the source of the exception. Typically this
will be an application name. This field should be filled in by the implementor
of IDispatch.
|
bstrDescription
| BSTR
| A textual, human-readable description of the error intended for the customer. If no description is available, use NULL.
|
bstrHelpFile
| BSTR
| The fully qualified drive, path, and filename of a Help file with more
information about the error. If no Help is available, use NULL.
|
dwHelpContext
| unsigned long
| The Help context of the topic within the Help file. This field should be filled in if and only if the bstrHelpFile field is not NULL.
|
pvReserved
|
| Must be set to NULL.
|
pfnDeferredFillIn
| HRESULT (STDAPICALLTYPE FAR* pfnDeferredFillIn) (struct tagEXCEPINFO FAR*)
| Pointer to a function that takes an EXCEPINFO structure as an argument and
returns an HRESULT value. If deferred fill-in is not desired, this field should be
set to NULL.
|
scode
| SCODE
| An SCODE describing the error. Either this field or wCode (but not both) must be filled in; the other must be set to 0.
|
Use the
pfnDeferredFillIn field to allow an object to defer filling in the
bstrDescription,
bstrHelpFile, and
dwHelpContext fields until they are needed. This field might be used, for example, if
loading the string for the error is a time-consuming operation. To use deferred
fill-in, the object puts a function pointer in this slot and does not fill any of
the other fields except
wCode (which is required in any case). To get additional information, the caller
passes the EXCEPINFO structure back to the pexcepinfo callback function, which
fills in the additional information. When the OLE Automation object and the OLE
Automation controller are in different processes, the OLE Automation object
calls
pfnDeferredFillIn before returning to the controller.
- Software for developers
-
Delphi Components
.Net Components
Software for Android Developers
- More information resources
-
MegaDetailed.Net
Unix Manual Pages
Delphi Examples
- Databases for Amazon shops developers
-
Amazon Categories Database
Browse Nodes Database
