Click or drag to resize

Adding Help Information

Most of the items in an IVI-COM driver (methods, properties, parameters, etc.) have help information associated with them. The help content is used to generate HTML help files as well as other help-based artifacts, such as the XML IntelliSense file and the type library help information. The topics under Creating a Driver Help File provide detailed information on how driver help content is used.

Irrespective of where Nimbus uses the help information for an item, the content for each item is managed from a single location -- the Help Editor.

To add help information to an item

  1. From Solution Explorer, double-click the Driver Designer node under the Nimbus node.

  2. The Driver Designer opens as a tabbed document window. Select the IVI-COM tab.

  3. From the tree view expand the type library node for the instrument-specific hierarchy. This node is named "<driverName>Lib".

  4. Select the desired item (method, property, parameter, etc.) from the tree view.

  5. On the right-side of the IVI-COM Designer, click the Help button along the lower section of the designer.

  6. The Help Editor appears. Select the Source view to enter HTML help content for each field defined by the help template. See the Help Editor topic for details.

See Also

Other Resources

Download a complete CHM version of this documentation here.