XJTAG logo
Open search box button
Close search button

TEST_DETAILS_PIN_LINK

The TEST_DETAILS_PIN_LINK function is part of the TEST_DETAILS output framework and prints a hyperlink for a pin in the test output, that enables the pin to be visualised in the application. It is defined and used the same way as PRINT_PIN_LINK but outputs to the test details section instead of being printed immediately as part of the normal test output. Multiple pins can be linked to using TEST_DETAILS_PINS_LINK.

TEST_DETAILS_PIN_LINK was added in XJTAG v3.1.0.

Syntax

TEST_DETAILS_PIN_LINK( STRING pinReference )
TEST_DETAILS_PIN_LINK( STRING text, STRING pinReference )

Parameters

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

A string that identifies a pin in the netlist in the form 'board.component.pin'. This may be a string returned from the GET_PIN function. The board name is optional, but the pin reference must uniquely identify the pin, so if there is any ambiguity with the device reference, then the board name must be supplied.

Errors

An error can occur in the following circumstances:

  • The device referenced by pinReference does not match any device in the project.
  • The pin referenced by pinReference does not exist on the device.
  • The pinReference 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