IAccessible::get_accName

[This is preliminary documentation and subject to change.]

Retrieves the Name property for this object.

HRESULT get_accName(
  VARIANT varChild,
  BSTR* pszName
);
 

Parameters

varChild

[in] VARIANT structure identifying the child whose name 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.

pszName

[out, retval] Address of a string containing this object's name.

Return Values

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

Note to implementers If you are using menu or button text for the Name property, strip any ampersands (&) marking keyboard access keys; the information they convey can be provided to the client in response to IAccessible::get_accKeyboardShortcut calls.

Do not localize the string returned from this property.

See Also

IAccessible::put_accName, VARIANT Structure