IAccessibleRelation Interface Reference

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

import "AccessibleRelation.idl";

List of all members.


Public Member Functions

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

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:

To submit feedback on IAccessible2 API Version 1.2.1, please use the Bugzilla interface located at: http://bugs.linuxfoundation.org/. When using Bugzilla please be sure to select IAccessible2 from the list of components. Bugzilla is the preferred method for receiving feedback because it automatically logs one's feedback in the IAccessible2 tracking system without additional human intervention. One may also, however, send email to accessibility-rfc@a11y.org, a publicly archived emailing list. Please address any technical problems you encounter with this document or the resources to which it links, to the Open A11y Webmaster <webmaster@a11y.org>

A stable online reference version of the documentation for IAccessible2 API Version 1.2.1, is available at: http://a11y.org/ia2-spec. A list of known and reported errors in the documentation for IAccessible2 API Version 1.2.1 can be found at: http://a11y.org/ia2-errata


Generated on Fri Jan 21 14:02:46 2011 for IAccessible2 API Version 1.2.1 by  doxygen 1.5.6