HelpContextID Property (Command Object)

[Microsoft Agent is deprecated as of Windows 7, and may be unavailable in subsequent versions of Windows.]

Description

Returns or sets an associated context number for the Command object. Used to provide context-sensitive Help for the Command object.

Syntax

*agent.*Characters("CharacterID").Commands("").HelpContextID [ = Number]

Part	Description
Number	An integer specifying a valid context number.

 

Remarks

If you've created a Windows Help file for your application and set the character's HelpFile property to the file, Agent automatically calls Help when HelpModeOn is set to True and the user selects the command. If you set a context number in the HelpContextID, Agent calls Help and searches for the topic identified by the current context number. The current context number is the value of HelpContextID for the command.

This property applies only to your client application's use of the character; the setting does not affect other clients of the character or other characters of your client application.

See Also

HelpFile property