OpenLvVision_Overlays.lvlib:OverlayLabeledRectangleBoundingBox.vi

Overlays an rectangle with text on top of an image.

OpenLvVision_Overlays.lvlib:OverlayLabeledRectangleBoundingBox.vi

cerrcodeclst

error in

error in can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

Right-click the error in control on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.

    cbool

    		status

    status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

    Right-click the error in control on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.

    ci32

    		code

    cstr

    		source

    source describes the origin of the error or warning.

    Right-click the error in control on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.

cudtagrefflat

Image Reference In

An Image reference is a handle to the actual image data in memory. It's important to note that you are responsible for manually releasing (deallocating) the memory associated with this image reference when it's no longer needed to prevent memory leaks.

cstr

Text

Text to display on the label.

ccclst

BoundingBox

The coordinates of the rectangle s corners

    cnclst

    		TopLeft

      ci32

      		X

      ci32

      		Y

    cnclst

    		TopRight

      ci32

      		X

      ci32

      		Y

    cnclst

    		BottomRight

      ci32

      		X

      ci32

      		Y

    cnclst

    		BottomLeft

      ci32

      		X

      ci32

      		Y

cu32

OverlayColor

Color of the overlay.

cstr

GroupName

Name of the overlay group you want to add to.

ccclst

TextSettings

    cstr

    		Desired Font

    Desired Font (Application) specifies the character type of the text.

    cbool

    		Strikeout?

    Strikeout? causes the text to appear in strikeout if TRUE.

    cbool

    		Italic?

    Italic? causes the text to appear in italic if TRUE.

    cbool

    		Underline?

    Underline? causes the text to appear underlined if TRUE.

    cbool

    		Outline?

    Outline? causes the text to appear in outline if TRUE.

    cbool

    		Shadow?

    Shadow? causes the text to appear in shadow if TRUE.

    cbool

    		Bold?

    Bold? causes the text to appear in bold if TRUE

    ci32

    		Size

    Size is the size of the font in points.

cu32

TextColor

Color of the text.

ierrcodeclst

error out

error in can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

Right-click the error in control on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.

    ibool

    		status

    status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

    Right-click the error in control on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.

    ii32

    		code

    istr

    		source

    source describes the origin of the error or warning.

    Right-click the error in control on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.

iudtagrefflat

Image Reference Out

An Image reference is a handle to the actual image data in memory. It's important to note that you are responsible for manually releasing (deallocating) the memory associated with this image reference when it's no longer needed to prevent memory leaks.