IAccessibleRelation Interface Reference

import "AccessibleRelation.idl";

Inheritance diagram for IAccessibleRelation:

Public Member Functions
HRESULT	relationType ([out, retval] BSTR *relationType)
	Returns the type of the relation. More...
HRESULT	localizedRelationType ([out, retval] BSTR *localizedRelationType)
	Returns a localized version of the relation type. More...
HRESULT	nTargets ([out, retval] long *nTargets)
	Returns the number of targets for this relation. More...
HRESULT	target ([in] long targetIndex,[out, retval] IUnknown **target)
	Returns one accessible relation target. More...
HRESULT	targets ([in] long maxTargets,[out, size_is(maxTargets), length_is(*nTargets)] IUnknown **targets,[out, retval] long *nTargets)
	Returns multiple accessible relation targets. More...

Detailed Description

This interface gives access to an object's set of relations.

Member Function Documentation

HRESULT IAccessibleRelation::localizedRelationType ( [out, retval] BSTR *  localizedRelationType )

get

Returns a localized version of the relation type.

Parameters

[out]

localizedRelationType

Return values

S_OK

HRESULT IAccessibleRelation::nTargets ( [out, retval] long *  nTargets )

get

Returns the number of targets for this relation.

Parameters

[out]

nTargets

Return values

S_OK

HRESULT IAccessibleRelation::relationType ( [out, retval] BSTR *  relationType )

get

Returns the type of the relation.

Parameters

[out]

relationType

The strings returned are defined in this section of the documentation.

Return values

S_OK

HRESULT IAccessibleRelation::target ( [in] long  targetIndex, [out, retval] IUnknown **  target  )

get

Returns one accessible relation target.

Parameters

[in]	targetIndex	0 based index
[out]	target

Return values

S_OK
E_INVALIDARG	if bad [in] passed

Note

Use QueryInterface to get IAccessible2.

HRESULT IAccessibleRelation::targets ( [in] long  maxTargets, [out, size_is(maxTargets), length_is(*nTargets)] IUnknown **  targets, [out, retval] long *  nTargets  )

get

Returns multiple accessible relation targets.

Parameters

[in]	maxTargets	maximum size of the array allocated by the client
[out]	targets	The array of target objects. Note that this array is to be allocated by the client and freed when no longer needed. Refer to Special Consideration when using Arrays for more details. You will need to use QueryInterface on the IUnknown to get the IAccessible2.
[out]	nTargets	actual number of targets in the returned array (not more than maxTargets)

Return values

S_OK
E_INVALIDARG	if bad [in] passed, e.g. a negative value

---

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

• AccessibleRelation.idl