CitrixVirtualUserScript WaitForScreenMatch Method (Int32, Int32, Int32, Int32, String, Int32, Int32, Int32, UInt32)C# API
Wait for an image to appear in a specified portion of the screen.

Namespace: Facilita.Fc.Citrix
Assembly: fcCitrix (in fcCitrix.dll) Version: 9.4.0.26
Syntax

[ObsoleteAttribute("WaitForScreenMatch has been deprecated. Please use WaitForImage instead.")]
public Rectangle WaitForScreenMatch(
	int xPos,
	int yPos,
	int width,
	int height,
	string bitmapFile,
	int timeout,
	int pollingFrequency,
	int searchRadius,
	uint maxDiscrepancy = 0
)

Parameters

xPos
Type: System Int32
The x co-ordinate of the top-left of the screen rectangle.
yPos
Type: System Int32
The y co-ordinate of the top-left of the screen rectangle.
width
Type: System Int32
The width of the screen rectangle.
height
Type: System Int32
The height of the screen rectangle.
bitmapFile
Type: System String
The location and name of the bitmap file to compare relative to the data folder.
timeout
Type: System Int32
The time in milliseconds before a TimeoutException is raised
pollingFrequency
Type: System Int32
The polling frequency, in milliseconds
searchRadius
Type: System Int32
The search radius expands the search area.
maxDiscrepancy (Optional)
Type: System UInt32
The maximum number of pixels that are allowed to fail to match

Return Value

The rectangle where the.image was found. This value is also copied to LastFoundLocation
Exceptions

ExceptionCondition
TimeoutException
Remarks

The call searches for the image (bitmap) until it is is found or the timeout period expires and a TimeoutException is raised.
See Also