COMError Class
The COMError class wraps any COM errors that occur during a COM method call.
Syntax
class COMError extends Object
Run On
Called
Methods
Method | Description | |
---|---|---|
![]() |
cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
![]() |
clear | Clears the properties of the COMError object. |
![]() |
description | Returns a description of the error that occurred when the COM object was called. |
![]() |
equal | Determines whether the specified object is equal to the current one. (Inherited from Object.) |
![]() |
finalize | |
![]() |
getTimeOutTimerHandle | Returns the timer handle for the object. (Inherited from Object.) |
![]() |
handle | Retrieves the handle of the class of the object. (Inherited from Object.) |
![]() |
helpContext | Returns the Help context ID for the error that occurred when the COM object was called. |
![]() |
helpFile | Returns the name of the Help file that contains information about the error that occurred when the COM object was called. |
![]() |
new | Initializes an instance of the COMError class. (Overrides the new Method.) |
![]() |
notify | Releases the hold on an object that has called the wait method on this object. (Inherited from Object.) |
![]() |
notifyAll | Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.) |
![]() |
number | Returns the error code of the error that occurred when the COM object was called. |
![]() |
objectOnServer | Determines whether the object is on a server. (Inherited from Object.) |
![]() |
owner | Returns the instance that owns the object. (Inherited from Object.) |
![]() |
setTimeOut | Sets up the scheduled execution of a specified method. (Inherited from Object.) |
![]() |
source | Returns the name of the component that caused the error that occurred when the COM object was called. |
![]() |
toString | Returns a string that contains the class handle and name, and sometimes additional information. (Overrides the toString Method.) |
![]() |
usageCount | Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.) |
![]() |
wait | Pauses a process. (Inherited from Object.) |
![]() |
xml | Returns an XML string that represents the current object. (Inherited from Object.) |
Top
Remarks
When an error occurs during a COM method call, the error code and the error description are stored in the COMError object.
The COMError object that is associated with a COM class is retrieved from the COM class by using the COM.error method.
Inheritance Hierarchy
Object Class
COMError Class