import"WGuest.idl";

Inheritance diagram for IWGuestCore:

Public Types
Constants
enum	CommProfile_t { CommProfile_TCP = 0x00000000, CommProfile_HTTP = 0x00000001, CommProfile_UDP = 0x00000002, CommProfile_myCloud = 0x00000003 }

enum	SessionType_t { SessionType_RemoteControl = 0x00000001, SessionType_Nfm = 0x00000002, SessionType_Rm = 0x00000003, SessionType_Chat = 0x00000004, SessionType_Void = 0x00000005 }

enum	MouseMode_t { MouseMode_Local = 0x00000000, MouseMode_Remote = 0x00000001, MouseMode_None = 0x00000002 }

enum	KeyboardMode_t { KeyboardMode_Local = 0x00000000, KeyboardMode_Remote = 0x00000001, KeyboardMode_None = 0x00000002 }

enum	StretchMode_t { Stretch_FitWindowToHost = 0x00000000, Stretch_FitHostToWindow = 0x00000001, Stretch_FitNone = 0x00000002 }

enum	GraphicsMode_t { GraphicsMode_Hook = 0x00000000, GraphicsMode_AccBitmap = 0x00000001, GraphicsMode_NormalBitmap = 0x00000002 }

enum	MaxColors_t { MaxColors_Actual = 0x00000000, MaxColors_256 = 0x00000001, MaxColors_16 = 0x00000002, MaxColors_2 = 0x00000003 }

enum	CompressionLevel_t { CompressionLevel_Auto = 0x00000000, CompressionLevel_None = 0x00000001, CompressionLevel_Low = 0x00000002, CompressionLevel_High = 0x00000003 }

enum	EncryptionLevel_t { EncryptionLevel_Compatible = 0x00000000, EncryptionLevel_None = 0x00000001, EncryptionLevel_DataIntegrity = 0x00000002, EncryptionLevel_Keyboard = 0x00000003, EncryptionLevel_DataIntegrityAndKeyboard = 0x00000004, EncryptionLevel_High = 0x00000005, EncryptionLevel_VeryHigh = 0x00000006, EncryptionLevel_Unknown = 0x000000FF }

enum	DesktopOptimization_t { DesktopOptimization_DisableEverything = 0x00000001, DesktopOptimization_DisableWallpaper = 0x00000002, DesktopOptimization_DisableScreenSaver = 0x00000004, DesktopOptimization_DisableAnimation = 0x00000008, DesktopOptimization_DisableFullWindowDrag = 0x00000010, DesktopOptimization_DisableMenuAnimation = 0x00000020, DesktopOptimization_DisableComboboxAnimation = 0x00000040, DesktopOptimization_DisableSmoothScrolling = 0x00000080, DesktopOptimization_DisableGradientCaption = 0x00000100, DesktopOptimization_DisableActiveDesktop = 0x00000200, DesktopOptimization_DisableMenuFade = 0x00000400, DesktopOptimization_DisableSelectionFade = 0x00000800, DesktopOptimization_DisableTooltipFade = 0x00001000, DesktopOptimization_DisableMenuDropShadowEffect = 0x00002000, DesktopOptimization_DisableFontSmoothing = 0x00004000, DesktopOptimization_DisableVistaAero = 0x00008000, DesktopOptimization_DisableOverlappedContent = 0x00010000, DesktopOptimization_DisableVistaAnimations = 0x00020000 }

enum	Language_t { Language_English = 1033, Language_Arabic = 1025, Language_Brazilian = 1046, Language_Chinese = 2052, Language_Czech = 1029, Language_German = 1031, Language_Danish = 1030, Language_Spanish = 1034, Language_Finnish = 1035, Language_French = 1036, Language_ChineseHK = 3076, Language_Israeli = 1037, Language_Italian = 1040, Language_Japanese = 1041, Language_Korean = 1042, Language_Dutch = 1043, Language_Norwegian = 1044, Language_Portuguese = 2070, Language_Russian = 1049, Language_Swedish = 1053 }

enum	LicenseType_t { LicenseType_None = 0x00000000, LicenseType_Standalone = 0x00000001 }

enum	{ NGA_UNKNOWN = -1 }

enum	MultiguestEvent_t { MultiguestEvent_InputAssigned = 0x00000001, MultiguestEvent_InputRevoked = 0x00000002, MultiguestEvent_InputDenied = 0x00000004, MultiguestEvent_ConnectionsChanged = 0x00000008, MultiguestEvent_MultiSessionsSuspended = 0x00000010, MultiguestEvent_MultiSessionsAllowed = 0x00000020, MultiguestEvent_MultiSessionsDeninied = 0x00000040, MultiguestEvent_ClipboardAvailable = 0x00000080, MultiguestEvent_FeaturesChanged = 0x00000100 }

enum	SessionStatus_t { SessionStatus_Idle = 0, SessionStatus_Connecting = 1, SessionStatus_Opening = 2, SessionStatus_Authenticating = 3, SessionStatus_Starting = 4, SessionStatus_Running = 5, SessionStatus_Closing = 6 }

enum	InfoWindowReason_t { InfoWindowReason_Connecting = 1, InfoWindowReason_Connected = 2, InfoWindowReason_CancelLogin = 3, InfoWindowReason_Disconnecting = 4, InfoWindowReason_Closing = 5 }

enum	LoginReason_t { MessageAccessServerGuestNotDefinedOnServer = 12, MessageAccessServerGuestNotAllowedToRcHost = 13, MessageAccessServerHostNotDefinedOnServer = 14, MessageAccessServerGuestLocked = 15, MessagePasswordTooLong = 16, MessageGuestidTooLong = 17, MessageUsernameTooLong = 18, MessageServiceAliasNameTooLong = 19, MessageNoAccessToClosedUserGroup = 20, MessageInvalidPassword = 23, MessageTooManyInvalidPasswords = 24, MessageMustChangePassword = 25, MessageOutOfMemory = 26, MessageLdapServiceError = 32, MessageLdapGroupNotFound = 33, MessageLdapUserNotFound = 34, MessageLdapServerLoginFailed = 35, MessageLdapLoginNameNotResolved = 36, MessageLdapNoObject = 37, MessageLdapSslRequired = 38, MessageLdapUnsupportedAuthenticationMethod = 39, MessageLdapAuthenticationError = 40, MessageLdapInsufficientRights = 41, MessageLdapServerNotFound = 42, MessageLdapServerConnectError = 43, MessageLdapUnsupportedFeature = 44, MessageLdapError = 45, MessageNssNoServerRunning = 46, MessageNssNonConformingPassword = 47, MessageNssError = 48, MessageRsaValidationFailed = 49, MessageRsaPincodeChanged = 50, MessageRsaNextPasscodeRequired = 51 }

enum	ErrorCode_t { NGA_OK = 0x0000000, NGA_ERROR = 0x0000001, NGA_ERR_BASE = 0x0001000, NGA_ERR_INVALID_PARAMETER, NGA_ERR_INVALID_STATUS, NGA_ERR_NOT_OPENED, NGA_ERR_PERMISSION_DENIED, NGA_ERR_NO_SESSION, NGA_ERR_NOT_SAFE, NGA_ERR_NOT_AVAILABLE, NGA_ERR_LICENSE = 0x0c, NGA_ERR_MYCLOUD_PARAMETERS = 0x11, NGA_ERR_MYCLOUD_CREDENTIAL = 0x12, NGA_ERR_MYCLOUD_TIMEOUT = 0x13, NGA_ERR_MYCLOUD_UNAVAILABLE = 0x14, NGA_ERR_MYCLOUD_PROXYAUTHENTICATIONREQUIRED = 0x15, NGA_ERR_MYCLOUD_PROXYUSE = 0x16, NGA_ERR_MYCLOUD_USERNOTFOUND = 0x17, NGA_ERR_MYCLOUD_HOSTNOTFOUND = 0x18, NGA_ERR_MYCLOUD_CANCELLEDBYUSER = 0x19 }

enum	ClipboardMode_t { ClipboardOff, ClipboardManual, ClipboardAuto }

enum	AccessPrivilege_t { AccessPrivilege_RemoteControl = 0x00000001, AccessPrivilege_Chat = 0x00000004, AccessPrivilege_RemoteManagement = 0x00008000, AccessPrivilege_FileTransfer = 0x00000002, AccessPrivilege_GetInventory = 0x00000800, AccessPrivilege_LockKeybAndMs = 0x00000080, AccessPrivilege_BlankScreen = 0x00000100, AccessPrivilege_SuspendMultiSessions = 0x00010000, AccessPrivilege_Clipboard = 0x00100000, AccessPrivilege_MarkerMode = 0x00200000, AccessPrivilege_VoidSession = 0x00080000, AccessPrivilege_RunProgram = 0x00000020, AccessPrivilege_ExecuteCommand = 0x00000040, AccessPrivilege_SendHostMessage = 0x00000400, AccessPrivilege_SendHostMessageRTF = 0x00400000 }

