IAccessible::get_accChildCount

[This is preliminary documentation and subject to change.]

Retrieves the number of children belonging to the current object.

HRESULT get_accChildCount(
  long* pcountChildren
);
 

Parameters

pcountChildren

[out, retval] Address of a variable that will contain the number of child objects belonging to this object. The children can be separate objects or child elements. If the object has no children, this value will be zero.

Return Values

Returns S_OK if successful or a standard COM error code otherwise.

Note The IDispatch interface returned must be released when the client is finished using it. This can be done by calling the Release() member. Failure to do so will keep the object in memory, causing memory leaks.

Remarks

The number of children in an object can change. An application should watch for EVENT_OBJECT_CREATE and EVENT_OBJECT_DESTROY events generated by the current object to keep track of possible child count updates.

The children of this object might or might not be objects themselves.

Note to implementers This method must not fail if no child objects exist. Instead, return S_OK and set the variable at pcountChildren to zero.