WFICALib Interface Definition

General Information

Library: WFICALib (Citrix ICA Client)

File: C:\Program Files\Tier6\Wfica.ocx

GUID: {238F6F80-B8B4-11CF-8771-00A024541EE3}

Version: 2.1

Enumerations

This section lists enumerations exposed by WFICALib.

Public Enum ICAColorDepth

Color16=1

Color256=2

Color16Bit=4

Color24Bit=8

End Enum

Public Enum ICAEvent

EventNone=0

EventConnect=1

EventConnectFail=2

EventLogin=3

EventLoginFail=4

EventDisconnect=5

EventRunPubishedApp=6

EventRunPubishedAppFail=7

EventIcaFilePresent=8

EventLoadIcaFileFailed=9

EventInitializing=10

EventConnecting=11

EventInitialProp=12

EventDisconnectFailed=13

EventLogoffFailed=14

End Enum

Public Enum ICAScalingMode

ScalingModeDisabled=0

ScalingModePercent=1

ScalingModeSize=2

ScalingModeAutoSize=3

End Enum

Public Enum ICASessionCounter

SessionIncomingBytes=0

SessionOutgoingBytes=1

SessionIncomingFrames=2

SessionOutgoingFrames=3

SessionIncomingErrors=4

SessionOutgoingErrors=5

End Enum

Public Enum ICASessionEndAction

SessionEndDefault=0

SessionEndRestart=1

End Enum

Public Enum ICASessionString

SessionServer=0

SessionUsername=1

SessionDomain=2

End Enum

Public Enum ICASoundQuality

SoundQualityNone=-1

SoundQualityHigh=0

SoundQualityMedium=1

SoundQualityLow=2

End Enum

Interfaces

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

_IICAClientEvents {238F6F82-B8B4-11CF-8771-00A024541EE3}

Methods

Function OnClick(ByVal MouseButton As Long, ByVal PosX As Long, ByVal PosY As Long, ByVal KeyMask As Long) As ???

method OnClick

Function OnConnect() As ???

method OnConnect

Function OnConnectFailed() As ???

method OnConnectFailed

Function OnLogon() As ???

method OnLogon

Function OnLogonFailed() As ???

method OnLogonFailed

Function OnDisconnect() As ???

method OnDisconnect

Function OnPublishedApp() As ???

method OnPublishedApp

Function OnPublishedAppFailed() As ???

method OnPublishedAppFailed

Function OnICAFile() As ???

method OnICAFile

Function OnICAFileFailed() As ???

method OnICAFileFailed

Function OnInitializing() As ???

method OnInitializing

Function OnConnecting() As ???

method OnConnecting

Function OnInitialProp() As ???

method OnInitialProp

Function OnDisconnectFailed() As ???

method OnDisconnectFailed

Function OnLogoffFailed() As ???

method OnLogoffFailed

Events

None

ICAClient {238F6F83-B8B4-11CF-8771-00A024541EE3}

MethodsNone

Events

None

ICAClientProp {238F6F85-B8B4-11CF-8771-00A024541EE3}

MethodsNone

Events

None

IICAClient {238F6F81-B8B4-11CF-8771-00A024541EE3}

Methods

Property Let TabStop(RHS As Boolean)

Property Get TabStop() As Boolean

Sub AboutBox

method Show AboutBox

Sub ClearProps

method Clear all properties

Function GetPropCount() As Long

method Get property count

Sub DeleteProp(ByVal Name As String)

method Delete propoperty

Sub DeletePropByIndex(ByVal Index As Long)

method Delete propoperty by index

Function GetPropNameByIndex(ByVal Index As Long) As String

method Get propoperty name by index

Sub ResetProps

method Reset all propoperties

Sub SetProp(ByVal Name As String, ByVal Value As String)

method Set propoperty

Function GetPropValue(ByVal Name As String) As String

method Get propoperty value

Function GetPropValueByIndex(ByVal Index As Long) As String

method Get propoperty value by index

Sub Connect

method Connect to server

Sub Disconnect

method Disconnect from server

Sub Logoff

method Logoff from server

Sub LoadIcaFile(ByVal File As String)

method Load ICA file

Sub RunPublishedApplication(ByVal AppName As String, ByVal Arguments As String)

method Run published application

Sub SetSessionEndAction(ByVal Action As ICASessionEndAction)

method Set session end action

Function IsConnected() As Boolean

method True if currently connected to server

Function GetInterfaceVersion() As String

method Get ICA Client interface version

Function GetClientIdentification() As String

method Get ICA Client identification

Function GetSessionString(ByVal Index As ICASessionString) As String

method Get session string

Function GetSessionCounter(ByVal Index As ICASessionCounter) As Long

method Get session counter

Function GetNotificationReason() As ICAEvent

method Get last notification reason

Sub Startup

method Startup

Function GetLastError() As Long

method Get Last Error

Function GetLastClientError() As Long

method Get Last Client Error

Sub ScaleEnable

method Enable scaling

Sub ScaleDisable

method Disable scaling

