AddSetupChecklistItem()

The AddSetupChecklistItem() function of the sySetupChecklistObj form adds an item or category to the Setup Checklist.

Syntax

AddSetupChecklistItem(ParentDictID, ParentFormID, ParentCmdID, Sequence, CmdDictID, CmdFormID, CmdID, WindowTechName, Optional, HelpFile, HelpTopic)

Parameters

• ParentDictID – The ID of the dictionary that contains the command list used for the node to which the Setup Checklist item will be added. Use the constant DYNAMICS to specify that you are adding an item to a category defined by the Microsoft Dynamics GP main dictionary.

• ParentFormID – The resource ID of the command form that contains the definition of the command list used for the node to which you are adding an item.

• ParentCmdID – The resource ID of the command list used for the node to which you are adding an item.

• Sequence – An integer variable that can be used to specify the position of the item being added. The value 0 specifies the item will be added to the end of the category list. The actual position of the item will be returned after it is added.

• CmdDictID – The ID of the dictionary that contains the command you are adding.

• CmdFormID – The resource ID of the command form that contains the definition of the command you are adding.

• CmdID – The resource ID of the command you adding.

• WindowTechName – A string specifying the technical name of the window to be accessed by the Setup Checklist item. If you are adding a category to the Setup Checklist, specify the empty string ("").

• Optional – A boolean that indicates whether the setup action to be performed by the Setup Checklist item is optional. The value true indicates the action is optional, while the value false indicates it is required.

• HelpFile – A string specifying the name of the constant in your application dictionary that contains the name of the compiled HTML Help file to display a topic from. The value of the constant must include the .chm file extension.

• HelpTopic – A string specifying the HTML Help topic to display for the Setup Checklist item or category. You must specify the HTML filename of the topic to display, including the .htm file extension. You cannot use a help context number to specify a topic to display.

Return value

An integer indicating whether the item was added to the Setup Checklist. The value corresponds to one of the following constants:

Comments

The constant SETUPCHECKLIST_TOPLEVEL is used to specify the dictionary ID, command form ID, and command ID of the top-level node in the Setup Checklist tree. This node isn’t visible in the tree.

Every item you add to the Setup Checklist should have a corresponding help topic in the compiled HTML Help file for your integration. For individual items, the topic should describe the setup actions the user can perform with the setup window. For categories, the topic should describe the overall setup process for the group.

Documentation Feedback

---