IAccessible::get_accHelp

[This is preliminary documentation and subject to change.]

Retrieves an object's Help property string.

HRESULT get_accHelp(
  VARIANT varChild,
  BSTR *pszHelp
);
 

Parameters

varChild

[in] VARIANT structure that identifies the child whose default action will be retrieved. This parameter can contain 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.

pszHelp

[out, retval] Address of a BSTR variable that will contain the Help property string for the specified object, or NULL if no Help string is available.

Return Values

Returns S_OK if successful or one of the following values or a standard COM error code otherwise.

Remarks

An object's Help property is represented in the form of a string that provides some helpful text to associate with the specified object. You can use this helpful text to provide a description of what the object does; contrast this with the Description property, which describes what an object looks like.

Note to implementers Objects need not support both the IAccessible::get_accHelp and IAccessible::get_accHelpTopic functions, but should support at least one. That is, if they can easily return a string they should support get_accHelp, otherwise they should support get_accHelpTopic. If both are supported, the object need not yield identical information.

Localize this property.

Developers of both servers and clients should be aware that getting information from a Help file might be expensive in terms of time and memory.

See Also

VARIANT Structure