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:
-
HRESULT IAccessibleRelation::nTargets |
( |
[out, retval] long * |
nTargets |
) |
[get] |
Returns the number of targets for this relation.
- Parameters:
-
- Return values:
-
HRESULT IAccessibleRelation::relationType |
( |
[out, retval] BSTR * |
relationType |
) |
[get] |
Returns the type of the relation.
- Parameters:
-
- Return values:
-
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 | |
| S_FALSE | if there is nothing to return, [out] value is NULL |
| E_INVALIDARG | if bad [in] passed, [out] value is NULL |
- 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 | |
| S_FALSE | if there is nothing to return, nTargets is set to 0 |
The documentation for this interface was generated from the following file: