DISPID (Compact 2013)

3/26/2014

This data type is used by IDispatch::Invoke to identify methods, properties, and arguments.

Syntax

Typedef LONG DISPID; 

Remarks

The following table shows the dispatch identifiers (DISPIDs) with special meaning.

DISPID

Description

DISPID_VALUE

The default member for the object. This property or method is invoked when an ActiveX client specifies the object name without a property or method.

DISPID_NEWENUM

The _NewEnum property. This special, restricted property is required for collection objects. It returns an enumerator object that supports IEnumVARIANT, and should have the restricted attribute specified in Object Description Language.

DISPID_EVALUATE

The Evaluate method. This method is implicitly invoked when the ActiveX client encloses the arguments in square brackets. For example, the following two lines are equivalent.

x.[A1:C1].value =10
x.Evaluate("A1:C1").value = 10 

The Evaluate method has the DISPID DISPID_EVALUATE.

DISPID_PROPERTYPUT

The parameter that receives the value of an assignment in a PROPERTYPUT.

DISPID_CONSTRUCTOR

The C++ constructor function for the object.

DISPID_DESTRUCTOR

The C++ destructor function for the object.

DISPID_UNKNOWN

The value returned by IDispatch::GetIDsOfNames to indicate that a member or parameter name was not found.

DISPID_COLLECT

The Collect property. You use this property if the method you are calling through Invoke is an accessor function.

The following DISPIDs are reserved:

  • DISPID_Name (800)
  • DISPID_Delete (801)
  • DISPID_Object (802)
  • DISPID_Parent (803)

Requirements

Header

oaidl.h

See Also

Reference

Automation Data Types
IDispatch::Invoke