enum	HostType_t { HostType_DOS = 0, HostType_OS2 = 1, HostType_Win = 2, HostType_WinCE = 4, HostType_Linux = 6, HostType_EPOC = 7, HostType_Sun = 8, HostType_Mac = 9, HostType_Symbian = 10, HostType_IOS = 11, HostType_Android = 12, HostType_Blackberry = 13 }

Public Member Functions
HRESULT	Open ([out, retval] LONG *result)

HRESULT	Close ([out, retval] LONG *result)

HRESULT	BeginSession ([in] LONG SessionType, [out, retval] LONG *result)

HRESULT	EndSession ([in] LONG SessionType, [out, retval] LONG *result)

HRESULT	SendLoginPassword ([in] BSTR Pwd, [out, retval] LONG *result)

HRESULT	SendLoginWiseMo ([in] BSTR GuestId, [in] BSTR Pwd, [in] BSTR NewPassword, [out, retval] LONG *result)

HRESULT	SendLoginWindows ([in] BSTR UserId, [in] BSTR Domain, [in] BSTR Pwd, [out, retval] LONG *result)

HRESULT	SendLoginLdap ([in] BSTR Server, [in] BSTR User, [in] BSTR Pwd, [out, retval] LONG *result)

HRESULT	SendLoginRsa ([in] BSTR UserId, [in] BSTR Pco, [in] BSTR Pwd, [in] BSTR NewPassword, [out, retval] LONG *result)

HRESULT	SendLoginRsaPin ([in] BSTR Pin, [out, retval] LONG *result)

HRESULT	CancelLogin ([out, retval] LONG *result)

HRESULT	SendRefreshScreen ([out, retval] LONG *result)

HRESULT	SendCtrlAltDel ([out, retval] LONG *result)

HRESULT	SendCtrlEsc ([out, retval] LONG *result)

HRESULT	SendAltTab ([in] VARIANT_BOOL bSendAltUp, [out, retval] LONG *result)

HRESULT	SendAltShiftTab ([in] VARIANT_BOOL bSendAltUp, [out, retval] LONG *result)

HRESULT	SendAltUp ([out, retval] LONG *result)

HRESULT	SendGoSolo ([out, retval] LONG *result)

HRESULT	RequestKeyboardAndMouseControl ([out, retval] LONG *result)

HRESULT	SendGuardHost ([in] VARIANT_BOOL Guard, [out, retval] LONG *result)

HRESULT	SendChatMessage ([in] BSTR Message, [out, retval] LONG *result)

HRESULT	SetCustomString ([in] LONG StringId, [in] BSTR Str, [out, retval] LONG *result)

HRESULT	GetKeyboardShortcut ([in] LONG ShortcutType, [out, retval] IWGuestShortcut **result)

HRESULT	ClipboardSend ([out, retval] LONG *result)

HRESULT	ClipboardReceive ([out, retval] LONG *result)

HRESULT	ClipboardCancel ([out, retval] LONG *result)

HRESULT	SendBlankScreen ([in] VARIANT_BOOL val, [out, retval] LONG *result)

HRESULT	SendLockKeyboardAndMouse ([in] VARIANT_BOOL val, [out, retval] LONG *result)

HRESULT	SendCurrentUserLoginWindows ([out, retval] LONG *result)

HRESULT	SendInstallMonitorDriver ([out, retval] LONG *result)

HRESULT	SendMarkerMode ([in] VARIANT_BOOL val, [out, retval] LONG *result)

HRESULT	ScriptSendMessage ([in] BSTR Message, [in] VARIANT_BOOL IsRTF, [out, retval] LONG *result)

HRESULT	ScriptRunProgram ([in] BSTR Path, [in] BSTR Parameters, [in] LONG Mode, [out, retval] LONG *result)

HRESULT	ScriptExecuteCommand ([in] LONG Command, [out, retval] LONG *result)

HRESULT	InvokeRmOperation ([in] LONG snapinId, [in] LONG opId, [in] BSTR param, [out, retval] LONG *requestId)

HRESULT	GetInventory ([in] LONG flags, [out, retval] LONG *retcode)

HRESULT	SendUnicode ([in] LONG keycode, [in] LONG flags, [in] VARIANT_BOOL special, [out, retval] LONG *result)=0

Properties
IWGuestSkinSupport	Skins `[get]`

LONG	BackgroundColor `[get, set]`

BSTR	Version `[get]`

VARIANT	Events `[get]`

LONG	ClipboardMode `[get, set]`

LONG	ClipboardMaxSize `[get, set]`

LONG	HostType `[get]`

LONG	ControlWidth `[get]`

LONG	ControlHeight `[get]`

IWGuestNfmOptions	NfmOptions `[get]`

Current connection properties
LONG	CurrentCommProfile `[get]`

BSTR	CurrentHostAddress `[get]`

LONG	CurrentPortNumber `[get]`

BSTR	CurrentGatewayAddress `[get]`

BSTR	CurrentHttpProxyAddress `[get]`

LONG	CurrentGraphicsMode `[get]`

LONG	CurrentGraphicsMaxColors `[get, set]`

LONG	CurrentCompressionLevel `[get, set]`

LONG	CurrentEncryptionPreferred `[get]`

VARIANT_BOOL	IsOpen `[get]`

VARIANT_BOOL	IsConnected `[get]`

LONG	SessionStatus `[get]`

LONG	HostScreenWidth `[get]`

LONG	HostScreenHeight `[get]`

VARIANT_BOOL	IsMultiguestAdminOnHost `[get]`

LONG	NumGuestsOnHost `[get]`

IWGuestFont	ChatFont `[get]`

Properties for next connection
New values for these properties are not used until next connection.
LONG	CommProfile `[get, set]`

BSTR	HostAddress `[get, set]`

LONG	PortNumber `[get, set]`

BSTR	GatewayAddress `[get, set]`

BSTR	HttpProxyAddress `[get, set]`

LONG	CompressionLevel `[get, set]`

LONG	EncryptionPreferred `[get, set]`

LONG	GraphicsMode `[get, set]`

LONG	GraphicsMaxColors `[get, set]`

VARIANT_BOOL	LockHostKeyboardOnConnect `[get, set]`

VARIANT_BOOL	BlankHostScreenOnConnect `[get, set]`

VARIANT_BOOL	GuardHostOnConnect `[get, set]`

Remote desktop display properties
LONG	DesktopOptimizeMask `[get, set]`

LONG	StretchToFitWindow `[get, set]`

VARIANT_BOOL	AutoScroll `[get, set]`

LONG	ScrollPositionX `[get, set]`

LONG	ScrollPositionY `[get, set]`

IWGuestRcArea	RcArea `[get]`

Keyboard and mouse properties
LONG	MouseMode `[get, set]`

VARIANT_BOOL	ShowRemoteMouseMovements `[get, set]`

LONG	KeyboardMode `[get, set]`

VARIANT_BOOL	UnicodeKeyboardMode `[get, set]`

VARIANT_BOOL	RemoteCursor `[get, set]`

VARIANT_BOOL	AutoTakeControl `[get, set]`

Localization properties
LONG	Language `[get, set]`

License properties
LONG	LicenseType `[get, set]`

BSTR	LicenseKey `[get, set]`

VARIANT_BOOL	LicenseAutoSave `[get, set]`

myCloud properties
BSTR	myCloudAddress `[get, set]`

BSTR	myCloudCredentialsAccount `[get, set]`

BSTR	myCloudCredentialsPassword `[get, set]`

BSTR	myCloudCredentialsDomain `[get, set]`

BSTR	myCloudProvidedTicket `[get, set]`

BSTR	myCloudNameQualifier `[get, set]`

BSTR	myCloudAuthToken `[get, set]`

Properties for next connection (2)
VARIANT_BOOL	UseOneTimePassword `[get, set]`

LONG	CacheSize `[get, set]`

Current connection properties (2)
LONG	CurrentCacheSize `[get]`

LONG	CurrentEncryption `[get]`

LONG	AccessPrivileges `[get]`

Properties for next connection (3)
LONG	GraphicsCompression `[get, set]`

Current connection properties (3)
LONG	CurrentGraphicsCompression `[get]`

Detailed Description

C++

Member Enumeration Documentation

anonymous enum

Enumerator
NGA_UNKNOWN	-1 - Unknown property value

enum AccessPrivilege_t

The access privilege flags.

