pcoip_mouse_click

Emulates a mouse click.

C Language

int pcoip_mouse_click( int x, int y, int Mouse_Button, int Modify_Key, [const char* filename] );

ExampleTeradici PCoIP Protocol Functions

Arguments

NameComments
xIn pixels relative to the remote window.
yIn pixels relative to the remote window.
Mouse_ButtonLEFT_BUTTON, RIGHT_BUTTON, or MIDDLE_BUTTON
Modify_KeyMODIF_ALT, MODIF_CONTROL and MODIF_SHIFT. The modifiers can be combined. For example, MODIF_CONTROL|MODIF_SHIFT
filename

The snapshot file. Do not edit this argument if the function was recorded.

General

pcoip_mouse_click emulates a mouse click

Note: To set a delay after a mouse-click event, select and configure the PCoIP runtime setting, Delay after keystroke and mouse click.

Return Values

E_OK 
E_ALREADY_CONNECTEDDo not call this function after the connection is established.
E_NOT_CONNECTEDAction cannot be performed. There is no connection to the remote server.
E_OUT_OF_TIMEFunction timed out.
E_ILLEGAL_PARAMETERIllegal parameter found.
E_INTERNALInternal error found.

Parameterization

Standard parameterization is not available for this function.

Example

This example shows a simple PCoIP test.

	pcoip_set_broker_address("mybroker.com", "443");
			
	pcoip_set_auth("hogan", "my_domain", lr_unmask("123abc345def678ghi"));

	pcoip_connect("my_server", "123.123.123.123", "my_server", "4172");

	pcoip_set_display(800, 582);

	lr_think_time(5); pcoip_mouse_click(626, 13, LEFT_BUTTON, 0, "snapshot2");

	pcoip_disconnect();