Sub ScaleUp

method Scale up to a larger size

Sub ScaleDown

method Scale down to a smaller size

Sub ScaleSize(ByVal Width As Long, ByVal Height As Long)

method Scale to a size

Sub ScalePercent(ByVal Percent As Long)

method Scale to a percent

Sub ScaleToFit

method Scale to fit size of ICA Client Object window

Sub ScaleDialog

method Popup the scaling dialog box

Property Get Address() As String

property Address

Property Let Address(RHS As String)

property Address

Property Get Application() As String

property Application

Property Let Application(RHS As String)

property Application

Property Get AudioBandwidthLimit() As ICASoundQuality

property AudioBandwidthLimit

Property Let AudioBandwidthLimit(RHS As ICASoundQuality)

property AudioBandwidthLimit

Property Get Border() As Long

property Border

Property Let Border(RHS As Long)

property Border

Property Get CDMAllowed() As Boolean

property CDMAllowed

Property Let CDMAllowed(RHS As Boolean)

property CDMAllowed

Property Get ClientAudio() As Boolean

property ClientAudio

Property Let ClientAudio(RHS As Boolean)

property ClientAudio

Property Get ClientName() As String

property ClientName

Property Let ClientName(RHS As String)

property ClientName

Property Get COMAllowed() As Boolean

property COMAllowed

Property Let COMAllowed(RHS As Boolean)

property COMAllowed

Property Get Compress() As Boolean

property Compress

Property Let Compress(RHS As Boolean)

property Compress

Property Get Connected() As Boolean

property Connected

Property Get ConnectionEntry() As String

property ConnectionEntry

Property Let ConnectionEntry(RHS As String)

property ConnectionEntry

Property Get CPMAllowed() As Boolean

property CPMAllowed

Property Let CPMAllowed(RHS As Boolean)

property CPMAllowed

Property Get CustomMessage() As String

property CustomMessage

Property Let CustomMessage(RHS As String)

property CustomMessage

Property Get Description() As String

property Description

Property Let Description(RHS As String)

property Description

Property Get DesiredColor() As ICAColorDepth

property DesiredColor

Property Let DesiredColor(RHS As ICAColorDepth)

property DesiredColor

Property Get DesiredHRes() As Long

property DesiredHRes

Property Let DesiredHRes(RHS As Long)

property DesiredHRes

Property Get DesiredVRes() As Long

property DesiredVRes

Property Let DesiredVRes(RHS As Long)

property DesiredVRes

Property Get Domain() As String

property Domain

Property Let Domain(RHS As String)

property Domain

Property Get Encrypt() As Boolean

property Encrypt

Property Let Encrypt(RHS As Boolean)

property Encrypt

Property Get Height() As Long

property Height

Property Get ICAFile() As String

property ICAFile

Property Let ICAFile(RHS As String)

property ICAFile

Property Get IconIndex() As Long

property IconIndex

Property Let IconIndex(RHS As Long)

property IconIndex

Property Get IconPath() As String

property IconPath

Property Let IconPath(RHS As String)

property IconPath

Property Get InitialProgram() As String

property InitialProgram

Property Let InitialProgram(RHS As String)

property InitialProgram

Property Get IPXBrowserAddress() As String

property IPXBrowserAddress

Property Let IPXBrowserAddress(RHS As String)

property IPXBrowserAddress

Property Get NetbiosBrowserAddress() As String

property NetbiosBrowserAddress

Property Let NetbiosBrowserAddress(RHS As String)

property NetbiosBrowserAddress

Property Get NotificationReason() As ICAEvent

property NotificationReason

Property Get PersistentCacheEnabled() As Boolean

property PersistentCacheEnabled

Property Let PersistentCacheEnabled(RHS As Boolean)

property PersistentCacheEnabled

Property Get ProtocolSupport() As String

property ProtocolSupport

Property Let ProtocolSupport(RHS As String)

property ProtocolSupport

Property Get Reliable() As Boolean

property Reliable

Property Let Reliable(RHS As Boolean)

property Reliable

Property Get SessionEndAction() As ICASessionEndAction

property SessionEndAction

Property Let SessionEndAction(RHS As ICASessionEndAction)

property SessionEndAction

Property Get Start() As Boolean

property Start

Property Let Start(RHS As Boolean)

property Start

Property Get TCPBrowserAddress() As String

property TCPBrowserAddress

Property Let TCPBrowserAddress(RHS As String)

property TCPBrowserAddress

Property Get TransportDriver() As String

property TransportDriver

Property Let TransportDriver(RHS As String)

property TransportDriver

Property Get UIActive() As Boolean

property UIActive

Property Let UIActive(RHS As Boolean)

property UIActive

Property Get UpdatesAllowed() As Boolean

property UpdatesAllowed

Property Let UpdatesAllowed(RHS As Boolean)

property UpdatesAllowed

Property Get Username() As String

property Username

Property Let Username(RHS As String)

property Username

Property Get Version() As String

property Version

Property Get VSLAllowed() As Boolean

