Vcl.OleCtrls.TOleControl.GetHelpContext

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function GetHelpContext(Member: string; var HelpCtx: Integer;  var HelpFile: string): Boolean;

C++

bool __fastcall GetHelpContext(System::UnicodeString Member, int &HelpCtx, System::UnicodeString &HelpFile);

Properties

Type Visibility Source Unit Parent
function public
Vcl.OleCtrls.pas
Vcl.OleCtrls.hpp
Vcl.OleCtrls TOleControl

Description

Retrieves the Help context of a member of the ActiveX control.

Use GetHelpContext to retrieve the Help context of a member of the ActiveX control.

Member is the name of a property, method, or event of the ActiveX control. To retrieve the help context of the ActiveX control itself, set Member to nil (Delphi) or NULL (C++).

HelpCtx is a variable in which the Help context identifier of Member is to be stored.

HelpFile is a variable in which the name of the Help file containing HelpCtx is to be stored.

The information about the ActiveX control is retrieved from its ITypeInfo interfaces. For more information, search for ITypeInfo in the Microsoft Developer Network library.

GetHelpContext returns false if Member is not found; otherwise, GetHelpContext returns true.