WaitForScreenChange Method (Int32, Int32, Int32, Int32, String, Int32, Int32, UInt32, UInt32)

CitrixVirtualUser WaitForScreenChange Method (Int32, Int32, Int32, Int32, String, Int32, Int32, UInt32, UInt32)

C# API

Wait for a portion of the screen to change.

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

Syntax

public void WaitForScreenChange(
	int xPos,
	int yPos,
	int width,
	int height,
	string bitmapFile,
	int timeout,
	int pollingFrequency,
	uint tolerance,
	uint maxDiscrepancy
)

public void WaitForScreenChange(
	int xPos,
	int yPos,
	int width,
	int height,
	string bitmapFile,
	int timeout,
	int pollingFrequency,
	uint tolerance,
	uint maxDiscrepancy
)

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

tolerance: Type: System UInt32
The maximum variation from the original RGB value of each pixel.

maxDiscrepancy: Type: System UInt32
The maximum number of pixels that are allowed to fail to match

Remarks

Waits for the bitmapFile to no longer be found in the search area.

Examples

C++

Copy to Clipboard Print

// Capture a region of the screen to a file
SaveScreenshotToFile(0, 0, 20, 10, @"view_batch_screen.bmp");

// Compare screen portion to saved screen portion every five seconds, timeout after 60 seconds
WaitForScreenChange(0, 0, 20, 10, "view_batch_screen", 60000, 5000);

// Capture a region of the screen to a file
SaveScreenshotToFile(0, 0, 20, 10, @"view_batch_screen.bmp");

// Compare screen portion to saved screen portion every five seconds, timeout after 60 seconds
WaitForScreenChange(0, 0, 20, 10, "view_batch_screen", 60000, 5000);