CheckForBitmap Method

CitrixVirtualUser CheckForBitmap Method

C# API

Checks if a bitmap has appeared in an expected position

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

Syntax

[ObsoleteAttribute("CheckForBitmap has been deprecated. Please use CheckForImage instead.")]
public bool CheckForBitmap(
	int xPos,
	int yPos,
	int width,
	int height,
	string bitmapFile,
	int timeout,
	int pollingFrequency,
	int searchRadius,
	uint tolerance,
	uint maxDiscrepancy
)

[ObsoleteAttribute("CheckForBitmap has been deprecated. Please use CheckForImage instead.")]
public bool CheckForBitmap(
	int xPos,
	int yPos,
	int width,
	int height,
	string bitmapFile,
	int timeout,
	int pollingFrequency,
	int searchRadius,
	uint tolerance,
	uint maxDiscrepancy
)

Parameters

xPos: Type: System Int32
The x coordinate of the top left hand corner of the rectangle to search

yPos: Type: System Int32
The y coordinate of the top left hand corner of the rectangle to search

width: Type: System Int32
The width of the rectangle to search

height: Type: System Int32
The height of the rectangle to search

bitmapFile: Type: System String
The path of the bitmap file to search for

timeout: Type: System Int32
The maximum number of milliseconds to wait for the image to appear

pollingFrequency: Type: System Int32
The polling frequency, in milliseconds

searchRadius: Type: System Int32
Increases the search area by this value in all directions

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

Return Value

Returns true if the image has appeared otherwise false.

Remarks

Checks for the appearance of an image in the given screen area or the full screen. Equivalent to WaitForImage(String, Int32, Int32, Int32, Int32, Int32, Int32, UInt32) but returning true/false instead of raising a timeout exception.