VNCXLib Interface Definition

VNCXLib Interface Definition

General Information

Library: VNCXLib (VNCX 1.0 Type Library)

File: VNCX.dll

GUID: {49633AB0-0296-4F1A-897F-19017A9AE174}

Version: 1.0

Enumerations

This section lists enumerations exposed by VNCXLib.

Public Enum VNCXActionsEnum

vncxActionNone=0

vncxActionAllowVNCX=1

vncxActionAllowWin=2

vncxActionAllowVNCXAndWin=3

End Enum

Public Enum VNCXBellActionsEnum

vncxBellActionNone=0

vncxBellActionMessageBeep=65535

vncxBellActionDefault=65535

End Enum

Public Enum VNCXButtonsEnum

vncxButtonNone=0

vncxButtonLeft=1

vncxButtonMiddle=2

vncxButtonRight=4

vncxButtonCurrent=61440

End Enum

Public Enum VNCXCodecsEnum

vncxCodecRaw=0

vncxCodecCopyRect=1

vncxCodecRRE=2

vncxCodecCoRRE=4

vncxCodecHextile=5

End Enum

Public Enum VNCXDataTypesEnum

vncxDataUnknown=0

vncxDataText=1

vncxDataFromClipboard=255

End Enum

Public Enum VNCXDirectionsEnum

vncxDirectionUp=0

vncxDirectionDown=1

End Enum

Public Enum VNCXEdgesEnum

vncxEdgeNone=0

vncxEdgeLeft=1

vncxEdgeRight=2

vncxEdgeTop=4

vncxEdgeBottom=8

vncxEdgeCentre=16

vncxEdgeTopLeft=5

vncxEdgeTopRight=6

vncxEdgeBottomRight=10

vncxEdgeBottomLeft=9

vncxEdgeLeftCentre=17

vncxEdgeRightCentre=18

vncxEdgeTopCentre=20

vncxEdgeBottomCentre=24

End Enum

Public Enum VNCXErrorsEnum

vncxErrorNone=0

vncxErrorSocketMin=1

vncxErrorSocket=1

vncxErrorSocketInit=2

vncxErrorSocketCreate=3

vncxErrorSocketNoAddress=4

vncxErrorSocketConnect=5

vncxErrorSocketAfterConnect=240

vncxErrorSocketRead=241

vncxErrorSocketWrite=242

vncxErrorSocketClosed=15

vncxErrorSocketMax=255

vncxErrorConnectionMin=256

vncxErrorConnecting=256

vncxErrorConnectionMax=511

vncxErrorHandshakeMin=512

vncxErrorHandshake=512

vncxErrorHandshakeAuth=513

vncxErrorHandshakeMax=767

vncxErrorProtocolMin=1280

vncxErrorProtocolSync=1298

vncxErrorProtocolMax=4095

vncxErrorValidity=4096

End Enum

Public Enum VNCXModifiersEnum

vncxModifierNone=0

vncxModifierShift=1

vncxModifierControl=2

vncxModifierMenu=4

vncxModifierCurrent=65536

End Enum

Public Enum VNCXMousePointersEnum

vncxMousePointerDefault=0

vncxMousePointerArrow=1

vncxMousePointerCross=2

vncxMousePointerIBeam=3

vncxMousePointerIcon=4

vncxMousePointerSize=5

vncxMousePointerNESW=6

vncxMousePointerNS=7

vncxMousePointerNWSE=8

vncxMousePointerWE=9

vncxMousePointerUpArrow=10

vncxMousePointerHourGlass=11

vncxMousePointerNoDrop=12

vncxMousePointerArrowGlass=13

vncxMousePointerArrowQuestion=14

vncxMousePointerSizeAll=15

vncxMousePointerNone=200

vncxMousePointerSmallCircle=201

vncxMousePointerSmallSquare=202

vncxMousePointerCustom=99

End Enum

Public Enum VNCXScrollbarsEnum

vncxScrollbarNone=0

vncxScrollbarHorizontal=1

vncxScrollbarVertical=2

vncxScrollbarBoth=3

End Enum