Enumerator
AccessPrivilege_RemoteControl	0x00000001 - Remote Control
AccessPrivilege_Chat	0x00000004 Chat
AccessPrivilege_RemoteManagement	0x00008000 Remote Management
AccessPrivilege_FileTransfer	0x00000002 File Transfer
AccessPrivilege_GetInventory	0x00000800 Get inventory
AccessPrivilege_LockKeybAndMs	0x00000080 Lock keyboard and mouse
AccessPrivilege_BlankScreen	0x00000100 Blank screen
AccessPrivilege_SuspendMultiSessions	0x00010000 Send command to Host to suspend more sessions
AccessPrivilege_Clipboard	0x00100000 Clipboard
AccessPrivilege_MarkerMode	0x00200000 Marker mode
AccessPrivilege_VoidSession	0x00080000 Void session
AccessPrivilege_RunProgram	0x00000020 Run program
AccessPrivilege_ExecuteCommand	0x00000040 Run program
AccessPrivilege_SendHostMessage	0x00000400 Send host message
AccessPrivilege_SendHostMessageRTF	0x00400000 Send host message in RTF

enum ClipboardMode_t

Clipboard modes

Enumerator
ClipboardOff	0 - No clipboard support
ClipboardManual	1 - Clipboard, no auto transfer
ClipboardAuto	2 - Clipboard, auto transfer if size < ClipboardMaxSize

enum CommProfile_t

Communication profile.

Enumerator
CommProfile_TCP	0 - "LAN (TCP)" profile.
CommProfile_HTTP	1 - "HTTP" profile.
CommProfile_UDP	2 - "UDP" profile.
CommProfile_myCloud	3 - "myCloud" profile.

enum CompressionLevel_t

The connection compression level.

Enumerator
CompressionLevel_Auto	0 - Compression level selected automatically.
CompressionLevel_None	1 - None.
CompressionLevel_Low	2 - Low.
CompressionLevel_High	3 - High.

enum DesktopOptimization_t

The remote desktop optimization flags.

Enumerator
DesktopOptimization_DisableEverything	0x00000001 - Disable everything.
DesktopOptimization_DisableWallpaper	0x00000002 - Disable wallpaper.
DesktopOptimization_DisableScreenSaver	0x00000004 - Disable screen saver.
DesktopOptimization_DisableAnimation	0x00000008 - Disable animation.
DesktopOptimization_DisableFullWindowDrag	0x00000010 - Disable full window drag.
DesktopOptimization_DisableMenuAnimation	0x00000020 - Disable menu animation / not supported by current API.
DesktopOptimization_DisableComboboxAnimation	0x00000040 - Disable combobox animation / not supported by current API.
DesktopOptimization_DisableSmoothScrolling	0x00000080 - Disable smooth scrolling / not supported by current API.
DesktopOptimization_DisableGradientCaption	0x00000100 - Disable gradient caption / not supported by current API.
DesktopOptimization_DisableActiveDesktop	0x00000200 - Disable active desktop.
DesktopOptimization_DisableMenuFade	0x00000400 - Disable menu fade / not supported by current API.
DesktopOptimization_DisableSelectionFade	0x00000800 - Disable selection fade / not supported by current API.
DesktopOptimization_DisableTooltipFade	0x00001000 - Disable tooltip fade / not supported by current API.
DesktopOptimization_DisableMenuDropShadowEffect	0x00002000 - Disable drop shadow effect on menus / not supported by current API.
DesktopOptimization_DisableFontSmoothing	0x00004000 - Disable font smoothing feature / not supported by current API.
DesktopOptimization_DisableVistaAero	0x00008000 - Disable Windows Vista Aero / not supported by current API.
DesktopOptimization_DisableOverlappedContent	0x00010000 - Disable overlapped content / not supported by current API.
DesktopOptimization_DisableVistaAnimations	0x00020000 - Disable all animations on Vista / not supported by current API.

enum EncryptionLevel_t

The connection encryption level.

Enumerator
EncryptionLevel_Compatible	0 - Compatible.
EncryptionLevel_None	1 - None.
EncryptionLevel_DataIntegrity	2 - DataIntegrity.
EncryptionLevel_Keyboard	3 - Keyboard.
EncryptionLevel_DataIntegrityAndKeyboard	4 - DataIntegrityAndKeyboard.
EncryptionLevel_High	5 - High.
EncryptionLevel_VeryHigh	6 - Very High.
EncryptionLevel_Unknown	255 - Unknown/changing

enum ErrorCode_t

Error codes

Enumerator
NGA_OK	0x0 - Ok
NGA_ERROR	0x1 - General error (NSDK Dw::Error code)
NGA_ERR_BASE	0x1000 - base for NGA errors
NGA_ERR_INVALID_PARAMETER	0x1001 - Invalid parameter
NGA_ERR_INVALID_STATUS	0x1002 - A session or instance cannot be opened or closed because of the current status
NGA_ERR_NOT_OPENED	0x1003 - The NGA instance is not opened
NGA_ERR_PERMISSION_DENIED	0x1004 - User does not have the right to complete the operation
NGA_ERR_NO_SESSION	0x1005 - There is no session of appropriate type to complete the operation
NGA_ERR_NOT_SAFE	0x1006 - Operation considered unsafe in the current context and won't be completed
NGA_ERR_NOT_AVAILABLE	0x1007 - Operation is either not supported on the host or disallowed by the user rights
NGA_ERR_LICENSE	0x0c - Operation is not permitted with the current license key
NGA_ERR_MYCLOUD_PARAMETERS	0x11 - myCloud general error
NGA_ERR_MYCLOUD_CREDENTIAL	0x12 - myCloud invalid credentials
NGA_ERR_MYCLOUD_TIMEOUT	0x13 - myCloud operation timed out
NGA_ERR_MYCLOUD_UNAVAILABLE	0x14 - myCloud service not available
NGA_ERR_MYCLOUD_PROXYAUTHENTICATIONREQUIRED	0x15 - myCloud: proxy requires authentication
NGA_ERR_MYCLOUD_PROXYUSE	0x16 - myCloud: proxy is required
NGA_ERR_MYCLOUD_USERNOTFOUND	0x17 - myCloud user not found
NGA_ERR_MYCLOUD_HOSTNOTFOUND	0x18 - myCloud host not found
NGA_ERR_MYCLOUD_CANCELLEDBYUSER	0x19 - myCloud operation cancelled by user

enum GraphicsMode_t

Graphics mode.

Enumerator
GraphicsMode_Hook	0 - Command (hook) mode.
GraphicsMode_AccBitmap	1 - Accelerated bitmap.
GraphicsMode_NormalBitmap	2 - Normal bitmap.

enum HostType_t

Host type values.

Enumerator
HostType_DOS	0 - DOS
HostType_OS2	1 - OS2
HostType_Win	2 - Win
HostType_WinCE	4 - Windows CE/Mobile
HostType_Linux	6 - Linux
HostType_EPOC	7 - EPOC
HostType_Sun	8 - Sun
HostType_Mac	9 - Mac
HostType_Symbian	10 - Symbian
HostType_IOS	11 - IOS
HostType_Android	12 - Android
HostType_Blackberry	13 - Blackberry

enum InfoWindowReason_t

Info window reason

Enumerator
InfoWindowReason_Connecting	1 - Starting a new connection
InfoWindowReason_Connected	2 - When info window was closed for gateway authentication and now it should be reopened to display the progress of connecting to a host behind the gateway.
InfoWindowReason_CancelLogin	3 - Cancel login button is pressed
InfoWindowReason_Disconnecting	4 - Disconnecting from host
InfoWindowReason_Closing	5 - Closing WGuest instance

enum KeyboardMode_t

Keyboard mode.

Enumerator
KeyboardMode_Local	0 - Don't send special keystrokes.
KeyboardMode_Remote	1 - Send all keystrokes to host.
KeyboardMode_None	2 - No keyboard control.

enum Language_t

User interface languages.

Enumerator
Language_English	1033 - English.
Language_Arabic	1025 - Arabic.
Language_Brazilian	1046 - Brazilian.
Language_Chinese	2052 - Chinese.
Language_Czech	1029 - Czech.
Language_German	1031 - German.
Language_Danish	1030 - Danish.
Language_Spanish	1034 - Spanish.
Language_Finnish	1035 - Finnish.
Language_French	1036 - French.
Language_ChineseHK	3076 - Chinese.
Language_Israeli	1037 - Israeli.
Language_Italian	1040 - Italian.
Language_Japanese	1041 - Japanese.
Language_Korean	1042 - Korean.
Language_Dutch	1043 - Dutch.
Language_Norwegian	1044 - Norwegian.
Language_Portuguese	2070 - Portuguese.
Language_Russian	1049 - Russian.
Language_Swedish	1053 - Swedish.

enum LicenseType_t

License type.