property VSLAllowed

Property Let VSLAllowed(RHS As Boolean)

property VSLAllowed

Property Get Width() As Long

property Width

Property Get WinstationDriver() As String

property WinstationDriver

Property Let WinstationDriver(RHS As String)

property WinstationDriver

Property Get WorkDirectory() As String

property WorkDirectory

Property Let WorkDirectory(RHS As String)

property WorkDirectory

Property Get AppsrvIni() As String

property AppsrvIni

Property Let AppsrvIni(RHS As String)

property AppsrvIni

Property Get ModuleIni() As String

property ModuleIni

Property Let ModuleIni(RHS As String)

property ModuleIni

Property Get WfclientIni() As String

property WfclientIni

Property Let WfclientIni(RHS As String)

property WfclientIni

Property Get ClientPath() As String

property ClientPath

Property Get ClientVersion() As String

property ClientVersion

Property Get LogAppend() As Boolean

property LogAppend

Property Let LogAppend(RHS As Boolean)

property LogAppend

Property Get LogConnect() As Boolean

property LogConnect

Property Let LogConnect(RHS As Boolean)

property LogConnect

Property Get LogErrors() As Boolean

property LogErrors

Property Let LogErrors(RHS As Boolean)

property LogErrors

Property Get LogFile() As String

property LogFile

Property Let LogFile(RHS As String)

property LogFile

Property Get LogFlush() As Boolean

property LogFlush

Property Let LogFlush(RHS As Boolean)

property LogFlush

Property Get LogKeyboard() As Boolean

property LogKeyboard

Property Let LogKeyboard(RHS As Boolean)

property LogKeyboard

Property Get LogReceive() As Boolean

property LogReceive

Property Let LogReceive(RHS As Boolean)

property LogReceive

Property Get LogTransmit() As Boolean

property LogTransmit

Property Let LogTransmit(RHS As Boolean)

property LogTransmit

Property Get Title() As String

property Title

Property Let Title(RHS As String)

property Title

Property Get Launch() As Boolean

property Launch

Property Let Launch(RHS As Boolean)

property Launch

Property Get BackgroundColor() As ULong

property BackgroundColor

Property Let BackgroundColor(RHS As ULong)

property BackgroundColor

Property Get BorderColor() As ULong

property BorderColor

Property Let BorderColor(RHS As ULong)

property BorderColor

Property Get TextColor() As ULong

property TextColor

Property Let TextColor(RHS As ULong)

property TextColor

Property Get EncryptionLevelSession() As String

property EncryptionLevelSession

Property Let EncryptionLevelSession(RHS As String)

property EncryptionLevelSession

Property Get HttpBrowserAddress() As String

property HttpBrowserAddress

Property Let HttpBrowserAddress(RHS As String)

property HttpBrowserAddress

Property Get BrowserProtocol() As String

property BrowserProtocol

Property Let BrowserProtocol(RHS As String)

property BrowserProtocol

Property Get LocHTTPBrowserAddress() As String

property LocHTTPBrowserAddress

Property Let LocHTTPBrowserAddress(RHS As String)

property LocHTTPBrowserAddress

Property Get LocIPXBrowserAddress() As String

property LocIPXBrowserAddress

Property Let LocIPXBrowserAddress(RHS As String)

property LocIPXBrowserAddress

Property Get LocNETBIOSBrowserAddress() As String

property LocNETBIOSBrowserAddress

Property Let LocNETBIOSBrowserAddress(RHS As String)

property LocNETBIOSBrowserAddress

Property Get LocTCPBrowserAddress() As String

property LocTCPBrowserAddress

Property Let LocTCPBrowserAddress(RHS As String)

property LocTCPBrowserAddress

Property Get DoNotUseDefaultCSL() As Boolean

property DoNotUseDefaultCSL

Property Let DoNotUseDefaultCSL(RHS As Boolean)

property DoNotUseDefaultCSL

Property Get ICAPortNumber() As Long

property ICAPortNumber

Property Let ICAPortNumber(RHS As Long)

property ICAPortNumber

Property Get KeyboardTimer() As Long

property KeyboardTimer

Property Let KeyboardTimer(RHS As Long)

property KeyboardTimer

Property Get MouseTimer() As Long

property MouseTimer

Property Let MouseTimer(RHS As Long)

property MouseTimer

Property Get Scrollbars() As Boolean

property Scrollbars

Property Let Scrollbars(RHS As Boolean)

property Scrollbars

Property Get ScalingHeight() As Long

property ScalingHeight

Property Let ScalingHeight(RHS As Long)

property ScalingHeight

Property Get ScalingMode() As ICAScalingMode

property ScalingMode

Property Let ScalingMode(RHS As ICAScalingMode)

property ScalingMode

Property Get ScalingPercent() As Long

property ScalingPercent

Property Let ScalingPercent(RHS As Long)

property ScalingPercent

Property Get ScalingWidth() As Long

property ScalingWidth

Property Let ScalingWidth(RHS As Long)

property ScalingWidth

Events

None