Public Enum VNCXStatesEnum

vncxStateNotConnected=0

vncxStateHandshaking=2

vncxStateConnected=983040

vncxStateDispatching=983056

End Enum

Public Enum VNCXStretchModesEnum

vncxStretchModeNormal=0

vncxStretchModeHalftone=4

End Enum

Public Enum VNCXWarningsEnum

vncxWarningNone=0

vncxWarningConnectionMin=256

vncxWarningConnectionMax=511

vncxWarningHandshakeMin=512

vncxWarningHandshake=512

vncxWarningHandshakeAuth=513

vncxWarningHandshakeAuthCancelled=767

vncxWarningHandshakeMax=767

vncxWarningOtherMin=20480

vncxWarningClipboard=20480

vncxWarningOtherStart=24576

End Enum

Interfaces

This section lists the Classes exposed by VNCXLib. For each class, the methods and events are listed.

_IVNCViewerEvents {C3562542-79D3-4903-949F-D23E97F8DE4F}

Methods

Function Connected(ByVal ServerName As String) As ???

method Connected

Function Disconnected() As ???

method Disconnected

Function Password() As ???

method Password

Function ServerBell(ByVal Action As VNCXBellActionsEnum) As ???

method ServerBell

Function LocalClipboard(ByVal DataType As VNCXDataTypesEnum, ByVal Data As Variant, ByVal Action As VNCXActionsEnum) As ???

method LocalClipboard

Function ServerClipboard(ByVal DataType As VNCXDataTypesEnum, ByVal Data As Variant, ByVal Action As VNCXActionsEnum) As ???

method ServerClipboard

Function BeforeKeyDown(ByVal Modifiers As VNCXModifiersEnum, ByVal KeyCode As Long, ByVal Action As VNCXActionsEnum) As ???

method BeforeKeyDown

Function BeforeKeyUp(ByVal Modifiers As VNCXModifiersEnum, ByVal KeyCode As Long, ByVal Action As VNCXActionsEnum) As ???

method BeforeKeyUp

Function BeforeMouseDown(ByVal Buttons As VNCXButtonsEnum, ByVal Modifiers As VNCXModifiersEnum, ByVal X As Long, ByVal Y As Long, ByVal Action As VNCXActionsEnum) As ???

method BeforeMouseDown

Function BeforeMouseUp(ByVal Buttons As VNCXButtonsEnum, ByVal Modifiers As VNCXModifiersEnum, ByVal X As Long, ByVal Y As Long, ByVal Action As VNCXActionsEnum) As ???

method BeforeMouseUp

Function BeforeMouseMove(ByVal Buttons As VNCXButtonsEnum, ByVal Modifiers As VNCXModifiersEnum, ByVal X As Long, ByVal Y As Long, ByVal Action As VNCXActionsEnum) As ???

method BeforeMouseMove

Function BeforeMouseWheel(ByVal Buttons As VNCXButtonsEnum, ByVal Rotation As Long, ByVal Modifiers As VNCXModifiersEnum, ByVal X As Long, ByVal Y As Long, ByVal Action As VNCXActionsEnum) As ???

method BeforeMouseWheel

Function ScreenEdgeDetected(ByVal Edge As VNCXEdgesEnum) As ???

method ScreenEdgeDetected

Function FrameEdgeDetected(ByVal Edge As VNCXEdgesEnum) As ???

method FrameEdgeDetected

Function ViewEdgeDetected(ByVal Edge As VNCXEdgesEnum) As ???

method ViewEdgeDetected

Function FrameUpdated(ByVal X As Long, ByVal Y As Long, ByVal W As Long, ByVal H As Long) As ???

method FrameUpdated

Function CommandNotify(ByVal v1 As Variant, ByVal v2 As Variant, ByVal v3 As Variant, ByVal v4 As Variant) As ???

method CommandNotify

Function Error(ByVal Number As VNCXErrorsEnum, ByVal Message As String, ByVal v1 As Variant) As ???

method Error

Function Warning(ByVal Number As VNCXWarningsEnum, ByVal Message As String, ByVal v1 As Variant) As ???

method Warning

