Description Property

Applies To

• Vision Sequence
• Vision Calibration
• Vision Objects: All

Description
Sets a user description for a sequence, object, or calibration.

Usage

VGet  {Sequence | Calibration}.Description, var
VSet  {Sequence | Calibration}.Description, value
VGet  Sequence.Object.Description, var
VSet  Sequence.Object.Description, value

Sequence

Name of a sequence or string variable containing a sequence name.

Calibration

Name of a calibration or string variable containing a calibration name.

Object

Name of an object or string variable containing an object name. The object must exist in the specified sequence.

var

String variable that will contain the value of the property.

value

String or string expression for the new value of the property.

Values
Default: Empty

Remarks
Use the Description property to add information about a sequence, object, or calibration. At runtime, you can use VGet to retrieve the description and display it for an operator. The Description can be up to 255 characters and can contain multiple lines.

You can modify this description from the Vision Guide GUI by changing the Description property value. Or you can use VSet to set the description at runtime.

See Also
ArcFinder Object, ArcInspector Object, Blob Object, BoxFinder Object, CodeReader Object, ColorMatch Object, Contour Object, CornerFinder Object, Correlation Object, DefectFinder Object, Edge Object, Frame Object, Geometric Object, ImageOp Object, Line Object, LineFinder Object, LineInspector Object, OCR Object, Point Object, Polar Object, Text Object, Vision Sequences