Boolean type

Note that vnc_true and vnc_false are guaranteed to be defined as 1 and 0 respectively in all future versions of the SDK. There is no need to explicitly reference these constants, unless you prefer that coding style.

vnc_true¶

Evaluates to 1.

vnc_false¶

Evaluates to 0.

typedef int vnc_bool_t¶

A boolean, valid values are vnc_true and vnc_false.

Status type

Note that vnc_success and vnc_failure are guaranteed to be defined as 1 and 0 respectively in all future versions of the SDK. There is no need to explicitly reference these constants, unless you prefer that coding style; either of these is acceptable:

if (!vnc_Logger_createFileLogger("logfile.txt"))
    handleError();

or:

if (vnc_Logger_createFileLogger("logfile.txt") != vnc_success)
    handleError();

vnc_success¶

Evaluates to 1.

vnc_failure¶

Evaluates to 0.

typedef int vnc_status_t¶

Function return status, valid values are vnc_success and vnc_failure.

Common primitive types

typedef signed char vnc_int8_t¶

typedef signed short vnc_int16_t¶

typedef signed int vnc_int32_t¶

typedef signed long long vnc_int64_t¶

typedef unsigned char vnc_uint8_t¶

typedef unsigned short vnc_uint16_t¶

typedef unsigned int vnc_uint31_t¶

typedef unsigned int vnc_uint32_t¶

typedef unsigned long long vnc_uint64_t¶

Object types

typedef struct vnc_Connection vnc_Connection¶

Opaque type for a connection, identifying a Viewer connected to a Server.

typedef struct vnc_ConnectionHandler vnc_ConnectionHandler¶

Opaque type for a connection handler, enabling a Viewer or Server to perform a connection operation.

typedef struct vnc_AnnotationManager vnc_AnnotationManager¶

Enables a Viewer or Server to annotate a Server device screen.

See Annotation.h.

typedef struct vnc_MessagingManager vnc_MessagingManager¶

Enables a Viewer or Server to send custom messages.

See Messaging.h.

typedef struct vnc_DisplayManager vnc_DisplayManager¶

Manages the list of displays made available by a Server.

See Displays.h.

typedef struct vnc_DataBuffer vnc_DataBuffer¶

Buffer containing data managed by the SDK.

typedef struct vnc_Server vnc_Server¶

A VNC-compatible Server enabling a computer to be remotely controlled.

See Server.h.

typedef struct vnc_Viewer vnc_Viewer¶

A VNC-compatible Viewer showing the screen of and controlling a remote computer.

See Viewer.h.

typedef struct vnc_PixelFormat vnc_PixelFormat¶

Description of how pixels are stored in a Viewer framebuffer.

Typedefs

typedef void(* VncAssertionHandler) (const char *message)