Function DataTransfer(ByVal TotalRead As Long, ByVal TotalWritten As Long) As ???

method DataTransfer

Function MouseTrap(ByVal Trapped As Boolean) As ???

method MouseTrap

Events

None

IVNCPoint {7EA27E4A-21E3-4CC5-917C-BF2BDAF8A33A}

Methods

Property Get X() As Long

property X

Property Let X(RHS As Long)

property X

Property Get Y() As Long

property Y

Property Let Y(RHS As Long)

property Y

Events

None

IVNCRectangle {9FF4686E-E007-4522-AA25-FCA8357B3BD9}

Methods

Property Get Left() As Long

property Left

Property Let Left(RHS As Long)

property Left

Property Get Right() As Long

property Right

Property Let Right(RHS As Long)

property Right

Property Get Top() As Long

property Top

Property Let Top(RHS As Long)

property Top

Property Get Bottom() As Long

property Bottom

Property Let Bottom(RHS As Long)

property Bottom

Property Get Width() As Long

property Width

Property Let Width(RHS As Long)

property Width

Property Get Height() As Long

property Height

Property Let Height(RHS As Long)

property Height

Events

None

IVNCViewer {F38C77DF-7615-4FF1-833F-5240FBCA0B6F}

Methods

Property Let BackColor(RHS As ULong)

Property Get BackColor() As ULong

Property Let ForeColor(RHS As ULong)

Property Get ForeColor() As ULong

Property Let Enabled(RHS As Boolean)

Property Get Enabled() As Boolean

Property Get Window() As Long

Property Set MouseIcon() As Picture

Property Let MouseIcon(RHS As Picture)

Property Get MouseIcon() As Picture

Property Get Picture() As Picture

Property Let MousePointer(RHS As VNCXMousePointersEnum)

Property Get MousePointer() As VNCXMousePointersEnum

Property Get Server() As String

property Server

Property Let Server(RHS As String)

property Server

Property Get Password() As String

property Password

Property Let Password(RHS As String)

property Password

Property Get Port() As Long

property Port

Property Let Port(RHS As Long)

property Port

Property Get Display() As Long

property Display

Property Let Display(RHS As Long)

property Display

Property Get Shared() As Boolean

property Shared

Property Let Shared(RHS As Boolean)

property Shared

Property Get ServerAddress() As String

property ServerAddress

Property Let ServerAddress(RHS As String)

property ServerAddress

Property Get ServerName() As String

property ServerName

Property Get State() As VNCXStatesEnum

property State

Property Get FrameWidth() As Long

property FrameWidth

Property Get FrameHeight() As Long

property FrameHeight

Property Get RelayKeys() As Boolean

property RelayKeys

Property Let RelayKeys(RHS As Boolean)

property RelayKeys

Property Get RelayMouse() As Boolean

property RelayMouse

Property Let RelayMouse(RHS As Boolean)

property RelayMouse

Property Get RelayLocalClipboard() As Boolean

property RelayLocalClipboard

Property Let RelayLocalClipboard(RHS As Boolean)

property RelayLocalClipboard

Property Get RelayServerClipboard() As Boolean

property RelayServerClipboard

Property Let RelayServerClipboard(RHS As Boolean)

property RelayServerClipboard

Property Get ScreenEdgeDelay() As Long

property ScreenEdgeDelay

Property Let ScreenEdgeDelay(RHS As Long)

property ScreenEdgeDelay

Property Get EnableBell() As Boolean

property EnableBell

Property Let EnableBell(RHS As Boolean)

property EnableBell

Property Get Codecs(ByVal Index As Long) As VNCXCodecsEnum

property Codecs

Property Let Codecs(ByVal Index As Long, RHS As VNCXCodecsEnum)

property Codecs

Property Get MousePosX() As Long

property MousePosX

Property Get MousePosY() As Long

property MousePosY

Property Get MousePosFrameX() As Long

property MousePosFrameX

Property Get MousePosFrameY() As Long

property MousePosFrameY

Property Get RequestFrames() As Boolean

property RequestFrames

Property Let RequestFrames(RHS As Boolean)

