WriteCustomStringData Method

NI Vision for Visual Basic

WriteCustomStringData Method

Syntax

CWIMAQVision.WriteCustomStringData Image, Key, Data

Return Type

Long

On success, this method returns 0. On failure, this method returns a negative number.

Purpose

Associates a string with a keyname in an image.

Remarks

You can use this method with all image types.

Data stored with this method will be viewable across all platforms.

Parameters

Image As CWIMAQImage

The image that will hold the string data.

Key As String

The keyname to associate the data with.

Data As String

The string to store in the image.