IAccessible2_2 Interface Reference

This interface exposes the primary set of information about an IAccessible2 enabled accessible object. More...

import "Accessible2_2.idl";

Inheritance diagram for IAccessible2_2:

Public Member Functions
HRESULT	attribute ([in] BSTR name,[out, retval] VARIANT *attribute)
	Returns the attribute value of a specified attribute specific to this object. More...
HRESULT	accessibleWithCaret ([out] IUnknown **accessible,[out, retval] long *caretOffset)
	Returns the deepest hypertext accessible in the subtree of this object, and the caret offset within it. More...
HRESULT	relationTargetsOfType ([in] BSTR type,[in] long maxTargets,[out, size_is(,*nTargets)] IUnknown ***targets,[out, retval] long *nTargets)
	Returns relation targets for a specified target type. More...
Public Member Functions inherited from IAccessible2
HRESULT	nRelations ([out, retval] long *nRelations)
	Returns the number of accessible relations for this object. More...
HRESULT	relation ([in] long relationIndex,[out, retval] IAccessibleRelation **relation)
	Returns one accessible relation for this object. More...
HRESULT	relations ([in] long maxRelations,[out, size_is(maxRelations), length_is(*nRelations)] IAccessibleRelation **relations,[out, retval] long *nRelations)
	Returns multiple accessible relations for this object. More...
HRESULT	role ([out, retval] long *role)
	Returns the role of an IAccessible2 object. More...
HRESULT	scrollTo ([in] enum IA2ScrollType scrollType)
	Makes an object visible on the screen. More...
HRESULT	scrollToPoint ([in] enum IA2CoordinateType coordinateType,[in] long x,[in] long y)
	Moves the top left of an object to a specified location. More...
HRESULT	groupPosition ([out] long *groupLevel,[out] long *similarItemsInGroup,[out, retval] long *positionInGroup)
	Returns grouping information. More...
HRESULT	states ([out, retval] AccessibleStates *states)
	Returns the bit strip containing any IAccessible2 states. More...
HRESULT	extendedRole ([out, retval] BSTR *extendedRole)
	Returns the extended role. More...
HRESULT	localizedExtendedRole ([out, retval] BSTR *localizedExtendedRole)
	Returns the localized extended role. More...
HRESULT	nExtendedStates ([out, retval] long *nExtendedStates)
	Returns the number of extended states. More...
HRESULT	extendedStates ([in] long maxExtendedStates,[out, size_is(, maxExtendedStates), length_is(,*nExtendedStates)] BSTR **extendedStates,[out, retval] long *nExtendedStates)
	Returns the extended states (array of strings). More...
HRESULT	localizedExtendedStates ([in] long maxLocalizedExtendedStates,[out, size_is(, maxLocalizedExtendedStates), length_is(,*nLocalizedExtendedStates)] BSTR **localizedExtendedStates,[out, retval] long *nLocalizedExtendedStates)
	Returns the localized extended states (array of strings). More...
HRESULT	uniqueID ([out, retval] long *uniqueID)
	Returns the unique ID. More...
HRESULT	windowHandle ([out, retval] HWND *windowHandle)
	Returns the window handle for the parent window which contains this object. More...
HRESULT	indexInParent ([out, retval] long *indexInParent)
	Returns the index of this object in its parent object. More...
HRESULT	locale ([out, retval] IA2Locale *locale)
	Returns the IA2Locale of the accessible object. More...
HRESULT	attributes ([out, retval] BSTR *attributes)
	Returns the attributes specific to this object, such as a cell's formula. More...

Detailed Description

This interface exposes the primary set of information about an IAccessible2 enabled accessible object.

This interface must always be provided for objects that support some portion of the collection of the IAccessible2 interfaces.

Please refer to Changing between Accessible Interfaces for special considerations related to use of the MSAA IAccessible interface and the set of IAccessible2 interfaces.

Member Function Documentation

HRESULT IAccessible2_2::accessibleWithCaret ( [out] IUnknown **  accessible, [out, retval] long *  caretOffset  )

get

Returns the deepest hypertext accessible in the subtree of this object, and the caret offset within it.

Parameters

[out]	accessible
[out]	caretOffset

Return values

S_OK
S_FALSE	returned if there is no caret in any of the objects in the subtree, [out] accessible is NULL and [out] caretOffset is -1.

HRESULT IAccessible2_2::attribute ( [in] BSTR  name, [out, retval] VARIANT *  attribute  )

get

Returns the attribute value of a specified attribute specific to this object.

Parameters

[in]	name
[out]	attribute

Return values

S_OK
S_FALSE	returned if there is nothing to return, [out] value is NULL.
E_INVALIDARG	if bad [in] passed.

Note

The output value is a VARIANT. Typically it will be a VT_BSTR, but there are some cases where it will be a VT_I4 or VT_BOOL. Refer to the Object Attributes specification for more information.

HRESULT IAccessible2_2::relationTargetsOfType ( [in] BSTR  type, [in] long  maxTargets, [out, size_is(,*nTargets)] IUnknown ***  targets, [out, retval] long *  nTargets  )

get

Returns relation targets for a specified target type.

Parameters

[in]	type	The requested relation type.
[in]	maxTargets	The number of targets requested. 0 indicates that all targets should be returned.
[out]	targets	This array is allocated by the server. The client must free it with CoTaskMemFree.
[out]	nTargets	The number of targets returned; the size of the returned array.

Return values

S_OK
S_FALSE	if there are no targets, [out] values are NULL and 0 respectively.
E_INVALIDARG	if bad [in] passed.

---

The documentation for this interface was generated from the following file:

• Accessible2_2.idl