Enumerator
LicenseType_None	0 - No license.
LicenseType_Standalone	1 - Standalone license.

enum LoginReason_t

Login window reason

Enumerator
MessageAccessServerGuestNotDefinedOnServer	12 - Security Server: Unknown Guest
MessageAccessServerGuestNotAllowedToRcHost	13 - Security Server: Not authorized
MessageAccessServerHostNotDefinedOnServer	14 - Security Server: Unknown Host
MessageAccessServerGuestLocked	15 - Security Server: Guest ID was disabled
MessagePasswordTooLong	16 - Password too long
MessageGuestidTooLong	17 - Guest ID too long
MessageUsernameTooLong	18 - Username too long
MessageServiceAliasNameTooLong	19 - Directory Service alias name too long
MessageNoAccessToClosedUserGroup	20 - No access. Closed user group
MessageInvalidPassword	23 - Invalid credentials, please retry
MessageTooManyInvalidPasswords	24 - Too many invalid credentials entered
MessageMustChangePassword	25 - Please enter a new password
MessageOutOfMemory	26 - Out of memory
MessageLdapServiceError	32 - Directory Service open error
MessageLdapGroupNotFound	33 - Directory Service group not found
MessageLdapUserNotFound	34 - Directory Service user not found
MessageLdapServerLoginFailed	35 - Login to Directory Service failed
MessageLdapLoginNameNotResolved	36 - No Distinguished Name could be found for this login name
MessageLdapNoObject	37 - Directory Service object not found
MessageLdapSslRequired	38 - Secure Sockets Layer (SSL) is required by this Directory Service
MessageLdapUnsupportedAuthenticationMethod	39 - Directory Services: Unsupported authentication method
MessageLdapAuthenticationError	40 - The Directory Service failed to authenticate
MessageLdapInsufficientRights	41 - Directory Services: Insufficient rights
MessageLdapServerNotFound	42 - Directory Service not found
MessageLdapServerConnectError	43 - Could not connect to Directory Service
MessageLdapUnsupportedFeature	44 - Directory Services: Unsupported feature
MessageLdapError	45 - Directory Services error
MessageNssNoServerRunning	46 - Security Server service not available
MessageNssNonConformingPassword	47 - New password rejected. It was used before, is too short, or needs to include a digit
MessageNssError	48 - Security Server connect error
MessageRsaValidationFailed	49 - RSA SecurID server failed to validate credentials
MessageRsaPincodeChanged	50 - RSA SecurID pincode changed ok
MessageRsaNextPasscodeRequired	51 - RSA SecurID next PASSCODE required

enum MaxColors_t

The limits of colors bitmap graphic modes.

Enumerator
MaxColors_Actual	0 - Actual Colors.
MaxColors_256	1 - 256 colors.
MaxColors_16	2 - 16 colors.
MaxColors_2	3 - 2 colors.

enum MouseMode_t

Mouse mode.

Enumerator
MouseMode_Local	0 - Only send click and drag to Host.
MouseMode_Remote	1 - Send all mouse events to Host.
MouseMode_None	2 - Do not send mouse events to Host.

enum MultiguestEvent_t

Multi guest event flags.

Enumerator
MultiguestEvent_InputAssigned	0x00000001 - This Guest is assigned input control
MultiguestEvent_InputRevoked	0x00000002 - This Guest is revoked input control
MultiguestEvent_InputDenied	0x00000004 - This Guest requested input control but it was denied.
MultiguestEvent_ConnectionsChanged	0x00000008 - Number of session changed
MultiguestEvent_MultiSessionsSuspended	0x00000010 - More sessions suspended
MultiguestEvent_MultiSessionsAllowed	0x00000020 - More sessions allowed
MultiguestEvent_MultiSessionsDeninied	0x00000040 - Change of sessions denied
MultiguestEvent_ClipboardAvailable	0x00000080 - Host clipboard changed
MultiguestEvent_FeaturesChanged	0x00000100 - Host features changed

enum SessionStatus_t

Session status.

Enumerator
SessionStatus_Idle	0 - Idle
SessionStatus_Connecting	1 - Connection started
SessionStatus_Opening	2 - Connected, opening a session
SessionStatus_Authenticating	3 - Session can be opened, authenticating
SessionStatus_Starting	4 - Authenticated, initializing RC/Chat/RM/FT
SessionStatus_Running	5 - Session initialized
SessionStatus_Closing	6 - Closing

enum SessionType_t

Session types.

Enumerator
SessionType_RemoteControl	1 - Remote Control Session.
SessionType_Nfm	2 - FT Session.
SessionType_Rm	3 - RM Session.
SessionType_Chat	4 - Chat Session.
SessionType_Void	5 - Void session, for inventory and commands.

enum StretchMode_t

Remote desktop stretch mode.

Enumerator
Stretch_FitWindowToHost	0 - Do not stretch, show in actual size.
Stretch_FitHostToWindow	1 - Stretch Host window to fit control.
Stretch_FitNone	2 - Do not stretch.

Member Function Documentation

HRESULT BeginSession	(	[in] LONG	SessionType,
		[out, retval] LONG *	result
	)

Initiates a new session.

This function can be used to start a chat, RM or FT session or to resume an RC session when the connection is active or to start a new connection with chat, RM, FT or RC session.

When there is no active connection, the new connection will be established with a host specified by HostAddress, PortNumber, GatewayAddress, HttpProxyAddress, CommProfile properties.

If there is already an active connection, this function either opens a new chat/RM/FT session or resumes an RC session.

The function is asynchronous. The following events can be fired during and after calling this method:

WGuestLib::_IWGuestControlCP::OnConnectPre(), WGuestLib::_IWGuestControlCP::OnConnectPost() and WGuestLib::_IWGuestControlCP::OnSessionStarted() are fired only when a new connection is established.

When there was an active connection, only WGuestLib::_IWGuestControlCP::OnBeginSessionPre() and WGuestLib::_IWGuestControlCP::OnBeginSessionPost() events are fired.

WGuestLib::_IWGuestControlCP::OnConnectPre() is always followed by WGuestLib::_IWGuestControlCP::OnConnectPost().

There is always WGuestLib::_IWGuestControlCP::OnBeginSessionPost() for each WGuestXLib::IWGuestCtrlEvents::OnBeginSessionPre().

None of these events may be produced if the BeginSession() returns an error.

It is safe to call this function only in some particular states:

When there is no connection (session status: idle). For example, it is safe to call BeginSession() in response to the last connection WGuestLib::_IWGuestControlCP::OnEndSessionPost() event. A new connection will be created.
When there is a running Rc, chat, FT or RM session (session status: running) to open session of another type. For example, it is safe to call BeginSession(chat) in response to WGuestLib::_IWGuestControlCP::OnSessionStarted(rc) or WGuestLib::_IWGuestControlCP::EndSessionPost(chat, true). A new session will be opened using the current connection.

In other cases such as when a connection is closing, or when a connection is starting, or when Host requested authentication this function will return an error.

For example in the following code:

nga->Open();
nga->BeginSession(Rc);
nga->BeginSession(Chat);

the BeginSession(Chat) in most cases will return error because connection and Rc session is not established yet.

Parameters

SessionType - a session to open:
SessionType_RemoteControl - Remote control
SessionType_Chat - Text chat
SessionType_Rm - Remote Management
SessionType_Nfm - File Transfer.

Returns

0 - success (NGA_OK)
1 - failed to start session (NGA_ERROR)
NGA_ERR_INVALID_PARAMETER - either some of the connection properties or the parameter is invalid
NGA_ERR_INVALID_STATUS -
- session of this type is already opened
- no session can be started at this moment
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method
NGA_ERR_PERMISSION_DENIED - a second session cannot be opened because user has no permissions on Host to open a session of the given type.

This operation creates session (affecting other operations in regards to security restrictions).

HRESULT CancelLogin ( [out, retval] LONG * result )

Cancels the authentication on a Gateway or Host.

Can be used to cancel the authentication on a gateway or host. When canceling the authentication on Host, the WGuestLib::_IWGuestControlCP::OnLoginFailed() is fired.

This function should be called on in response to OnLogin events:

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method
NGA_ERR_INVALID_STATUS - the authentication cannot be canceled at this moment.

HRESULT ClipboardCancel ( [out, retval] LONG * result )

Cancels clipboard transmission if any.

Returns

0 - success (NGA_OK)
1 - general failure (NGA_ERROR)
NGA_ERR_NO_SESSION - there is no RC session.

HRESULT ClipboardReceive ( [out, retval] LONG * result )

Receives clipboard from host to guest.

Returns

0 - success (NGA_OK)
1 - general failure (NGA_ERROR)
NGA_ERR_INVALID_STATUS - clipboard already being sent or recieved
NGA_ERR_NO_SESSION - there is no RC session.

