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 **target,[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  ) 
 

Returns a localized version of the relation type.

Parameters:
[out] localizedRelationType 

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

Returns the number of targets for this relation.

Parameters:
[out] nTargets 

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

Returns the type of the relation.

Parameters:
[out] relationType 

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

Returns one accessible relation target.

Parameters:
[in] targetIndex 0 based index
[out] target Note: Use QueryInterface to get IAccessible2.

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

Returns multiple accessible relation targets.

Parameters:
[in] maxTargets Maximum number of targets to get.
[out] target Array of accessible targets. Use QueryInterface to get IAccessible2.
[out] nTargets length of array (not more than maxTargets)


The documentation for this interface was generated from the following file:
Generated on Mon Mar 26 17:38:26 2007 for IAccessible2 API by  doxygen 1.4.6-NO