NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

Help.ShowHelp (Control, String, Int32, Object)

Displays the contents of the Help file located at the URL supplied by the user.

[Visual Basic]
Overloads Public Shared Sub ShowHelp( _
   ByVal parent As Control, _
   ByVal url As String, _
   ByVal command As Integer, _
   ByVal param As Object _
)
[C#]
public static void ShowHelp(
   Control parent,
   string url,
   int command,
   object param
);
[C++]
public: static void ShowHelp(
   Control* parent,
   String* url,
   int command,
   Object* param
);
[JScript]
public static function ShowHelp(
   parent : Control,
   url : String,
   command : int,
   param : Object
);

Parameters

parent
A Control that identifies the parent of the Help dialog box.
url
The path to the HTMLHelp or Win32 Help file.
command
A constant that indicates what kind of information to display. Acceptable values are COMMAND_CONTENTS, COMMAND_FIND, COMMAND_INDEX, or COMMAND_TOPIC.
param
Command-specific data. If the value specified in the command parameter is COMMAND_CONTENTS, COMMAND_INDEX, or COMMAND_FIND, this value should be a null reference (in Visual Basic Nothing). If the command parameter references COMMAND_TOPIC, this value should reference an object that contains the numeric value of the topic to display.

Remarks

Based on the value of the url parameter, this static (in Visual Basic Shared) method automatically determines whether an HTMLHelp or Win32 Help file is displayed.

You can also specify a Win32 Help or HTMLHelp command directly by using the constants defined in the Win32 SDK.

See Also

Help Class | Help Members | System.WinForms Namespace | Help.ShowHelp Overload List | ShowHelpIndex | ShowPopup