CheckImage method

Class: EyesPlatform: ImagesLanguage: C# SDK:

Run a checkpoint on an image that you provide as a parameter.

Syntax


AppImage value = eyes.CheckImage(image, tag, replaceLast);

AppImage value = eyes.CheckImage(image, tag);

AppImage value = eyes.CheckImage(image);

AppImage value = eyes.CheckImage(image64, tag, replaceLast);

AppImage value = eyes.CheckImage(image64, tag);

AppImage value = eyes.CheckImage(image64);

AppImage value = eyes.CheckImage(image, tag, replaceLast);

AppImage value = eyes.CheckImage(image, tag);

AppImage value = eyes.CheckImage(image);

Parameters

image
Type:Bitmap
An image stored in a buffer in PNG format.
tag
Type:string [Optional : default = null ]

The tag defines a name for the checkpoint in the Eyes Test Manager. The name may be any string and serves to identify the step to the user in the Test manager. You may change the tag value without impacting testing in any way since Eyes does not use the tag to identify the baseline step that corresponds to the checkpoint - Eyes matches steps based on their content and position in the sequences of images of the test. See How Eyes compares checkpoints and baseline images for details.

replaceLast
Type:bool [Optional : default = false ]
If the value of this paramter is true then the image from this checkpoint should be used instead of the previous checkpoint image. This is typically used to implement a retry mechanism, when the previous check method returns a mismatch.
image64
Type:string
The image in base64 encoded image format.
image
Type:byte[]
The image as a byte stream (as it appears in the PNG image file).

Return value

Type: AppImage
This method returns an object with a boolean property IsMatch. If this property has a value of true indicates that the checkpoint matched, or is a new checkpoint. The meaning of a return value of false depends on whether this is the first checkpoint to return this value or not. For the first checkpoint that returns a value of false, the implication is that there was a mismatch. The test may choose to recapture the image and resend it (when using a check that supports this feature). Once one checkpoint has returned false, all the following checkpoints will also return false. This does not mean that the checkpoint mismatched; it means that Eyes will only know the final status of the checkpoint at the end of the test. If required, the actual result of the checkpoint should be obtained from the StepInfo object in the TestResults returned by the Close method.