This documentation is archived and is not being maintained.

AccessibleObject.GetHelpTopic Method

Gets an identifier for a Help topic identifier and the path to the Help file associated with this accessible object.

[Visual Basic]
Public Overridable Function GetHelpTopic( _
   <Out()> ByRef fileName As String _
) As Integer
[C#]
public virtual int GetHelpTopic(
   out string fileName
);
[C++]
public: virtual int GetHelpTopic(
   [
   Out
] String** fileName
);
[JScript]
public function GetHelpTopic(
   fileName : String
) : int;

Parameters

fileName
On return, this property contains the path to the Help file associated with this accessible object.

Return Value

An identifier for a Help topic, or -1 if there is no Help topic. On return, the fileName parameter contains the path to the Help file associated with this accessible object.

Exceptions

Exception Type Condition
COMException The Help topic for the control cannot be retrieved.

Remarks

To display help for the AccessibleObject using the Windows Help system, you can pass the file name and topic ID to the appropriate Help.ShowHelp method of Help.

Notes to Inheritors:  Not all objects need to support this property.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

AccessibleObject Class | AccessibleObject Members | System.Windows.Forms Namespace | Help | AccessibleObject.Help

Show: