Share this page

# 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] );

Example | Teradici PCoIP Protocol Functions

## Arguments

Name | Comments
--- | ---
x | In pixels relative to the remote window.
y | In pixels relative to the remote window.
Mouse_Button | LEFT_BUTTON, RIGHT_BUTTON, or MIDDLE_BUTTON
Modify_Key | MODIF_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 Information

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_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 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();

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