property RequestFrames

Property Get ScreenHeight() As Long

property ScreenHeight

Property Get ScreenWidth() As Long

property ScreenWidth

Property Get ScreenBitsPerPixel() As Long

property ScreenBitsPerPixel

Property Get FrameUpdateDelay() As Long

property FrameUpdateDelay

Property Let FrameUpdateDelay(RHS As Long)

property FrameUpdateDelay

Property Get PrimaryCodec() As VNCXCodecsEnum

property PrimaryCodec

Property Let PrimaryCodec(RHS As VNCXCodecsEnum)

property PrimaryCodec

Property Get Scrollbars() As VNCXScrollbarsEnum

property Scrollbars

Property Let Scrollbars(RHS As VNCXScrollbarsEnum)

property Scrollbars

Property Get Stretch() As Boolean

property Stretch

Property Let Stretch(RHS As Boolean)

property Stretch

Property Get ProgressiveDrawing() As Boolean

property ProgressiveDrawing

Property Let ProgressiveDrawing(RHS As Boolean)

property ProgressiveDrawing

Property Get AutoScroll() As Boolean

property AutoScroll

Property Let AutoScroll(RHS As Boolean)

property AutoScroll

Property Get AutoScrollDelay() As Long

property AutoScrollDelay

Property Let AutoScrollDelay(RHS As Long)

property AutoScrollDelay

Property Get AutoScrollBand() As Long

property AutoScrollBand

Property Let AutoScrollBand(RHS As Long)

property AutoScrollBand

Property Get BitsPerPixel() As Integer

property BitsPerPixel

Property Let BitsPerPixel(RHS As Integer)

property BitsPerPixel

Property Get ServerVersion() As String

property ServerVersion

Function Connect(Optional ByVal Server As Variant, Optional ByVal Port As Variant, Optional ByVal Password As Variant, Optional ByVal Flags As Variant) As Variant

method Connect

Function Start() As Variant

method Start

Function Stop() As Variant

method Stop

Function Disconnect() As Variant

method Disconnect

Function SendKeyDown(ByVal KeyCode As Long, Optional ByVal Modifier As VNCXModifiersEnum=0) As Variant

method SendKeyDown

Function SendKeyUp(ByVal KeyCode As Long, Optional ByVal Modifier As VNCXModifiersEnum=0) As Variant

method SendKeyUp

Function SendKeyPress(ByVal KeyCode As Long, Optional ByVal Repeat As Long=1, Optional ByVal Modifiers As VNCXModifiersEnum=65536) As Variant

method SendKeyPress

Function SendMouseDown(Optional ByVal Buttons As VNCXButtonsEnum=61440, Optional ByVal Modifiers As VNCXModifiersEnum=65536, Optional ByVal X As Variant, Optional ByVal Y As Variant) As Variant

method SendMouseDown

Function SendMouseUp(Optional ByVal Buttons As VNCXButtonsEnum=61440, Optional ByVal Modifiers As VNCXModifiersEnum=65536, Optional ByVal X As Variant, Optional ByVal Y As Variant) As Variant

method SendMouseUp

Function SendMouseMove(Optional ByVal Buttons As VNCXButtonsEnum=61440, Optional ByVal Modifiers As VNCXModifiersEnum=65536, Optional ByVal X As Variant, Optional ByVal Y As Variant) As Variant

method SendMouseMove

Function SendMouseClick(Optional ByVal Buttons As VNCXButtonsEnum=61440, Optional ByVal Repeat As Long=1, Optional ByVal Modifiers As VNCXModifiersEnum=65536, Optional ByVal X As Variant, Optional ByVal Y As Variant) As Variant

method SendMouseClick

Function SendClipboard(ByVal DataType As VNCXDataTypesEnum, Optional ByVal Data As Variant) As Variant

method SendClipboard

Function Refresh(Optional ByVal X As Long=0, Optional ByVal Y As Long=0, Optional ByVal W As Long=0, Optional ByVal H As Long=0) As Variant

method Refresh

