IAccessibleRelation Interface Reference

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

import"ia2_api_all.idl";

Inheritance diagram for IAccessibleRelation:

Collaboration diagram for IAccessibleRelation:

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

Detailed Description

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

Definition at line 409 of file ia2_api_all.idl.

Property Documentation

localizedRelationType

BSTR IAccessibleRelation::localizedRelationType

get

Returns a localized version of the relation type.

Parameters

[out]

localizedRelationType

Return values

S_OK

nTargets

long IAccessibleRelation::nTargets

get

Returns the number of targets for this relation.

Parameters

[out]

nTargets

Return values

S_OK

Referenced by CAccRelation::get_nTargets(), and CAccRelation::get_targets().

relationType

BSTR IAccessibleRelation::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

Referenced by CAccRelation::get_relationType().

target

IUnknown IAccessibleRelation::target([in] long targetIndex)

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.

Referenced by CAccRelation::get_target(), and CAccRelation::get_targets().

targets

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

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:

• ia2_api_all.idl