HRESULT ClipboardSend ( [out, retval] LONG * result )

Sends clipboard from guest to host.

Returns

0 - success (NGA_OK)
1 - general failure (NGA_ERROR)
NGA_ERR_INVALID_STATUS - clipboard already being sent or recieved
NGA_ERR_NO_SESSION - there is no RC session.

HRESULT Close ( [out, retval] LONG * result )

Close NGA control instance.

Ends all active sessions, disconnects from the host, close the NGA control instance and changes IsOpen property if closed successfully.

This method is synchronous.

The method fires the following events:

WGuestLib::_IWGuestControlCP::OnClosePre event is always followed by WGuestLib::_IWGuestControlCP::OnClosePost() event.

The events are not fired if the instance is already closed.

After having the Close() method called, the Open() method can be called once again.

This method is called automatically when WGuest window is being destroyed.

Returns

0 - closed successfully (NGA_OK)
1 - failed to close the instance. The instance is not closed and cannot be opened.
NGA_ERR_INVALID_STATUS - the instance is already closed

This operation is always safe.

HRESULT EndSession	(	[in] LONG	SessionType,
		[out, retval] LONG *	result
	)

Ends an active session of the given type.

If there is no more active session, this function disconnects the NGA instance from Host.

The function is asynchronous. The following events can be produced after calling this method:

WGuestLib::_IWGuestControlCP::OnDisconnectPre() and WGuestLib::_IWGuestControlCP::OnDisconnectPost() are fired only when the instance is disconnected from Host.

When there is still an active connection, only WGuestLib::_IWGuestControlCP::OnEndSessionPre() and WGuestLib::_IWGuestControlCP::OnEndSessionPost() events are fired.

WGuestLib::_IWGuestControlCP::OnDisconnectPre() is always followed by WGuestLib::_IWGuestControlCP::OnDisconnectPost().

There is always WGuestLib::_IWGuestControlCP::OnEndSessionPost() for each WGuestXLib::IWGuestCtrlEvents::OnEndSessionPre().

None of these events can be produced if the function returns an error.

It is safe to call this function only in some particular states:

There is an active connection and running session of the given type (session status: running). For example in response to the WGuestLib::_IWGuestControlCP::OnSessionStarted() event.
There is already an active connection but the session is not authenticated yet (session status: authenticating). For example in response to WGuestLib::_IWGuestControlCP::OnBeginSessionPost event.

In other states (e.g. connecting, closing) the function will return an error.

For example in the following code:

// nga is not connected yet
if (nga->BeginSession(Rc) == 0) // start new connection
   nga->EndSession(Rc)

the EndSession(Rc) will return an error because the Rc session wasn't opened yet.

Parameters

SessionType - a session to close:
SessionType_RemoteControl - Remote control
SessionType_Chat - Text chat
SessionType_Rm - Remote Management
SessionType_Nfm - File Transfer.

Returns

0 - success (NGA_OK)
1 - failed to close session (NGA_ERROR)
NGA_ERR_INVALID_PARAMETER - the parameter is invalid
NGA_ERR_INVALID_STATUS -
- there is no opened session of specified type
- session cannot be finished at this moment
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method.

This operation is always safe.

HRESULT GetInventory	(	[in] LONG	flags,
		[out, retval] LONG *	retcode
	)

Starts remote host inventory operation.

Parameters

flags logical OR of values: 1 - get JSON inventory data, path to inventory file otherwise.

Inventory data is reported by WGuestLib::_IWGuestControlCP::OnInventoryData event, inventory file path is reported by WGuestLib::_IWGuestControlCP::OnInventoryFile event.

Returns: 0 if successful, errcode otherwise.

HRESULT GetKeyboardShortcut	(	[in] LONG	ShortcutType,
		[out, retval] IWGuestShortcut **	result
	)

Keyboard shortcut interface.

This method can be used to set/get WGuest keyboard shortcuts, for example "Send Alt-Ctrl-Del to Host", "Send Ctrl-Esc to Host", etc.

Parameters

ShortcutType - the ID of the shortcut to return (one of the IWGuestShortcut::ShortcutType_t constants)

Returns: button assignments for the given shortcut. See IWGuestShortcut interface description for more details.

This operation requires session.

HRESULT InvokeRmOperation	(	[in] LONG	snapinId,
		[in] LONG	opId,
		[in] BSTR	param,
		[out, retval] LONG *	requestId
	)

Starts remote management operation.

Remote management functionality is divided on subsystems (Snap-ins).

Parameters

snapinId	Snap-in id, see Remote Management operations.
opId	Operation id, see Remote Management operations.
param	Operation params in JSON format, see Remote Management operations for params content.

Returns: requestId, operation result will be received with this id, see WGuestLib::_IWGuestControlCP::OnRmOperationResult.

HRESULT Open ( [out, retval] LONG * result )

Opens NGA control instance.

Opens NGA control instance and changes IsOpen property if opened successfully. Instance should be open to create sessions.

This method is synchronous.

The method fires the following events:

WGuestLib::_IWGuestControlCP::OnOpenPre event is always followed by WGuestLib::_IWGuestControlCP::OnOpenPost() event.

The events are not fired if the instance is already opened.

Returns

0 - opened successfully (NGA_OK)
1 - failed to open instance (NGA_ERROR)
NGA_ERR_INVALID_STATUS - the instance is already opened

This operation is always safe.

HRESULT RequestKeyboardAndMouseControl ( [out, retval] LONG * result )

Sends Request Keyboard And Mouse Control command to Host.

Returns

0 - success (NGA_OK)
1 - failed to send a command
NGA_ERR_NOT_OPENED - NGA instance is not opened
NGA_ERR_NO_SESSION - there is no session of the appropriate type
NGA_ERR_PERMISSION_DENIED - returned when the Guest is not an Administrator (Power User) and hence doesn't have the right for this command.

This operation requires session.

HRESULT ScriptExecuteCommand	(	[in] LONG	Command,
		[out, retval] LONG *	result
	)

Execute Command.

Parameters

Command

- the command to execute

0 - Log off current user
1 - Restart workstation
2 - Power off workstation
3 - Lock workstation

Returns

0 - success (NGA_OK)
1 - general failure (NGA_ERROR)
NGA_ERR_NO_SESSION - there is no active session
NGA_ERR_LICENSE - operation is not permitted with the current license key
NGA_ERR_NOT_AVAILABLE - operation is either not supported on the host or disallowed by the user rights
NGA_ERR_INVALID_STATUS - some script operation is already in progress
NGA_ERR_INVALID_PARAMETER - one of the parameters is invalid

This operation requires session.

HRESULT ScriptRunProgram	(	[in] BSTR	Path,
		[in] BSTR	Parameters,
		[in] LONG	Mode,
		[out, retval] LONG *	result
	)

Run Program.

Parameters

Path	- path to the program executable on the host machine, can contain environment variables like PROGRAMFILES% which will be expanded appropriately on the host
Parameters	- command line for the program
Mode	- how program should run 0 - normal 1 - maximized 2 - minimized 3 - hidden

Returns

0 - success (NGA_OK)
1 - general failure (NGA_ERROR)
NGA_ERR_NO_SESSION - there is no active session.
NGA_ERR_LICENSE - operation is not permitted with the current license key
NGA_ERR_NOT_AVAILABLE - operation is either not supported on the host or disallowed by the user rights
NGA_ERR_INVALID_STATUS - some script operation is already in progress
NGA_ERR_INVALID_PARAMETER - one of the parameters is invalid

This operation requires session.

HRESULT ScriptSendMessage	(	[in] BSTR	Message,
		[in] VARIANT_BOOL	IsRTF,
		[out, retval] LONG *	result
	)

Sends a message to Host in plaintext or RTF.

Parameters

Message	- the message
isrtf	- is message plaintext or RTF message is expected to consist of 7-bit ASCII characters only (in standard RTF non-ASCII symbols are all encoded)

Returns

0 - success (NGA_OK)
1 - general failure (NGA_ERROR)
NGA_ERR_NO_SESSION - there is no active session.
NGA_ERR_LICENSE - operation is not permitted with the current license key
NGA_ERR_NOT_AVAILABLE - operation is either not supported on the host or disallowed by the user rights
NGA_ERR_INVALID_STATUS - some script operation is already in progress

This operation requires session.

HRESULT SendAltShiftTab	(	[in] VARIANT_BOOL	bSendAltUp,
		[out, retval] LONG *	result
	)

Sends Alt-Shift-Tab keystroke to Host.

Function sends scancodes for Alt-Shift-Tab key down and key up. To prevent the function from sending Alt key up scancode the bSendAltUp parameter can be set to FALSE.

Parameters