Function ChangeDisplaySettings(Optional ByVal W As Long=0, Optional ByVal H As Long=0, Optional ByVal BitsPerPixel As Long=0, Optional ByVal Frequency As Long=0, Optional ByVal Flags As Long=0, Optional ByVal Display As Long=-1) As Variant

method ChangeDisplaySettings

Function Command(Optional ByVal v1 As Variant, Optional ByVal v2 As Variant, Optional ByVal v3 As Variant, Optional ByVal v4 As Variant) As Variant

method Command

Function TranslateButtons(ByVal Buttons As Long) As VNCXButtonsEnum

method TranslateButtons

Sub AboutBox

Function IsConnected() As Boolean

method IsConnected

Property Get StretchMode() As VNCXStretchModesEnum

property StretchMode

Property Let StretchMode(RHS As VNCXStretchModesEnum)

property StretchMode

Function StretchX(Optional ByVal Numerator As Long=0, Optional ByVal Denominator As Long=0) As IVNCPoint

method StretchX

Function StretchY(Optional ByVal Numerator As Long=0, Optional ByVal Denominator As Long=0) As IVNCPoint

method StretchY

Property Get StretchedWidth() As Long

property StretchedWidth

Property Get StretchedHeight() As Long

property StretchedHeight

Property Get ViewWidth() As Long

property ViewWidth

Property Get ViewHeight() As Long

property ViewHeight

Property Get ViewLeft() As Long

property ViewLeft

Property Get ViewTop() As Long

property ViewTop

Property Get ViewRight() As Long

property ViewRight

Property Get ViewBottom() As Long

property ViewBottom

Property Get ViewRectangle() As IVNCRectangle

property ViewRectangle

Property Get Draw() As Boolean

property Draw

Property Let Draw(RHS As Boolean)

property Draw

Property Get FireFrameUpdates() As Boolean

property FireFrameUpdates

Property Let FireFrameUpdates(RHS As Boolean)

property FireFrameUpdates

Property Get FireDataTransfers() As Boolean

property FireDataTransfers

Property Let FireDataTransfers(RHS As Boolean)

property FireDataTransfers

Property Get MouseTrap() As Boolean

property MouseTrap

Property Let MouseTrap(RHS As Boolean)

property MouseTrap

Property Get MouseTrapModifers() As VNCXModifiersEnum

property MouseTrapModifers

Property Let MouseTrapModifers(RHS As VNCXModifiersEnum)

property MouseTrapModifers

Property Get Alignment() As VNCXEdgesEnum

property Alignment

Property Let Alignment(RHS As VNCXEdgesEnum)

property Alignment

Function RefreshRectangle(ByVal Rectangle As IVNCRectangle) As Variant

method RefreshRectangle

Property Get hDC() As UInt

property hDC

Sub Scroll(ByVal H As Integer, ByVal V As Integer, ByVal retVal As Variant)

method Scroll

Property Get ScrollPosH() As Long

property ScrollPosH

Property Get ScrollPosV() As Long

property ScrollPosV

Function Encrypt(ByVal Data As String, ByVal Key As String) As String

method Encrypt

Function Decrypt(ByVal Data As String, ByVal Key As String) As String

method Decrypt

Property Get ViewEdgeDelay() As Long

property ViewEdgeDelay

Property Let ViewEdgeDelay(RHS As Long)

property ViewEdgeDelay

Property Get FrameEdgeDelay() As Long

property FrameEdgeDelay

Property Let FrameEdgeDelay(RHS As Long)

property FrameEdgeDelay

Property Get ServerClipboard() As Variant

property ServerClipboard

Property Let ServerClipboard(RHS As Variant)

property ServerClipboard

Property Get LocalClipboard() As Variant

property LocalClipboard

Property Let LocalClipboard(RHS As Variant)

property LocalClipboard

Events

None

VNCPoint {606B9267-8DEC-405A-A272-6CEDE419894F}

MethodsNone

Events

None

VNCRectangle {6184F60B-59F3-4562-BAED-308E757A3DA1}

MethodsNone

Events

None

VNCViewer {EFAB8D1F-794A-4C47-B834-53653E05A441}

MethodsNone

Events

None