IAccessibleRelation

Method overview

Methods

localizedRelationType()

Returns a localized version of the relation type.

[propget] HRESULT localizedRelationType(
  [out] BSTR localizedRelationType 
);

Parameters

localizedRelationType

Return value

S_OK.

nTargets()

Returns the number of targets() for this relation.

[propget] HRESULT nTargets(
  [out] long nTargets 
);

Parameters

nTargets

Return value

S_OK.

relationType()

Returns the type of the relation.

[propget] HRESULT relationType(
  [out] BSTR relationType 
);

Parameters

relationType

The strings returned are defined @ref grpRelations "in this section of the documentation".

Return value

S_OK.

target()

Returns one accessible relation target.

[propget] HRESULT target(
  [in] long targetIndex,
  [out] IUnknown target 
);

Parameters

targetIndex

0 based index.

target

Return value

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

targets()

Returns multiple accessible relation targets.

[propget] HRESULT targets(
  [in] long maxTargets,
  [out, size_is(maxTargets), length_is( nTargets)] IUnknown targets,
  [out] long nTargets 
);

Parameters

maxTargets

Maximum size of the array allocated by the client.

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 @ref _arrayConsideration "Special Consideration when using Arrays" for more details. You will need to use QueryInterface on the IUnknown to get the IAccessible2.

nTargets

Actual number of targets in the returned array (not more than maxTargets)

Return value

S_FALSE if there is nothing to return, nTargets() is set to 0. S_OK.

See also

• IAccessible2