UpDown - If TRUE, send down+up scancodes, otherwise only down.

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_NO_SESSION - there is no running Rc session
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method.

This operation requires session.

HRESULT SendAltTab	(	[in] VARIANT_BOOL	bSendAltUp,
		[out, retval] LONG *	result
	)

Sends Alt+Tab keystroke to Host.

Function sends scancodes for Alt-Tab key down and key up. To prevent the function from sending Alt key up scancode the bSendAltUp parameter can be set to FALSE.

Parameters

bSendAltUp - when false the function do not send Alt up scancode.

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_NO_SESSION - there is no running Rc session
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method.

This operation is always safe.

HRESULT SendAltUp ( [out, retval] LONG * result )

Sends Alt key up scan code to Host.

This function can be use to send a key up scan code for Alt button to Host when the Alt up scan code was not sent by SendAltTab() or SendAltShiftTab().

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_NO_SESSION - there is no running Rc session
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method.

This operation requires session.

HRESULT SendBlankScreen	(	[in] VARIANT_BOOL	val,
		[out, retval] LONG *	result
	)

Sends blank screen command to host.

The function is asynchronous. WGuestLib::_IWGuestControlCP::OnBlankScreenResult() event can be fired with the result.

Parameters

val	- If TRUE, host screen will be blanked, if FALSE then shown.

Returns

0 - success (NGA_OK)
1 - general failure (NGA_ERROR)
NGA_ERR_NO_SESSION - there is no RC session.

HRESULT SendChatMessage	(	[in] BSTR	Message,
		[out, retval] LONG *	result
	)

Sends chat message to Host.

Parameters

Message	- a chat message to send to host.
Font	- a font of chat message.

Returns

0 - success (NGA_OK)
1 - failed to send a command
NGA_ERR_NOT_OPENED - NGA instance is not opened
NGA_ERR_NO_SESSION - there is no chat session.

This operation requires session.

HRESULT SendCtrlAltDel ( [out, retval] LONG * result )

Sends Ctrl-Alt-Del keystroke to Host.

This function sends both key down and up scancodes.

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_NO_SESSION - there is no running Rc session
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method.

This operation requires session.

HRESULT SendCtrlEsc ( [out, retval] LONG * result )

Sends Ctrl-Esc keystroke to Host.

This function sends both down and up scancodes.

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_NO_SESSION - there is no running Rc session
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method.

This operation requires session.

HRESULT SendCurrentUserLoginWindows ( [out, retval] LONG * result )

Sends the current user Windows system credentials to Host.

This function shall only be called on WGuestLib::_IWGuestControlCP::OnLoginWindows() event.

The function is asynchronous.

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_INVALID_PARAMETER - a parameter is invalid
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method
NGA_ERR_INVALID_STATUS - the authentication cannot be sent at this moment.

This operation is always safe.

HRESULT SendGoSolo ( [out, retval] LONG * result )

Sends the Go Solo command to Host.

Returns

0 - success (NGA_OK)
1 - failed to send a command.
NGA_ERR_NOT_OPENED - NGA instance is not opened
NGA_ERR_NO_SESSION - there is no session of the appropriate type
NGA_ERR_PERMISSION_DENIED - returned when the Guest is not an Administrator (Power User) and hence doesn't have the right for this command.

This operation requires session.

HRESULT SendGuardHost	(	[in] VARIANT_BOOL	Guard,
		[out, retval] LONG *	result
	)

Sends Guard command to Host.

Parameters

Guard true - to prevent further guest connections false - to enable further guest connections.

Returns

0 - success (NGA_OK)
1 - failed to send the command (NGA_ERROR)
NGA_ERR_NOT_OPENED - NGA instance is not opened
NGA_ERR_NO_SESSION - there is no session of the appropriate type
NGA_ERR_PERMISSION_DENIED - returned when the Guest is not an Administrator (Power User) and hence doesn't have the right for this command.

This operation requires session.

HRESULT SendInstallMonitorDriver ( [out, retval] LONG * result )

Sends install WiseMo monitor driver command to host.

The function is asynchronous. WGuestLib::_IWGuestControlCP::OnInstallMonitorDriverResult() event can be fired with the result.

Returns

0 - success (NGA_OK)
1 - general failure (NGA_ERROR)
NGA_ERR_NO_SESSION - there is no RC session.

This operation requires session.

HRESULT SendLockKeyboardAndMouse	(	[in] VARIANT_BOOL	val,
		[out, retval] LONG *	result
	)

Sends lock keyboard and mouse command to host.

Parameters

val	- If TRUE, host keyboard and mouse will be locked, if FALSE then unlocked.

Returns

0 - success (NGA_OK)
1 - general failure (NGA_ERROR)
NGA_ERR_NO_SESSION - there is no RC session.

HRESULT SendLoginLdap	(	[in] BSTR	Server,
		[in] BSTR	User,
		[in] BSTR	Pwd,
		[out, retval] LONG *	result
	)

Sends LDAP credentials to Host.

This shall only be called on WGuestLib::_IWGuestControlCP::OnLoginLdap() event.

The function is asynchronous.

Parameters

Server	- The server ID must not be NULL and not longer than 512 characters.
User	- The user ID must not be NULL and not longer than 512 characters.
Pwd	- The password must not be NULL and not longer than 512 characters.

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_INVALID_PARAMETER - a parameter is invalid
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method
NGA_ERR_INVALID_STATUS - the authentication cannot be sent at this moment.

This operation is always safe.

HRESULT SendLoginPassword	(	[in] BSTR	Pwd,
		[out, retval] LONG *	result
	)

Sends the password credentials to Host.

This function shall only be called on WGuestLib::_IWGuestControlCP::OnLoginPassword() event.

The function is asynchronous.

Parameters

Pwd	- The password must not be NULL and not longer than 16 characters.

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_INVALID_PARAMETER - the parameter is invalid
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method
NGA_ERR_INVALID_STATUS - the authentication cannot be sent at this moment.

This operation is always safe.

HRESULT SendLoginRsa	(	[in] BSTR	UserId,
		[in] BSTR	Pco,
		[in] BSTR	Pwd,
		[in] BSTR	NewPassword,
		[out, retval] LONG *	result
	)

Sends RSA credentials to Host.

This function shall only be called on WGuestLib::_IWGuestControlCP::OnLoginRsa() event.

The function is asynchronous.

Parameters

UserId	- The user ID must not be NULL and not longer than 32 characters.
Pco	- The RSA SecurID passcode must not be NULL and not longer than 16 characters.
Pwd	- The optional password. May be NULL. Must not be longer than 16 chars.

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_INVALID_PARAMETER - a parameter is invalid
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method
NGA_ERR_INVALID_STATUS - the authentication cannot be sent at this moment.

This operation is always safe.

HRESULT SendLoginRsaPin	(	[in] BSTR	Pin,
		[out, retval] LONG *	result
	)

Sends RSA SecurID pin code to Host.

Sends an RSA SecurID pin code. This shall only be called on WGuestLib::_IWGuestControlCP::OnEnterRsaPincode() event.

The function is asynchronous.

Parameters

Pin	- The pin code.

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_INVALID_PARAMETER - a parameter is invalid
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method
NGA_ERR_INVALID_STATUS - the authentication cannot be sent at this moment.

This operation is always safe.

HRESULT SendLoginWindows	(	[in] BSTR	UserId,
		[in] BSTR	Domain,
		[in] BSTR	Pwd,
		[out, retval] LONG *	result
	)

Sends Windows system credentials to Host.

This function shall only be called on WGuestLib::_IWGuestControlCP::OnLoginWindows() event.

The function is asynchronous.

Parameters

UserId	- The user ID must not be NULL and not longer than 512 characters.
Domain	- The domain must not be NULL and not longer than 512 characters.
Pwd	- The password must not be NULL and not longer than 512 characters.

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_INVALID_PARAMETER - a parameter is invalid
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method
NGA_ERR_INVALID_STATUS - the authentication cannot be sent at this moment.

This operation is always safe.

HRESULT SendLoginWiseMo	(	[in] BSTR	GuestId,
		[in] BSTR	Pwd,
		[in] BSTR	NewPassword,
		[out, retval] LONG *	result
	)

Sends the WiseMo credentials to Host.

This function shall only be called on WGuestLib::_IWGuestControlCP::OnLoginWiseMo() event.

The function is asynchronous.

Parameters

GuestId	- The user ID must not be NULL and not longer than 32 characters.
Pwd	- The password must not be NULL and not longer than 16 characters.

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_INVALID_PARAMETER - a parameter is invalid
NGA_ERR_NOT_OPENED - the NGA instance is not opened with Open() method
NGA_ERR_INVALID_STATUS - the authentication cannot be sent at this moment.

