User`s guide

7 Storing Adaptor Information in an IMDF File
7-6
Element Description Attributes
<Help> Defines the help section in an
IMDF file. Must be child of the
ImageAcquisitionInfo node.
None
<AdaptorHelp> Defines the online help for
a property. The Help node
can contain one or more
AdaptorHelp nodes.
property=name, where name
is a text string specifying the
property name
<DeviceHelp> Specifies device-specific text
in property help. This element
is optional. An AdaptorHelp
node can contain multiple
DeviceHelp nodes.
device=name, where name is
a text string that identifies a
particular device
<SeeAlso> Defines the see also line in
property help. This element
is optional. An AdaptorHelp
node can contain multiple
SeeAlso nodes.
None
User Scenario: Viewing Property Help
The purpose of using a Help element in an IMDF file is to create help text for device-
specific properties. A user of your adaptor can display the help text at the command line
using the imaqhelp command.
The following example shows how a user displays the help text for a device-specific
property using the imaqhelp command. To see how to create this help in an IMDF file,
see “Creating AdaptorHelp Nodes” on page 7-8.