Control.ControlAccessibleObject.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 and the path to the Help file associated with this accessible object.

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

public override int GetHelpTopic (out string fileName);

public override int GetHelpTopic (out string? fileName);

override this.GetHelpTopic : string -> int

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

Parameters

fileName: String

When this method returns, contains a string that represents the path to the Help file associated with this accessible object. This parameter is passed uninitialized.

Returns

Int32

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

Remarks

Pass the identifier to the WinHelp file specified by the fileName parameter to identify the desired Help topic.

Applies to