OleAccAccessibleChildren Method

Retrieves the child ID or IDispatch of each child within an accessible container object.

Definition

Namespace: DevCase.Win32.NativeMethods
Assembly: DevCase.net48 (in DevCase.net48.dll) Version: 6.0.0.0 (6.0)
XMLNS for XAML: Not mapped to an xmlns.
[DllImportAttribute("OleAcc.dll", SetLastError = true)]
public static HResult AccessibleChildren(
	IAccessible container,
	int childStart,
	int childrenCount,
	Object[] children,
	ref int refObtained
)

Parameters

container  IAccessible
Pointer to the container object's IAccessible interface.
childStart  Int32
Specifies the zero-based index of the first child that is retrieved.

This parameter is an index, not a child ID, and it is usually is set to zero (0).

childrenCount  Int32
Specifies the number of children to retrieve.

To retrieve the current number of children, an application calls IAccessible::get_accChildCount.

children  Object
Pointer to an array of VARIANT structures that receives information about the container's children.

If the vt member of an array element is VT_I4, then the lVal member for that element is the child ID.

If the vt member of an array element is VT_DISPATCH, then the pdispVal member for that element is the address of the child object's IDispatch interface.

refObtained  Int32
Address of a variable that receives the number of elements in the children array that is populated by the AccessibleChildren(IAccessible, Int32, Int32, Object, Int32) function.

This value is the same as that of the childrenCount parameter; however, if you request more children than exist, this value will be less than that of childrenCount.

Return Value

HResult
If the function succeeds, the return value is S_OK.

If the function fails, the return value is a different HResult value.

Remarks

See Also