This operation is always safe.

HRESULT SendMarkerMode	(	[in] VARIANT_BOOL	val,
		[out, retval] LONG *	result
	)

Sends marker mode command to host.

Parameters

val	- If TRUE, marker mode will be turned on, if FALSE then marker mode will be turned off.

Returns

0 - success (NGA_OK)
1 - general failure (NGA_ERROR)
NGA_ERR_NO_SESSION - there is no RC session.

This operation requires session.

HRESULT SendRefreshScreen ( [out, retval] LONG * result )

Forces the Host to resend its screen.

This function forcefully refreshes RC screen.

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_INVALID_STATUS - there is no running Rc session.

This operation requires session.

HRESULT SendUnicode	(	[in] LONG	keycode,
		[in] LONG	flags,
		[in] VARIANT_BOOL	special,
		[out, retval] LONG *	result
	)

pure virtual

Send keyboard event.

Parameters

keycode	if special false, an unicode symbol: 'W', '1' etc if special true, virtual key code VK_SPACE, VK_F1, etc
flags	additional data: up/down, scancode, skin button, repeat count, etc please refer to the description for skin buttons and keyboard keys

Returns

0 - success (NGA_OK)
1 - general failure (NGA_ERROR)
NGA_ERR_NOT_SAFE - operation is not allowed
NGA_ERR_NO_SESSION - there is no active RC session
NGA_ERR_INVALID_PARAMETER - one of the parameters is invalid

This operation requires session.

HRESULT SetCustomString	(	[in] LONG	StringId,
		[in] BSTR	Str,
		[out, retval] LONG *	result
	)

Overrides the given GUI string.

Parameters

StringId	- The Id of GUI string to override.
Str	- New GUI string. Passing a NULL string will remove the overridden string.

Returns

0 - success (NGA_OK)
1 - failed to send a command (NGA_ERROR)
NGA_ERR_INVALID_PARAMETER - unknown string id.

This operation is never safe.

Property Documentation

LONG AccessPrivileges

get

Allowed access privileges for the active connection, read only.

Returns bitwise combination of the AccessPrivilege_t flags. When there is no active connection all zeroes are returned.

This property is always safe.

VARIANT_BOOL AutoScroll

getset

Auto scroll mode.

