SaveScreenshotToFile Method (Int32, Int32, Int32, Int32, String)

CitrixVirtualUserScript SaveScreenshotToFile Method (Int32, Int32, Int32, Int32, String)

C# API

Save a screen portion to file

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

Syntax

public string SaveScreenshotToFile(
	int xPos,
	int yPos,
	int width,
	int height,
	string filePath
)

public string SaveScreenshotToFile(
	int xPos,
	int yPos,
	int width,
	int height,
	string filePath
)

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.

filePath: Type: System String
An absolute path or a path relative to the runs folder which to save the bitmap. The file name must be included.

Return Value

The absolute path (including file name) where the screen portion should be saved.

Remarks

Saves a screen portion of specified size and location (as a bitmap) to either the absolute path specified or under the runs folder hierarchy using the naming convention shown (workspace hierarchy for localhost injector, fcCache for remote)

Copy to Clipboard Print

\runs\<run>\<series>.<index>\<injector>\<platform>.<engine>.<index>\<vu_group<\VU<index<.images\iteration.<iteration_index>\<screenshot>.bmp

\runs\<run>\<series>.<index>\<injector>\<platform>.<engine>.<index>\<vu_group<\VU<index<.images\iteration.<iteration_index>\<screenshot>.bmp

Copy to Clipboard Print

\runs\<run>\<series>.<index>\<injector>\<platform>.<engine>.<index>\<vu_group>\<my_folder>\VU<vu_index>.images\iteration.<iteration_index>\<screenshot>.bmp

\runs\<run>\<series>.<index>\<injector>\<platform>.<engine>.<index>\<vu_group>\<my_folder>\VU<vu_index>.images\iteration.<iteration_index>\<screenshot>.bmp

In addition if the relative path specified contains a folder defined by the user (i.e. <my_folder>\<screenshot>.bmp ) then the path and filename will be split by the VU index and iteration folders;