XJTAG logo
Open search box button
Close search button

TEST_DETAILS_DEVICE_LINK

The TEST_DETAILS_DEVICE_LINK function is part of the TEST_DETAILS output framework and prints a hyperlink for a device in the test output that enables the device to be visualised in the application. It is the same as PRINT_DEVICE_LINK, but outputs to the test details section instead of being printed immediately as part of the normal test output. Multiple devices can be linked to using TEST_DETAILS_DEVICES_LINK.

TEST_DETAILS_DEVICE_LINK was added in XJTAG v3.1.0.

Syntax

TEST_DETAILS_DEVICE_LINK( STRING deviceReference )
TEST_DETAILS_DEVICE_LINK( STRING text, STRING deviceReference )

Parameters

text
Optional text to print for the link. If this argument is not given the text used will be the name of the device being linked to.
deviceReference

A device reference in the form 'board.device'. The read-only built-in UNIQUE_DEVICE_REF contains this string for the current test device file. The board name is optional, but the device reference must uniquely identify the device; if there is any ambiguity, then the board name must be supplied.

Errors

An error can occur in the following circumstances:

  • The deviceReference supplied does not match any test device in the project.
  • The deviceReference supplied does not contain a board name and matches more than one device.

In both these cases, if the expressions are constant, the error will occur at compile-time. Otherwise, the error will occur at run-time, when the function is run.

See Also