The scroll is done when the Mouse enters a hot zone close to the border (1/10 of the width or height in each side (left/right/top/bottom) of the RC window.

Default value: TRUE (enabled).

This property is always safe.

VARIANT_BOOL AutoTakeControl

getsetproperty

Gets or sets the auto take control property.

When several guests are connected to the same host only one of these guests controls Host's keyboard and mouse. When this option is enabled, Guest requests the control over Host keyboard and mouse automatically on keyboard or mouse hit.

Default value: TRUE.

This property is always safe.

LONG BackgroundColor

getset

Background color to be used by default OnEraseBackground handler.

DefaultValue -1(not set): black when connected, white with logo bitmap when not connected when set, uses the specified color for both states, no logo bitmap is drawn.

This property is always safe.

VARIANT_BOOL BlankHostScreenOnConnect

getset

Host screen blanking mode for the next connection.

BeginSession() method uses this mode when establishing a new connection.

Default value: FALSE (do not blank).

This property is always safe.

LONG CacheSize

getset

RC cache size in KB for the next connection.

Default value: 10000.

BeginSession() method uses this value when establishing a new connection. The nearest greater value from presets will be actually used.

This property is always safe.

IWGuestFont ChatFont

get

Get chat font interface, read only.

This property is always safe.

LONG ClipboardMaxSize

getset

Clipboard maximum size (in bytes).

When clipboard's size is less than ClipboardMaxSize, it is transmitted to/from Host. Default value is 300000.

This property is always safe.

LONG ClipboardMode

getset

Clipboard mode

One of the ClipboardMode_t constants can be assigned to this property:

0 ClipboardOff: ClipboardSend/Receive does nothing
WGuestLib::_IWGuestControlCP::OnHostClipboard, WGuestLib::_IWGuestControlCP::OnGuestClipboard
or automatic transfer never occur
1 ClipboardManual: ClipboardSend/Receive transfers clipboard,
WGuestLib::_IWGuestControlCP::OnHostClipboard occurs when host clipboard changes while control has focus
WGuestLib::_IWGuestControlCP::OnGuestClipboard occurs when control receives focus after guest clipboard has changed
2 ClipboardAuto: ClipboardSend/Receive transfers clipboard,
WGuestLib::_IWGuestControlCP::OnHostClipboard or automatic transfer occurs when host clipboard changes while control has focus
WGuestLib::_IWGuestControlCP::OnGuestClipboard or automatic transfer occurs when control receives focus after guest clipboard has changed

This property is always safe.

LONG CommProfile

getset

Communication profile for the next connection.

One of the CommProfile_t constants can be assigned to this property.

Default value: CommProfile_TCP

BeginSession() method uses this profile when establishing a new connection.

This property is always safe.

LONG CompressionLevel

getset

The compression level for the next connection.

One of the CompressionLevel_t constants can be assigned to this property.

BeginSession() method uses this mode when establishing a new connection.

Default value: CompressionLevel_Auto - select compression level automatically

This property is always safe.

LONG ControlHeight

get

The current height of the control window, read only.

This property is always safe.

LONG ControlWidth

get

The current width of the control window, read only.

This property is always safe.

LONG CurrentCacheSize

get

The actual RC cache size in KB for the active connection, read only.

When there is no active connection the NGA_UNKNOWN is returned.

This property is always safe.

LONG CurrentCommProfile

get

The communication profile of the current connection, read only.

When there is no active connection the NGA_UNKNOWN is always returned.

This property is always safe.

LONG CurrentCompressionLevel

getset

The compression level of the current connection, read/write.

One of the CompressionLevel_t constants can be assigned to this property.

When there is no active connection the NGA_UNKNOWN is returned.

This property is always safe.

LONG CurrentEncryption

get

The actual encryption level for the active connection, read only.

Returns one of the EncryptionLevel_t constants. When there is no active connection the NGA_UNKNOWN is returned.

This property is always safe.

LONG CurrentEncryptionPreferred

get

The encryption level of the current connection, read/write.

One of the EncryptionLevel_t constants can be assigned to this property.

When there is no active connection the NGA_UNKNOWN is returned.

This property is always safe.

BSTR CurrentGatewayAddress

get

The address of the gateway for the current connection, read only.

When there is no active connection the empty string is returned.

This property is always safe.

LONG CurrentGraphicsCompression

get

The graphics compression of the current connection, read only.

Number from 0 to 3: 0 - not compressed, 3 - maximum compression.

When there is no active connection the NGA_UNKNOWN is returned.

This property is always safe.

LONG CurrentGraphicsMaxColors

getset

The limit of bitmap mode colors for the current connection, read/write.

One of the MaxColors_t constant can be assigned to this property.

Used only for bitmap modes (e.g. when GraphicsMode property is either GraphicsMode_AccBitmap or GraphicsMode_NormalBitmap).

When there is no active connection the NGA_UNKNOWN is returned.

This property is always safe.

LONG CurrentGraphicsMode

get

The graphic mode of the current connection, read only.

One of the GraphicsMode_t constant can be assigned to this property.

When there is no active connection the NGA_UNKNOWN is returned.

This property is always safe.

BSTR CurrentHostAddress

get

The host address of the current connection, read only.

When there is no connection the empty string is returned.

This property is always safe.

BSTR CurrentHttpProxyAddress

get

The address of HTTP proxy for the current connection, read only.

When there is no connection the empty string is returned.

This property is always safe.

LONG CurrentPortNumber

get

The port number of the current connection, read only.

The value 0 means that default port for current communication profile should is used.

When there is no active connection NGA_UNKNOWN is returned.

This property is always safe.

LONG DesktopOptimizeMask

getset

Desktop optimization mask for the current and next connection.

A bitwise OR of the DesktopOptimization_t constants can be assigned to this property.

Changing this property will affect current RC session immediately. Same setting will be used for next RC session.

Default value: DesktopOptimization_DisableEverything - disable everything

This property is always safe.

LONG EncryptionPreferred

getset

The encryption level for the next connection.

One of the EncryptionLevel_t constants can be assigned to this property.

BeginSession() method uses this mode when establishing a new connection.

Default value: EncryptionLevel_Compatible - Classic encryption

This property is always safe.

VARIANT Events

get

Property for assigning event handlers in JavaScript environment (null if not supported).

Example:

ctrl.Events.OnOpenPre = new function () { print("event OnOpenPre fired") }

see WGuestLib::_IWGuestControlCP for the list of possible handlers.

This property is always safe.

BSTR GatewayAddress

getset

Address of gateway for the next connection.

When empty string is specified the gateway is not used. This property is ignored when UDP communication profile is selected.

BeginSession() method uses this address when establishing a new connection. Default value: empty string

This property is always safe.

LONG GraphicsCompression

getset

The graphics compression for the next connection.

Number from 0 to 3 can be assigned to this property: 0 - not compressed, 3 - maximum compression.

BeginSession() method use this mode when establishing a new connection.

This property is always safe.

LONG GraphicsMaxColors

getset

The limit of bitmap mode colors for the next connection.

One of the MaxColors_t constant can be assigned to this property.

Used only for bitmap modes (e.g. when GraphicsMode property is either GraphicsMode_AccBitmap or GraphicsMode_NormalBitmap).

BeginSession() method uses this mode when establishing a new connection.

Default value: MaxColors_Actual - use actual colors

This property is always safe.

LONG GraphicsMode

getset

The graphic mode for the next connection.

One of the GraphicsMode_t constant can be assigned to this property.

BeginSession() method uses this mode when establishing a new connection.

This property is always safe.

VARIANT_BOOL GuardHostOnConnect

getset

Host guard settings for the next connection.

BeginSession() method uses this mode when establishing a new connection.

Default value: FALSE (do not guard).

This property is always safe.

BSTR HostAddress

getset

The address of remote host for the next connection.

BeginSession() method uses this address when establishing a new connection. Default value: empty string

This property is always safe.

LONG HostScreenHeight

get

The current height of the remote desktop, read only.

When there is no active RC session the NGA_UNKNOWN is returned.

This property is always safe.

LONG HostScreenWidth

get

The current width of the remote desktop, read only.

When there is no active RC session the NGA_UNKNOWN is returned.

This property is always safe.

LONG HostType

get

Host type, read only.

Can be one of the HostType_t constants, if there is no active connection the NGA_UNKNOWN is returned.

This property is always safe.

BSTR HttpProxyAddress

getset

Address of HTTP proxy for the next connection.

The proxy address is ignored when UDP or TCP communication profile is selected.

BeginSession() method uses this address when establishing a new connection. Default value: empty string

This property is always safe.

VARIANT_BOOL IsConnected

get

Whether the instance of NGA is connected to remote Host, read only.

Property is true when there is an active session (chat, RC, FT or RM).

This property is always safe.

VARIANT_BOOL IsMultiguestAdminOnHost

get

Whether the current RC session has multi guest admin role on Host, read only.

When there is no active session the false is returned.

This property is always safe.

VARIANT_BOOL IsOpen

get

Whether the instance of NGA was opened successfully by Open() function, read only.

This property is always safe.

LONG KeyboardMode

getset

The keyboard mode of the current and next RC session.

One of the KeyboardMode_t constants can be assigned to this property.

Default value: KeyboardMode_Local

This property is always safe.

LONG Language

getset

Gets or sets the language used for build-in dialogs.

One of the Language_t constants can be assigned to this property.

When attempting to assign unsupported language value, the current UI language is not changed.

Default value: selected in accordance with system locale. If the current system locale is not supported, the Language_English language is used.

This property is always safe.

VARIANT_BOOL LicenseAutoSave

getset

The license properties autosave flag. WGuest checks this property when some license property is changed and if flag is TRUE property value is saved into registry. The setting of this flag affects only properties changed after flag was set.

Default value: TRUE.

This property is always safe.

BSTR LicenseKey

getset

The license key. WGuest uses this property when the license type is standalone. The string property contains the license key.

Default value: empty string

This property is safe to write.

LONG LicenseType

getset

Sentinel license type (network, standalone, etc).

One of the LicenseType_t constants can be assigned to this property.

When attempting to assign unsupported license type value, the current License type is not changed.

Default value: LicenseType_None

This property is safe to write.

VARIANT_BOOL LockHostKeyboardOnConnect

getset

Keyboard locking mode for the next connection.

BeginSession() method uses this mode when establishing a new connection.

Default value: FALSE (do not lock).

This property is always safe.

LONG MouseMode

getset

Mouse mode of current and next RC session.

One of the MouseMode_t constants can be assigned to this property.

Default value: MouseMode_Remote

This property is always safe.

BSTR myCloudAddress

getset

Gets or sets the myCloud address for the next connection.

This property is ignored when communication profile other than myCloud is selected.

BeginSession() method uses this address when establishing a new connection. Default value: empty string

This property is always safe.

BSTR myCloudAuthToken

getset

Gets or sets the myCloud authentication token.

This property is ignored when communication profile other than myCloud is selected.

When authentication token is set it replaces all myCloud credentials: Account, Domain, Password Default value: empty string

This property is always safe.

BSTR myCloudCredentialsAccount

getset

Gets or sets the myCloud credentials account for the next connection.

This property is ignored when communication profile other than myCloud is selected.

BeginSession() method uses this address when establishing a new connection. Default value: empty string

This property is safe to write.

BSTR myCloudCredentialsDomain

getset

Gets or sets the myCloud credentials domain for the next connection.

This property is ignored when communication profile other than myCloud is selected.

BeginSession() method uses this address when establishing a new connection. Default value: empty string

This property is safe to write.

BSTR myCloudCredentialsPassword

getset

Gets or sets the myCloud credentials password for the next connection.

This property is ignored when communication profile other than myCloud is selected.

BeginSession() method uses this address when establishing a new connection. Default value: empty string

This property is safe to write.

BSTR myCloudNameQualifier

getset

Gets or sets the myCloud name qualifier for next connection.

This property is ignored when communication profile other than myCloud is selected.

BeginSession() method uses this address when establishing a new connection. Default value: "HST"

This property is safe to write.

BSTR myCloudProvidedTicket

getset

Gets or sets the myCloud provided ticket for next connection.

This property is ignored when communication profile other than myCloud is selected.

BeginSession() method uses this address when establishing a new connection. Default value: empty string

This property is safe to write.

IWGuestNfmOptions NfmOptions

get

NFM options support interface (read only property).

This property can be used to set/get the properties related to NFM session.

See IWGuestNfmOptions interface description for more details.

This property is always safe.

LONG NumGuestsOnHost

get

The number of guests connected to Host, read only.

When there is no active session the NGA_UNKNOWN is returned.

This property is always safe.

LONG PortNumber

getset

Port number for the next connection.

The value 0 means that default port for current communication profile should be used.

BeginSession() method uses this property when establishing a new connection. Default value: 0

IWGuestRcArea RcArea

get

Rc area interface (read only property).

This property can be used to set/get the remote control area to be shown in the control. Changing this property does not affect the remote control area of the current connection, settings will be used for next connections.

See IWGuestRcArea interface description for more details.

This property is always safe.

VARIANT_BOOL RemoteCursor

getset

The remote cursor display mode.

When 'true' NGA mouse cursor has the shape of the Host mouse cursor when displayed in the NGA control. The shape of the cursor is not stretched when the remote desktop mode is stretched to fit the screen.

Default value: TRUE.

This property is always safe.

LONG ScrollPositionX

getset

The horizontal position of the remote desktop image inside NGA control.

Default value: 0

This property is always safe.

LONG ScrollPositionY

getset

The vertical position of the remote desktop image inside NGA control.

Default value: 0

This property is always safe.

LONG SessionStatus

get

Current status of RC session, read only.

Status: Can be one of the SessionStatus_t constants. When the NGA instance is not open, status is SessionStatus_Idle.

This property is always safe.

VARIANT_BOOL ShowRemoteMouseMovements

getset

Gets or sets the value of remote mouse movements property.

When this property is true the remote desktop mouse movements are shown when the control is focused.

Default value: false (do not show remote mouse movements).

This property is always safe.

IWGuestSkinSupport Skins

get

Skin support interface (read only property).

This property can be used to set/get the properties related to skins for RC view.

See IWGuestSkinSupport interface description for more details.

This property is always safe.

LONG StretchToFitWindow

getset

Remote desktop stretch mode.

Property indicates how the remote desktop image is displayed inside NGA control. Changing this property with active RC session will redraw the NGA control.

One of the StretchMode_t constants can be assigned to this property.

Default value: Stretch_FitWindowToHost

This property is always safe.

VARIANT_BOOL UnicodeKeyboardMode

getset

Indicates whether keyboard events will be sent as Unicode characters or as scan codes.

Returns: false - NGA sends scancodes true - NGA sends Unicode characters

Default value: : false (Send scan codes)

This property is always safe.

VARIANT_BOOL UseOneTimePassword

getset

Use one-time password scheme for the next connection.

Default value: FALSE.

BeginSession() method uses this value when establishing a new connection.

This property is always safe.

BSTR Version

getproperty

Control version (read only property).

This property is always safe.

The documentation for this interface was generated from the following file:

WGuest.idl

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation