EngineResultExtensions Methods

GetImageInfo

Gets the image information of the image instance that was found in IEngineResult. This method only works for IEngineResults that are returned from a successful image search. If that is not the case, it will return null. Example for usage: t.Testee.FindImage(imgFolderName).GetImageInfo().FileName

Syntax:

public static ImageInfo GetImageInfo(
	this IEngineResult info
)

Parameters:

Parameter	Description
info	Type: IEngineResult The object on which the extension is called and for which the image info will be returned.

Return Value:

The ImageInfo object (which contains the FileName) of the image instance that was found by the image search. If search was not successful, null is returned.

WasImageReferenceFound

Checks whether a specific image reference was found in an image search for multiple image references. Returns true if an image contained within the referenced imageReference was found.

Syntax:

public static bool WasImageReferenceFound(
    this IEngineResult info,
    ImageReference imageReference
)

Parameters:

Parameter	Description
info	Type: IEngineResult The object on which the extension is called and for which the image info will be returned.
imageReference	Type: ImageReference The image reference that shall be checked if it was found.

Return Value:

True if an image contained within the referenced imageReference was found, false otherwise. If image search was not successful or info was not an image search at all, returns false as well.