AccessibleObject.GetHelpTopic(String) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 virtual int GetHelpTopic([Runtime::InteropServices::Out] System::String ^ % fileName);

public virtual int GetHelpTopic (out string fileName);

public virtual int GetHelpTopic (out string? fileName);

abstract member GetHelpTopic : string -> int
override this.GetHelpTopic : string -> int

Public Overridable Function GetHelpTopic (ByRef fileName As String) As Integer

Parameters

fileName: String

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

Returns

Int32

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

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.

Applies to