Share this page

# pcoip_sync_on_bitmap

Example | Teradici PCoIP Protocol Functions

Waits until a bitmap appears.

int pcoip_sync_on_bitmap( long x, long y, long width, long height, char *hash, char* waitFor, char* AddOffsetToInput);

x | The horizontal distance, in pixels, of the bitmap's top left edge from the left border of the client window.
y | The vertical distance, in pixels, of the bitmap's top left edge from the upper border of the client window
width | The width, in pixels, of the bitmap.
height | The height, in pixels, of the bitmap.
hash | An encoded string representing the bitmap.
WaitFor | The event to occur on one of the specified areas and images. This argument is optional. The function’s behavior with the WaitFor events are as follows: Appear: The function waits for the specified area to match one of the specified images. Change: The function waits for the specified area to match one of the specified images, and then not to match it. That is, the match is found and then the area changes so that it no longer matches. NotAppear: The function returns LR_FAIL if the image appears before the function times out. If the time-out is reached and the image has not appeared, the function returns LR_PASS. The default is Appear.
AddOffsetToInput | The offset is the change in position, from where the image was found during the test run, to where it is found when recorded. This argument indicates whether to add the offset to subsequent input, for example, mouse-click coordinates. Possible values: "Yes" or "No"

## General Information

pcoip_sync_on_bitmap is a synchronization function that waits 60 seconds for a specified bitmap to appear before continuing.

This function can be added only where snapshots were taken. For more information, see Teradici PCoIP protocol in the Virtual User Generator Help Center.

Use the pcoip_sync_on_bitmap_ex to customize the timeout period.

## Return Values

E_OK |
E_ALREADY_CONNECTED | Do not call this function after the connection is established.
E_NOT_CONNECTED | Action cannot be performed. There is no connection to the remote server.
E_OUT_OF_TIME | Function timed out.
E_ILLEGAL_PARAMETER | Illegal parameter found.
E_INTERNAL | Internal error found.

## Parameterization

Standard parameterization is not available for this function.

## Example

This an example of the use of pcoip_sync_on_bitmap.

    pcoip_sync_on_bitmap(137, 211, 51, 17,
    	"18d962dcbf373e948e83489a19419512","WaitFor=Appear");

Tips to improve your search results... VuGen Function Reference Version 26.1-26.3 Function Reference 26.1-26.3 All View Local Help Center View Online Help Center Version: