IAccessible::get_accState

[This is preliminary documentation and subject to change.]

Retrieves the current state of the object or child item.

HRESULT get_accState(
  VARIANT varChild,
  VARIANT *pvarState
);
 

Parameters

varChild

[in] VARIANT structure identifying the child whose state will be retrieved. This parameter can be the child ID value (provided by the object), CHILDID_SELF for the object itself, or a string identifying the child (such as "A1"). The caller must initialize the structure's vt member to indicate which union member is valid prior to the call.

pvarState

[out, retval] VARIANT structure that will contain information describing the object's state. If the vt member is VT_I4, then the lVal member is one or more of the object state constants. If vt is VT_BSTR, then the bstrVal member contains a string describing the object's state.

Return Values

Returns S_OK if successful or E_INVALIDARG or another standard COM error code otherwise.

Note to implementers Localize the string returned from this property.

Remarks

It is recommended that you avoid using a string to identify the child; because if the object uses strings, it prevents the use of the default states. It is not recommended that you use this string functionality.

See Also

State Property, VARIANT Structure