ActiveX Component Error (PRIM_COER)

Object returned when an ActiveX control produces an error

Ancestors - Object (PRIM_OBJT)

Details

The ActiveX error component containing the information returned by the last interaction with an ActiveX component.

The #COM_ERR_INFO variable provides programmatic access to the information returned by the control.

The IsError property indicates whether an interaction has failed and the ErrorCode and ErrorWord properties provide numeric and string representations of the returned HRESULT value.

The success or failure of an interaction with an ActiveX component is indicated by the value of a variable returned by the ActiveX in the form of a HRESULT data type. The HRESULT variable represents a 32-bit integer value that is interpreted in one of three ways.

1. A zero value identifies a successful interaction.

2. A positive nonzero value is returned when an interaction is successful but status information is return.

3. A negative value is returned when an interaction has failed and error information is returned.

Properties

Name

Description

ComponentClassName

ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)

ComponentMembers

ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)

ComponentPatternName

ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)

ComponentTag

Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)

ComponentType

ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)

ComponentTypeName

ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)

Description

Returns a failed HRESULT as a string, otherwise it returns an empty string.

ErrorCode

Returns the current HRESULT as a 32-bit signed integer value.

ErrorWord

Returns the current HRESULT value as a hexadecimal string in the form of Xxxxxxxxx.

HelpContext

Returns the context identifier of the help text for a failed HRESULT as a 32-bit integer.

HelpFile

Returns the name of a Window�s help file that can be used to display help text for a failed HRESULT.

IsError

Returns a value indicating whether the current HRESULT is a failure.

Name

Name identifies the component Inherited from Object (PRIM_OBJT)

Owner

Owner owns this component Inherited from Object (PRIM_OBJT)

Parent

The component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances Inherited from Object (PRIM_OBJT)

Events

Name

Description

CreateInstance

CreateInstance is signalled when an instance of a component is created Inherited from Object (PRIM_OBJT)

DestroyInstance

DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Object (PRIM_OBJT)

Methods

Name

Description

Clear

Resets the Com Error component state corresponding to a HRESULT of zero.

ReportError

Reports the current ActiveX error state in a message box.

ReportErrorAndAbort

Reports the current ActiveX error state in a message box before aborting the application.

ShowErrorHelp

Shows any help provided for the current ActiveX error in an appropriate help window.


See also

All Component Classes

Technical Reference

  • No labels