RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
TOleControl.GetHelpContext Method

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

Pascal
function GetHelpContext(Member: string; var HelpCtx: Integer; var HelpFile: string): Boolean;
C++
__fastcall Boolean GetHelpContext(AnsiString Member, int HelpCtx, AnsiString HelpFile);

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 the OLE.HLP file for ITypeInfo. 

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

 

Copyright(C) 2008 CodeGear(TM). All Rights Reserved.
What do you think about this topic? Send feedback!