Functions

int vnc_DisplayManager_getDisplayCount(vnc_DisplayManager *displayManager)¶

Returns the number of displays.

vnc_status_t vnc_DisplayManager_setCallback(vnc_DisplayManager *displayManager, const vnc_DisplayManager_Callback *callback, void *userData)¶

Registers a callback notifying when displays are added or removed, or the resolution of an existing display changes.

Return

vnc_success or vnc_failure, in which case call vnc_getLastError() to get the error code.

Since

1.5

Parameters

• displayManager -

  The display manager.

• callback -

  The callback.

• userData -

  Optional custom data to pass to the callback.

vnc_status_t vnc_DisplayManager_selectDisplay(vnc_DisplayManager *displayManager, int index)¶

Chooses a particular display to remote to connected Viewer app users.

This replaces any previous selection, so either a single display is remoted or all are.

If the selected display is removed, connected Viewers will cease to receive framebuffer updates until the display is replaced or a new display is selected.

Return

vnc_success or vnc_failure, in which case call vnc_getLastError() to get the error code.

Since

1.5

Parameters

• displayManager -

  The display manager.

• index -

  The 0-based index of the display to remote, or -1 to remote all displays.

Return Value

• InvalidArgument -

  index is invalid.

• NotEnabled -

  Selecting the display is not permitted at present.

int vnc_DisplayManager_getDisplayIndex(vnc_DisplayManager *displayManager)¶

Gets the index of the currently selected display.

Return

The 0-based index of the display selected to remote, or -1 for all displays.

Since

1.8.0

Parameters

• displayManager -

  The display manager.

const char *vnc_DisplayManager_getId(vnc_DisplayManager *displayManager, int index)¶

Gets the ID of the display (typically a short string).

Return

A unique identifier.

Since

1.5

Parameters

• displayManager -

  The display manager.

• index -

  The 0-based index of the required display.

const char *vnc_DisplayManager_getName(vnc_DisplayManager *displayManager, int index)¶

Gets the name of the display (typically a human-readable string).

Return

A friendly name.

Since

1.5

Parameters

• displayManager -

  The display manager.

• index -

  The 0-based index of the required display.

vnc_bool_t vnc_DisplayManager_isPrimary(vnc_DisplayManager *displayManager, int index)¶

Returns whether this is the primary (or main) display.

On Windows, the main display acts as the active desktop, showing the taskbar and sign in and lock screens. Most applications open on the main display by default.

Return

vnc_true if this is the primary display, otherwise vnc_false.

Since

1.5

Parameters

• displayManager -

  The display manager.

• index -

  The 0-based index of the required display.

int vnc_DisplayManager_getResolutionX(vnc_DisplayManager *displayManager, int index)¶

Gets the horizontal resolution of the display in pixels.

Return

A width in pixels.

Since

1.5

Parameters

• displayManager -

  The display manager.

• index -

  The 0-based index of the required display.

int vnc_DisplayManager_getResolutionY(vnc_DisplayManager *displayManager, int index)¶

Gets the vertical resolution of the display in pixels.

Return

A height in pixels.

Since

1.5

Parameters

• displayManager -

  The display manager.

• index -

  The 0-based index of the required display.

int vnc_DisplayManager_getOriginX(vnc_DisplayManager *displayManager, int index)¶

Gets the horizontal origin of the display in pixels.

Return

The X coordinate of the top left corner of the display relative to the operating system’s virtual map of all the displays.

Since

1.5

Parameters

• displayManager -

  The display manager.

• index -

  The 0-based index of the required display.

int vnc_DisplayManager_getOriginY(vnc_DisplayManager *displayManager, int index)¶

Gets the vertical origin of the display in pixels.

Return

The Y coordinate of the top left corner of the display relative to the operating system’s virtual map of all the displays.

Since

1.5

Parameters

• displayManager -

  The display manager.

• index -

  The 0-based index of the required display.

vnc_bool_t vnc_DisplayManager_isSelectDisplayAllowed(vnc_DisplayManager *displayManager)¶

Returns whether the selectDisplay() call is permitted.

Return

vnc_true if selectDisplay is permitted, otherwise vnc_false.

Parameters

• displayManager -

  The display manager.

vnc_status_t vnc_DisplayManager_enable(vnc_DisplayManager *displayManager, vnc_bool_t enable)¶

Specifies whether screen sharing is enabled.

If this is the server then this sets whether it shares its screen with viewers. If this is the viewer then this sets whether it requires to see the server’s screen.

Return

vnc_success or vnc_failure, in which case call vnc_getLastError() to get the error code.

Since

1.8.0

Parameters

• displayManager -

  The display manager.

• enable -

  true if screen sharing enabled, false otherwise

vnc_bool_t vnc_DisplayManager_isEnabled(vnc_DisplayManager *displayManager)¶

Returns whether the server is sharing its screens, whether it is being called from a server or a viewer.

Return

vnc_true if screens are shared, otherwise vnc_false.

Since

1.8.0

Parameters

• displayManager -

  The display manager.