IAccessible::get_accDefaultAction

[This is preliminary documentation and subject to change.]

Retrieves a string containing a localized sentence that describes the object's default action.

HRESULT get_accDefaultAction(
  VARIANT varChild,
  BSTR* pszDefaultAction
);

Parameters

varChild: [in] VARIANT structure that identifies the child whose default action will be retrieved. This parameter can contain the child ID value (provided by the object), CHILDID_SELF for the object itself, or a string identifying the child (such as "A1").
pszDefaultAction: [out, retval] Address of a BSTR variable that will contain a string describing the default action for this object, or NULL if this object has no default action.

Return Values

Returns S_OK if successful or one of the following values or a standard COM error code otherwise.

DISP_E_MEMBERNOTFOUND

E_INVALIDARG

Remarks

The retrieved string describes the action that is performed on an object, not what the object does as a result. That is, a toolbar button that prints a document would have a default action of "Press" rather than "Prints the current document." Also, do not confuse an object's default action with its value. For more information, see DefaultAction Property.

Only controls that perform actions support this method.

Note to implementers Localize the string returned from this property.