Download - Configuration Guide (.Ini File Reference)
Configuration Guide(.Ini File Reference)
Citrix® ICA Win32 Program Neighborhood ClientVersion 6.20
Citrix Systems, Inc.
Information in this document is subject to change without notice. Companies, names, and data used in examples herein are fictitious unless otherwise noted. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Citrix Systems, Inc.
Copyright © 2001 Citrix Systems, Inc. All rights reserved.
Citrix, ICA (Independent Computing Architecture), Independent Management Architecture (IMA), Program Neighborhood, MetaFrame, MetaFrame XP, and NFuse are registered trademarks or trademarks of Citrix Systems, Inc. in the U.S.A. and other countries.
RSA Encryption (c) 1996-1997 RSA Security Inc., All Rights Reserved.
Microsoft, MS, MS-DOS, Windows, Windows NT, and Windows 2000 Servers are registered trademarks or trademarks of Microsoft Corporation in the U.S.A and other countries.
All other trade names referred to are the Servicemark, Trademark, or Registered Trademark of the respective manufacturers.
Document Code iniref.1.0.adamm
Contents 3
Contents
Appendix A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Chapter 2 Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Finding More Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Citrix Developer Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Citrix on the World Wide Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Reader Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Disclaimer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 3 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.Ini File Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16UI Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Chapter 4 File Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19ApplicationServers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19applicationsetname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19ClientComm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Program Neighborhood . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20ProtocolDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20protocoldrivername . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20serverentryname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21ThinWire3.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21TransportDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21transportname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21VirtualDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22WFClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22WinStationDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23winstationdrivername . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4 ICA Win32 Program Neighborhood Client Configuration Guide
Chapter 5 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25AddICAIconOff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25AllowForeignIRQShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26ApplicationSetManagerIconOff. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26AudioBandwidthLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26AutoLogonAllowed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27AutoReconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27BrowserRetry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27BrowserTimeout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28BufferLength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28CDMAllowed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28ClientAudio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29ColorMismatchPrompt_Have16_Want256 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29ColorMismatchPrompt_Have16M_Want256 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29ColorMismatchPrompt_Have64M_Want256 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30COM1IOP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30COM1IRQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30COM2IOP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31COM2IRQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31COM3IOP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31COM3IRQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32COM4IOP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32COM4IRQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32COMAllowed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Compress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33ConnectTTY. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33ConnectTTYDelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34ConnectType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34CPMAllowed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34CustomConnectionsIconOff. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35DefaultSoundType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35DefaultVideoType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35DesiredColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36DesiredHRES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36DesiredVRES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Contents 5
DesiredWinType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37DisableCtrlAltDel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38DisableSound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38DoNotUseDefaultCSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39DosConnectTTY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39DragoutOff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39DriverName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40DriverNameWin16. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40DriverNameWin32. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40EnableSSOnThruICAFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Encrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41EncryptionLevelSession. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42FindNewApplicationSetIconOff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Hotkey1..12Char . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43HotKey1..10Shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44HowManySkipRedrawPerPaletteChange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44ICAPortNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45ICASOCKSProtocolVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45ICASOCKSProxyHost. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46ICASOCKSProxyPortNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46IconIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46IconPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47InitialProgram. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47IpxBrowserAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47KeyboardLayout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48KeyboardTimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48KeyboardType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49LanaNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49LogApend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50LogConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50LogErrors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51LogFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51LogFileGlobalPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52LogFileWin16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52LogFileWin32 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
6 ICA Win32 Program Neighborhood Client Configuration Guide
LogKeyboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53LogReceive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53LogTransmit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54LongCommandLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54MaximumCompression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55MouseTimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56NameEnumerator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56NameResolver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57NetBiosBrowserAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58NoAutoDetectProtocol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58NoDeskInt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Password. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59PersistentCacheEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60PersistentCacheGlobalPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60PersistentCacheMinBitmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61PersistentCachePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61PersistentCacheSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61PersistentCachePercent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62PingServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62PNCacheRefresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63PNName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63PNUIShowTB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64PNUIShowTBText. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64PNUIShowSB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65PNUIViewType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65PNUINoAutoSearch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66PNUIHPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66PNUIVPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67PNUIWidth. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67PNUIHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67PNDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68PreferTw1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68ProtocolSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Reducer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70ReducerWin16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70ReducerWin32 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Contents 7
Reliable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71SavePNPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71ScreenPercent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72serverentryname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72SkipRedrawPerPaletteChange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72SSOnUserSetting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73SwapButtons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73TcpBrowserAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74TransportDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74TWIMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74UpdatesAllowed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75UseAlternateAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75UseDefaultEncryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76UseDefaultSound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77UseDefaultWinColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77UseDefaultWinSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78UseLocalUserAndPassword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79VirtualDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79winstationdrivername . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80ZLKeyboardMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80ZLMouseMode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Appendix A License Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
C H A P T E R 1
Welcome
The Citrix ICA Win32 Program Neighborhood Client can be configured using a set of .Ini files. This document identifies those files, explains their relationships, and defines the parameters that they use.
This guide is for Citrix ICA Client administrators who want to extend and customize the capabilities of the ICA Win32 Program Neighborhood Client. This document supplements the ICA Win32 Client Administrator’s Guide.
Topics covered include:
� Configuration file types, contents, and precedence� .Ini file sections� .Ini file parameters
Document ConventionsThe following conventional terms, text formats, and symbols are used throughout the printed documentation:
Convention Meaning
Bold Indicates column headings, command-line commands and options, dialog box titles, lists, menu names, tabs, and menu commands.
Italic Indicates a placeholder for information or parameters that you must provide. For example, if the procedure asks you to type a filename, you must type the actual name of a file. Italics also indicate new terms and the titles of other books.
ALL UPPERCASE Represents keyboard keys (for example, CTRL, ENTER, F2).
...(ellipsis) Indicates a command element can be repeated.
10 ICA Win32 Program Neighborhood Client Configuration Guide
Finding More InformationFor additional information about the topics included in this document, consult the following:
� The Administrator’s Guide for the Citrix ICA Win32 Clients tells administrators how to install and configure the ICA Win32 Clients.
� The ICA Win32 Program Neighborhood Client Readme file contains last minute updates, corrections to the documentation, and a list of known problems. This file is located on the ICA Client CD-ROM.
� The documentation included in your Citrix server package for instructions about installing, configuring, and maintaining your Citrix servers.
Citrix Developer NetworkThe Citrix Developer Network (CDN) is a Citrix program that extends the reach of Citrix application server technology to independent software vendors, independent hardware vendors, system integrators, ICA licensees, and corporate IT developers who want to incorporate Citrix server-based computing solutions into their products.
The Citrix Developer Network is a membership program with open enrollment. Through the CDN Web site, Citrix provides access to developer tool kits, technical information, and test programs needed to successfully “design in” or add Citrix server-based computing compatibility to hardware and software. Today, the CDN program includes several software development kits (SDKs) and test kits, with an emphasis on delivering enabling technologies that promote technical relationships with Citrix.
Register for the Citrix Developer Network at the CDN Web site:
http://www.citrix.com/cdn
Monospace Represents examples of screen text or entries that you might type at the command line or initialization files.
� Indicates a procedure with sequential steps.
� Indicates a list of related information, not procedural steps.
Convention Meaning
Chapter 1 Welcome 11
Citrix on the World Wide WebThe Citrix Web site, at http://www.citrix.com, offers a variety of information and services for Citrix customers and users. From the Citrix home page, you can access Citrix online Technical Support Services and other information designed to assist administrators, including the following:
� Downloadable Citrix ICA Clients (available at http://www.citrix.com/download)
� Program information about Citrix Preferred Support Services options� An FTP server containing the latest service packs, hotfixes, utilities, and
product literature for download� An online Solution Knowledgebase containing an extensive collection of
technical articles, troubleshooting tips, and white papers� Interactive online Solution Forums for discussion of technical issues with
other users� Frequently Asked Questions pages with answers to common technical and
troubleshooting questions� Citrix Documentation Library containing the latest MetaFrame documentation� Information about programs and courseware for Citrix training and
certifications� Contact information for Citrix headquarters, including worldwide, European,
Asia Pacific, and Japan headquarters
Reader CommentsIt is our goal to provide you with accurate, clear, complete, and usable documentation for Citrix products. If you have any comments, corrections, or suggestions for improving our documentation, we would be happy to hear from you.
You can send e-mail to the documentation authors at [email protected]. Please include the product name and version number, and the title of the document in your message.
12 ICA Win32 Program Neighborhood Client Configuration Guide
DisclaimerThis documentation is provided to you, the licensed user, by Citrix Systems, Inc. (“Citrix”) pursuant to the terms of the Software Development Kit License Agreement included as Appendix A and may only be used in accordance with the express terms of the Software Development Kit License Agreement.
This document is provided “AS IS” and Citrix and its suppliers make and the licensed user receives no warranties or conditions, express, implied, statutory, or otherwise. Citrix has made reasonable efforts to ensure the completeness and accuracy of all information contained in this document.
This document is subject to change without notice and Citrix is not obligated to maintain, update, or otherwise support such documentation.
C H A P T E R 2
Overview
Seven configuration files are associated with the ICA Client:
• Pn.ini - Contains Program Neighborhood settings. A copy of Pn.ini is stored in each user’s %userprofile%\Application Data\ICAClient directory.
• Appsrv.ini - Maintains a description for each defined server connection. There is a section for each connection entry. Within each section are parameters that define the target logon. Settings in the Appsrv.ini override those found in Module.ini. Appsrv.ini also contains user interface settings, in the [WFClient] section. This file is stored in the same directory as the Citrix client executables.
• Wfclient.ini - Contains a section for parameters specific to the client computer, such as keyboard layout and desired resolution. This file is stored in the same directory as the Citrix client executables.
• Wfcname.ini - Contains one entry, the name of the ICA Client. This file is stored in the root directory of the client device. There is typically no need to manually modify this file. It is not referenced elsewhere in this document.
• Module.ini - Contains a comprehensive list of the parameters used to select and configure the communications stack modules. The section headings identify the target module by name.
Note Do not attempt to edit this file. Appsrv.ini settings take precedence.
14 ICA Win32 Program Neighborhood Client Configuration Guide
The stack element types are:
• Transport Drivers (TD) - manage the communications connection
• Protocol Drivers (PD) - manage intermediate data stream filters
• WinStation Drivers (WD) - manage the presentation data stream
• Virtual Drivers (VD) - manage ICA protocol extensionsThese elements are all loaded depending on the user configuration and the required stack relationships. The transport drivers are loaded first, then protocol drivers, the WinStation drivers, and finally the virtual drivers. Each of the supported types has a section that describes the module name and default parameters. Most parameters in this file are defaults. Equivalent entries in Appsrv.ini override the settings in this file. This file is stored in the same directory as the Citrix client executables.
• Modem.ini - Contains the modem initialization strings for a variety of different modems. This file is stored in the same directory as the Citrix client executables.
• Wfcsetup.ini - Used by Setup to determine how an install will proceed. The file contains no user modifiable entries, and it is not referenced elsewhere in the document. This file is stored in the same directory as the Citrix client executables.
• Filename.idx - Index file for a particular application set. The file name is randomly generated. The file is stored in each user’s %userprofile%\Application Data\ICAClient directory.
Note Do not attempt to edit this file.
• Filename.vl - Data file for a particular application set. The file name is randomly generated. The file is stored in each user’s %userprofile%\Application Data\ICAClient directory. This file contains a database of applications in the application set. The user name and domain are stored in the application set section of the Pn.ini. The password is encrypted using a proprietary algorithm and stored with the application information in the .vl file.
Note Do not attempt to edit this file.
Chapter 2 Overview 15
The ICA Client directly modifies four of these files: Appsrv.ini, Pn.ini, Wfclient.ini, and Wfcname.ini. Module.ini, Modem.ini, and Wfcsetup.ini are not changed by the ICA Client during use, but can be manually modified by the user. Except for Wfcname.ini, the .ini files are stored in the same directory as the ICA Client executables. With the Win32 and Linux versions of the ICA Client, a separate copy of Appsrv.ini and Wfclient.ini for each user are located in the user’s profile directory.
PrecedenceThe following diagram describes precedence between the various .ini files:
The settings in Wfclient.ini are the default settings for the ICA Client. They are overridden if the same entries appear in Pn.ini or Appsrv.ini. The settings in Pn.ini are the default settings for each application set. They are overridden by settings in Appsrv.ini. Appsrv.ini contains the default settings for connections. Settings here override settings in Pn.ini and Module.ini.
16 ICA Win32 Program Neighborhood Client Configuration Guide
.Ini File ContentsThe parameters listed in each file are grouped into sections. Each section begins with a name in square brackets indicating parameters that belong together. For example, the [ClientDrive] section lists parameters related to Client Drive Mapping (CDM). In most cases, uniquely named parameters (for example, TcpNoDelay) can be placed under different headings, or even in a different file, without effect. This is possible because all the .ini files are read into memory before being parsed. However, some settings can be put in the connection-specific section in Appsrv.ini, or in the [Thinwire3.0] section of Wfclient.ini. In these cases, the value in [Thinwire3.0] is a default, which applies to all connections unless overridden by connection-specific values. Examples of these are DesiredColor, DesiredHRES, and DesiredVRES.
Default values are automatically supplied for any missing parameters except where indicated. If a parameter is present but is not assigned a value, the default is automatically applied; for example, if InitialProgram is followed by “=” (without the quotes) but no value, the default (not to run a program after logging in) is applied.
Note Boolean parameters may use “No”, “False”, “Off”, “off”, or “0” to indicate FALSE, and “Yes”, “True”, “On”, “on”, or “1” to indicate TRUE.
Spaces are significant and values are case-sensitive for all parameters.
UI ElementsThe display of many of the UI elements in Program Neighborhood are controlled by parameters in .ini files. The following screenshots have these elements circled and point out the parameters that control them.
Chapter 2 Overview 17
CustomConnectionsIconOff
FindNewApplicationSetIconOff
PNUIShowTB
PNUIShowTBText
PNUIShowSB
ApplicationSetManagerIconOff
C H A P T E R 3
File Sections
Note Section names in italics are variable. Valid values are explained in the description.
ApplicationServers
This section contains entry names for each defined server connection. For each name in the list, there is an applicationsetname section to describe the connection.
applicationsetname
This section contains the settings for a particular application set.
File Appsrv.ini
Platform WinDOS
File Pn.ini
Platform PN
14 ICA Win32 Program Neighborhood Client Configuration Guide
ClientComm
This virtual driver is responsible for providing client COMM port access to supplement the ICA 3.0 driver.
Program Neighborhood
This section contains a list of the discovered application sets and a randomly generated file name (without path or extension) for the index (.idx) and data (.vl) files. These files are stored in each user’s %userprofile%\Application Data\ICAClient directory.
ProtocolDriver
This section lists all of the valid protocol driver names. Each name has an associated section.
protocoldrivername
This section contains settings specific to the individual protocol driver.
File Module.ini
Platform WinDOS
File Pn.ini
Platform PN
File Module.ini
Platform WinDOS
File Module.ini
Platform WinDOS
Chapter 3 File Sections 15
serverentryname
This section is used by the ICA Client engine through the WFEngLoadSession() call. The name of the section corresponds to the name listed in the Custom ICA Connections group within Program Neighborhood. The following parameters are required to successfully establish an ICA connection: TransportDriver, Address, WinStationDriver, DesiredColor, DesiredWinType, DesiredHRES, and DesiredVRES.
ThinWire3.0
This virtual driver is responsible for the graphics support to supplement the ICA 3.0 driver.
TransportDriver
This section lists all of the valid transport driver names. Each name has an associated section.
transportname
The transport driver uses this section. For each transport driver, there is a section; for example, “TCP/IP-FTP” is the label for the section used by the FTP Software TCP/IP transport driver.
File Appsrv.ini
Platform WinDOS
File Module.ini, Wfclient.ini
Platform WinDOS
File Module.ini
Platform WinDOS
File Module.ini
Platform WinDOS
16 ICA Win32 Program Neighborhood Client Configuration Guide
VirtualDriver
The following drivers are responsible for additional functions not provided by the base WinStation drivers:
Thinwire3.0
ClientDrive
ClientPrinterQueue
ClientPrinterPort
Clipboard
ClientComm
ClientAudio
TWI
ClientManagement
LicenseHandler
ProgramNeighborhood
VFrame
ZL_FONT
ZLC
ICACTL
WFClient
The ICA Client engine uses this section. It contains default session-oriented parameters.
File Module.ini
Platform Win
File Appsrv.iniWFClient.ini
Platform WinDOS
Chapter 3 File Sections 17
WinStationDriver
This section lists all of the valid WinStation driver names. Each name has an associated section.
winstationdrivername
Used by the WinStation driver. “ICA 3.0” is the only valid value.
File Module.ini
Platform WinDOS
File Module.ini
Platform WinDOS
C H A P T E R 3
Parameters
AddICAIconOff
This parameter specifies whether or not to display the Add ICA Connection icon in the Program Neighborhood window.
Address
This parameter contains the address of the target server. For TCP/IP connections, this can be the DNS name of a Citrix server, the IP address of a Citrix server, or the name of a published application. For IPX, SPX, and NetBIOS connections, it can be the name of a Citrix server or the name of a published application.
Value Type Boolean
Default Value Off
Platforms PN
Sections WFClient
Value Type String
Default Value N/A
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
20 ICA Win32 Program Neighborhood Client Configuration Guide
AllowForeignIRQShare
When enabled, this parameter allows the ICA DOS32 Client to share an IRQ number with a driver or TSR (Terminate and Stay Resident program). The driver or TSR must be well-behaved and must be installed first so that the DOS32 Client can chain the interrupt to the foreign driver.
ApplicationSetManagerIconOff
This parameter specifies whether or not to display the Application Set Manager icon in the Program Neighborhood window.
AudioBandwidthLimit
This parameter sets the audio bandwidth limit or audio quality for the connection. Higher quality audio requires more bandwidth. 0 is high, 1 is medium, and 2 is low. The bandwidth limit for High is 1.4 megabits per second (Mbps), Medium is 64 kilobits per second (Kbps), and Low is 4 Kbps. This parameter corresponds to the audio level drop-down list in the Properties dialog box of Program Neighborhood.
Value Type Boolean
Default Value No
Platforms DOS32
Sections ClientComm
Value Type Boolean
Default Value Off
Platforms PN
Sections WFClient
Value Type Integer [0-2]
Default Value 1 for network connections, 2 for serial connections
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Chapter 3 Parameters 21
AutoLogonAllowed
This parameter specifies whether or not to require users to enter their user name, domain name, and password when connecting using encryption levels greater than Basic. By default, users are required to enter this information, even if it is specified in Appsrv.ini. Specifying the value “On” allows users to log on automatically if a valid user name, domain name, and password are specified in Appsrv.ini.
AutoReconnect
This parameter specifies whether or not the ICA Client automatically attempts to reconnect if the connection is dropped. This is usually used for dial-in connections.
BrowserRetry
This parameter specifies the number of times the ICA Client device will resubmit a master browser request that has timed out.
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
Value Type Boolean
Default Value Off
Platforms Win32
Sections WFClient
Value Type Integer
Default Value 3
Platforms WinDOS
Sections WFClient
22 ICA Win32 Program Neighborhood Client Configuration Guide
BrowserTimeout
This parameter specifies the number of milliseconds the ICA Client will wait for a response after making a request to the ICA master browser.
BufferLength
This parameter specifies the input buffer length in bytes.
CDMAllowed
This parameter specifies whether or not to allow client drive mapping.
Value Type Integer
Default Value 1000
Platforms WinDOS
Sections WFClient
Value Type Integer
Default Value 2048
Platforms WinDOS
Sections winstationdrivername
Value Type Boolean
Default Value On
Platforms WinDOS
Sections WFClient
Chapter 3 Parameters 23
ClientAudio
This parameter specifies whether or not to enable client audio mapping.
ColorMismatchPrompt_Have16_Want256
This parameter controls whether to display a warning if the client device’s color depth is 16 colors and the connection configuration is for 256 colors. The warning is not displayed when using the Program Neighborhood ICA Client.
ColorMismatchPrompt_Have16M_Want256
This parameter controls whether or not to display a warning if the client device’s color depth is high color (16-bit) and the connection configuration is for 256 colors. The warning is not displayed when using the Program Neighborhood ICA Client.
Value Type Boolean
Default Value Off
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
24 ICA Win32 Program Neighborhood Client Configuration Guide
ColorMismatchPrompt_Have64M_Want256
This parameter controls whether or not to display a warning if the client device’s color depth is true color (32-bit) and the connection configuration is for 256 colors. The warning is not displayed when using the Program Neighborhood ICA Client.
COM1IOP
This parameter specifies the I/O communication address for non-standard COM1 ports. If misconfigured, reboot the ICA Client device.
COM1IRQ
This parameter specifies the IRQ number for non-standard COM1 ports. If misconfigured, reboot the ICA Client device.
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
Value Type Integer
Default Value 0x3f8
Platforms DOS32
Sections ClientComm
Value Type Integer
Default Value 4
Platforms DOS32
Sections ClientComm
Chapter 3 Parameters 25
COM2IOP
This parameter specifies the I/O communication address for non-standard COM2 ports. If misconfigured, reboot the ICA Client device.
COM2IRQ
This parameter specifies the IRQ number for non-standard COM2 ports. If misconfigured, reboot the ICA Client device.
COM3IOP
This parameter specifies the I/O communication address for non-standard COM3 ports. If misconfigured, reboot the ICA Client device.
Value Type Integer
Default Value 0x2f8
Platforms DOS32
Sections ClientComm
Value Type Integer
Default Value 3
Platforms DOS32
Sections ClientComm
Value Type Integer
Default Value 0x3e8
Platforms DOS32
Sections ClientComm
26 ICA Win32 Program Neighborhood Client Configuration Guide
COM3IRQ
This parameter specifies the IRQ number for non-standard COM3 ports. If misconfigured, reboot the ICA Client device.
COM4IOP
This parameter specifies the I/O communication address for non-standard COM4 ports. If misconfigured, reboot the ICA Client device.
COM4IRQ
This parameter specifies the IRQ number for non-standard COM4 ports. If misconfigured, reboot the ICA Client device.
Value Type Integer
Default Value 4
Platforms DOS32
Sections ClientComm
Value Type Integer
Default Value 0x2e8
Platforms DOS32
Sections ClientComm
Value Type Integer
Default Value 3
Platforms DOS32
Sections ClientComm
Chapter 3 Parameters 27
COMAllowed
This parameter specifies whether or not COM port mapping is permitted.
Compress
This parameter specifies the flag associated with the compress protocol driver. If this is set to “on,” and “compress” is in the ProtocolSupport list, the compression protocol driver is loaded.
ConnectTTY
Warning Fixed value. Do not change.
Value Type Boolean
Default Value On
Platforms WinDOS
Sections WFClient
Value Type Boolean
Default Value Off
Platforms PN, WinDOS
Sections applicationsetname (PN)transportname (WinDOS)
Value Type Boolean
Default Value Off
Platforms Win
Sections WFClientwinstationdrivername
28 ICA Win32 Program Neighborhood Client Configuration Guide
ConnectTTYDelay
Warning Fixed value. Do not change.
ConnectType
This parameter specifies the connection type to be used. Valid values are:
• 1 = LAN
• 2 = WAN
• 3 = PPP
• 4 = Dial-Up
CPMAllowed
This parameter specifies whether or not printer port mapping is allowed.
Value Type Integer
Default Value 1000
Platforms WinDOS
Sections WFClientwinstationdrivername
Value Type Integer
Default Value 1
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Value Type Boolean
Default Value On
Platforms WinDOS
Sections WFClient
Chapter 3 Parameters 29
CustomConnectionsIconOff
This parameter specifies whether or not to display the Custom ICA Connections icon in the Program Neighborhood window.
DefaultSoundType
Warning Fixed value. Do not change.
DefaultVideoType
Warning Fixed value. Do not change.
Value Type Boolean
Default Value Off
Platforms PN
Sections WFClient
Value Type Integer
Default Value 1
Platforms PN
Sections applicationsetname (PN)serverentryname (WinDOS)
Value Type Boolean
Default Value N/A
Platforms PN
Sections applicationsetname (PN)serverentryname (WinDOS)
30 ICA Win32 Program Neighborhood Client Configuration Guide
DesiredColor
This parameter specifies the color depth. Valid values are:
• 1 - 16 colors
• 2 - 256 colors
• 4 - high color
• 8 - true color
DesiredHRES
If DesiredWinType is set to 5 (Custom), this parameter defines the horizontal window size in pixels.
Value Type Integer
Default Value 1
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Value Type Integer
Default Value 640
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Chapter 3 Parameters 31
DesiredVRES
If DesiredWinType is set to 5 (Custom), this parameter defines the vertical window size in pixels. The Win32 ICA Client requires the value to be set to 4294967295 when the DesiredWinType is Seamless.
DesiredWinType
This parameter specifies the default desired window size for custom connections. Valid values are:
• 0 - Inherit the default setting from Wfclient.ini. This is not a valid value in Wfclient.ini.
• 1 - 640x480
• 2 - 800x600
• 3 - 1024x768
• 4 - 1280x1024
• 5 - Custom size defined by DesiredHRES and DesiredVRES
• 6 - Percent
• 7 - Full screen
• 8 - Seamless
Value Type Integer
Default Value 480
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Value Type Integer
Default Value 0
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
32 ICA Win32 Program Neighborhood Client Configuration Guide
DisableCtrlAltDel
This parameter disables the use of the Ctrl+Alt+Del key combination within the session to prevent users from shutting down the MetaFrame server.
DisableSound
This parameter disables Windows alert sounds (the windows “Asterisk” event). If client audio mapping is enabled with the ClientAudio parameter, this setting has no effect.
Domain
This parameter specifies the user domain for the application set, published application, or server. This entry is present only if the user credentials are supplied.
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
Value Type String
Default Value None
Platforms WinDOS, PN
Sections applicationsetname (PN)serverentryname (WinDOS)
Chapter 3 Parameters 33
DoNotUseDefaultCSL
This parameter specifies whether or not to use the SOCKS and server location values from the [WFClient] section or a specific application’s serverentryname section. If “On,” the values from the serverentryname section are used, otherwise the values from the WFClient section of Appsrv.ini are used. It corresponds to the Use Custom Default check box in the Server Location section of the Connection tab of the custom connection Properties dialog box.
DosConnectTTY
This parameter specifies whether to echo data during the connect phase. If “on,” data is echoed. This allows you to use TTY emulation to get through dial-up network devices that may include third-party products such as security devices and X.25 PADs.
DragoutOff
This parameter specifies whether or not to allow the user to drag connection icons from the Program Neighborhood window to the Windows desktop.
Value Type Boolean
Default Value Off
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Value Type Boolean
Default Value On
Platforms DOS
Sections WFClient
Value Type Boolean
Default Value Off
Platforms PN
Sections WFClient
34 ICA Win32 Program Neighborhood Client Configuration Guide
DriverName
This parameter specifies the name of the DOS protocol, transport, or WinStation driver file to load.
DriverNameWin16
This parameter specifies the name of the Win16 protocol, transport, or WinStation driver file to load.
DriverNameWin32
This parameter specifies the name of the Win32 protocol, transport, or WinStation driver file to load.
Value Type File name
Default Value None
Platforms DOS
Sections protocoldrivernametransportnamewinstationdrivername
Value Type File name
Default Value None
Platforms Win16
Sections protocoldrivernametransportnamewinstationdrivername
Value Type File name
Default Value None
Platforms Win32
Sections protocoldrivernametransportnamewinstationdrivername
Chapter 3 Parameters 35
EnableSSOnThruICAFile
This parameter specifies whether or not to use the same user name, password, and domain name that were used to log on to the client computer for making connections using .ica files. Without this parameter, even if UseLocalUserAndPassword is specified in the .ica file, users will not be automatically logged on because it poses a security risk.
Related Parameters: UseLocalUserAndPassword, SSOnUserSetting
Encrypt
If this parameter is set to “on,” and “Encrypt” is in the ProtocolSupport list, the encryption protocol driver is loaded.
Value Type Boolean
Default Value Off
Platforms PN
Sections WFClient
Value Type Boolean
Default Value On
Platforms WinDOS
Sections transportname
36 ICA Win32 Program Neighborhood Client Configuration Guide
EncryptionLevelSession
Specifies the level of encryption for the ICA connection. Valid values are:
• 1 - Basic
• 2 - RC5 128-bit only while logging on
• 3 - RC5 40-bit
• 4 - RC5 56-bit
• 5 - RC5 128-bit
FindNewApplicationSetIconOff
This parameter specifies whether or not to display the Find New Application Set icon in the Program Neighborhood window. Valid values are:
• On - Icon is displayed
• Off - Icon is not displayed
Value Type Integer
Default Value 1
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Value Type Boolean
Default Value Off
Platforms PN
Sections WFClient
Chapter 3 Parameters 37
Hotkey1..12Char
These parameters specify the keys to use for mapping the various hotkey sequences listed in the Hotkeys tab of the ICA Settings dialog box in the Client UI. Each action is defined by a combination of a character and a shift state. Set the character and shift state parameters equal to “(none)” to disable the hotkey. The hotkey numbers correspond to the following actions:
• 1 - Task List
• 2 - Close Remote Application
• 3 - Toggle Title Bar
• 4 - CTRL-ALT-DEL
• 5 - CTRL-ESC
• 6 - ALT-ESC
• 7 - ALT-TAB
• 8 - ALT-BACKTAB
• 9 - CTRL-SHIFT-ESC
• 10 - Toggle Latency Reduction
Related parameter: HotKey1..10Shift
Value Type String
Default Value N/A
Platforms WinDOS
Sections WFClient
38 ICA Win32 Program Neighborhood Client Configuration Guide
HotKey1..10Shift
Along with Hotkey1..12Char, these parameters specify the key combinations to use for the various hotkey sequences. Valid values are:
• Shift
• Ctrl
• Alt
• (none)
HowManySkipRedrawPerPaletteChange
This parameter specifies the number of consecutive redraw requests to skip before redrawing the screen. See SkipRedrawPerPaletteChange for an explanation.
Value Type String
Default Value N/A
Platforms WinDOS
Sections WFClient
Value Type Integer
Default Value 9
Platforms WinDOS
Sections WFClient
Chapter 3 Parameters 39
ICAPortNumber
This parameter specifies the TCP port to use to connect to the ICA browser. The default port is 1494. You must change the port on all Citrix servers in the farm using the ICAPORT command-line utility before you change this parameter on ICA Clients. Valid values are integers in the range 0–65535 inclusive.
ICASOCKSProtocolVersion
This parameter specifies the version of the SOCKS protocol to use for the connection. Valid values are:
• -1 - None (do not use SOCKS)
• 0 - Auto detect
• 4 - Use SOCKS version 4
• 5 - Use SOCKS version 5
Value Type Integer
Default Value 1494
Platforms WinDOS
Sections WFClient
Value Type Integer
Default Value -1 (do not use SOCKS)
Platforms Win
Sections WFClient
40 ICA Win32 Program Neighborhood Client Configuration Guide
ICASOCKSProxyHost
This parameter specifies the DNS name or IP address of the SOCKS proxy to use.
ICASOCKSProxyPortNumber
This parameter specifies the port number of the SOCKS proxy server. The commonly used port is 1080.
IconIndex
This parameter specifies the index number of the icon to use from the file specified by the IconPath parameter.
Value Type String
Default Value None
Platforms Win
Sections WFClient
Value Type Integer
Default Value None
Platforms Win
Sections WFClient
Value Type Integer
Default Value None
Platforms Win
Sections WFClient
Chapter 3 Parameters 41
IconPath
This parameter specifies the full path and name of the .exe or .dll file containing the icon for the application. Use the IconIndex parameter to specify the icon index number.
InitialProgram
This parameter specifies the initial program to start after making the ICA connection. For server connections, this is the full path and file name. For published applications, this is the name of the published application preceded by the pound (#) symbol.
Related Parameters: LongCommandLine
IpxBrowserAddress
This parameter specifies the IPX address of a Citrix server in the desired server farm.
Value Type String
Default Value %SystemDrive%:\Program Files\Citrix\ICA Client\pn.exe
Platforms Win
Sections WFClient
Value Type String
Default Value None
Platforms WinDOS
Sections WFClient
Value Type String
Default Value None
Platforms WinDOS
Sections WFClient
42 ICA Win32 Program Neighborhood Client Configuration Guide
KeyboardLayout
This parameter specifies the keyboard layout of the ICA Client device. The Citrix server uses the keyboard layout information to configure the ICA session for the client’s keyboard layout. The default value causes the keyboard layout specified in the user profile to be used. This parameter corresponds to the Keyboard Layout option in the General tab of the ICA Settings dialog box.
KeyboardTimer
If this parameter is set to a value that is greater than zero, keystrokes are queued for the number of milliseconds specified. Queuing causes the client to send keyboard updates less frequently to the Citrix server, reducing the number of network packets sent from the ICA Client to the server. Turning off queueing makes the session more responsive to keyboard input. Higher values improve performance when connecting over a RAS connection. The default value is optimized for WAN connections. In a dial-in or LAN environment, reducing this value may give better responsiveness. Using too low a value in a LAN environment may cause a large number of small packets to be generated, which may degrade network performance.
If set to zero, queueing is turned off.
Value Type String
Default Value (User Profile)
Platforms WinDOS
Sections WFClient
Value Type Integer
Default Value 0
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)WFClient (WinDOS)
Chapter 3 Parameters 43
KeyboardType
This parameter specifies the keyboard type of the ICA Client device. The Citrix server uses the keyboard type information to configure the ICA session for the client’s keyboard type. Use the default value for most English and European keyboards. When using a Japanese keyboard, specifying the default will auto-detect the correct keyboard type. This parameter corresponds to the Keyboard Type option in the General tab of the ICA Settings dialog box. See the keyboard types listed for this option for a list of other possible values for this parameter.
LanaNumber
This parameter specifies the LANA number of the network card protocol. This is typically used only for NetBIOS. Valid values are:
• 0 - NetBIOS over NetBEUI (default)
• 1 - IPX
• 2 - TCP
Value Type String
Default Value (Default)
Platforms WinDOS
Sections WFClient
Value Type Integer
Default Value 0
Platforms WinDOS
Sections WFClient
44 ICA Win32 Program Neighborhood Client Configuration Guide
LogApend
This parameter specifies whether a new log file is created or new entries are appended to the end of the existing file. Valid values are:
• On - Append to existing logfile
• Off - Create new logfile (default)
Only applies at start of session.
LogConnect
This parameter specifies whether or not to log connections to and disconnections from Citrix servers. This value corresponds to the Connections and Disconnections option in the Event Logging tab of the ICA Settings dialog box in the ICA Client UI. Valid values are:
• On - Connections and disconnections are logged (default)
• Off - Connections and disconnections are not logged
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
Value Type Boolean
Default Value On
Platforms WinDOS
Sections WFClient
Chapter 3 Parameters 45
LogErrors
This parameter specifies whether or not to log errors with connections to Citrix servers. This value corresponds to the Errors option in the Event Logging tab of the ICA Settings dialog box in the ICA Client UI.
• On - Errors are logged (default)
• Off - Errors are not logged
LogFile
This parameter specifies the name of the ICA DOS Client log file. The log file is generated by the ICA Client at run-time and saved in the ICA Client directory. The types of details logged depends on the values of the LogConnect, LogErrors, LogReceive, and LogTransmit parameters.
Related parameters: LogApend
Value Type Boolean
Default Value On
Platforms WinDOS
Sections WFClient
Value Type File name
Default Value Wfclient.log
Platforms DOS32
Sections WFClient
46 ICA Win32 Program Neighborhood Client Configuration Guide
LogFileGlobalPath
This parameter specifies how log files are created. If on, a single log file is used for all users and stored in the path specified in LogFileWin32. If off, a separate log file is created for each user and stored in the user’s profile directory. In this case, LogFileWin32 should specify only the file name.
LogFileWin16
This parameter specifies the name of the log file on ICA Win16 Clients. The log file is generated by the ICA Client at run-time. The types of details logged depends on the values of the LogConnect, LogErrors, LogReceive, and LogTransmit parameters. Log data can alternately be sent to standard out or standard error by specifying stdout or stderr instead of a file name.
LogFileWin32
This parameter specifies the name of the log file on ICA Win32 Clients. The types of details logged depends on the values of the LogConnect, LogErrors, LogReceive, and LogTransmit parameters. Log data can alternately be sent to standard out or standard error by specifying stdout or stderr instead of a file name.
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
Value Type File name
Default Value wfcwin.log
Platforms Win16
Sections WFClient
Value Type File name
Default Value wfcwin32.log
Platforms Win32
Sections WFClient
Chapter 3 Parameters 47
LogKeyboard
This parameter specifies whether or not to log keystrokes. Use this only as directed by Citrix Technical Support. This value corresponds to the Keyboard and Mouse Data option in the Event Logging tab of the ICA Settings dialog box in the ICA Client UI.
LogReceive
This parameter specifies whether or not to log each packet received from a Citrix server. Use this only as directed by Citrix Technical Support. This value corresponds to the Data Received option in the Event Logging tab of the ICA Settings dialog box in the ICA Client UI. Valid values are:
• On - Packets are logged
• Off - Packets are not logged (default)
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
48 ICA Win32 Program Neighborhood Client Configuration Guide
LogTransmit
This parameter specifies whether or not to log each packet sent to a Citrix server. Use this only as directed by Citrix Technical Support. This value corresponds to the Data Transmitted option in the Event Logging tab of the ICA Settings dialog box in the ICA Client UI.
• On - Packets are logged
• Off - Packets are not logged (default)
LongCommandLine
This parameter allows you to pass a very long string of parameters to the program specified in the InitialProgram parameter. LongCommandLine can be used only when connecting to a MetaFrame XP server. The contents of the LongCommandLine parameter replace any command-line parameters specified at the end of the InitialProgram parameter.
Note To provide LongCommandLine support without breaking compatibility with existing ICA Clients, all lines in the ICA file must be limited to 255 characters. To support longer command lines, you can use a series of LongCommandLine parameters in the following form:LongCommandLine="The beginning of my long command line"
LongCommandLine000="continuation of the long command line"
LongCommandLine001="the rest of the long command line"
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
Value Type String
Default Value None
Platforms Win32
Sections serverentryname
Chapter 3 Parameters 49
Notice that these lines can contain a maximum of 224 characters between quotation marks.The ICA Client engine concatenates these entries to create a single long command line parameter. An .ica file can include as many LongCommandLine entries as necessary.
MaximumCompression
This parameter specifies whether or not to use maximum data compression. Data compression reduces the amount of data that needs to be transferred but requires additional processing on both the ICA Client and Citrix server to compress and decompress the data. Enabling data compression increases performance over bandwidth-limited connections.
This parameter is also used in application sets. Valid values are:
On - Data compression is enabled
Off - Data compression is disabled (default)
Value Type Boolean
Default Value Off
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)WFClient (WinDOS)
50 ICA Win32 Program Neighborhood Client Configuration Guide
MouseTimer
If this parameter is set to a value that is greater than zero, mouse event updates are queued for the number of milliseconds specified. Queuing causes the client to send mouse updates less frequently to the Citrix server. Check this option in the user interface to reduce the number of network packets sent from the ICA Client to the Citrix server. Leaving this option unchecked makes the session more responsive to mouse movements. Checking this option improves performance if you dial in to RAS and then use a network to connect.
The default value is optimized for WAN connections. In a dial-in or LAN environment, reducing this value may give better responsiveness. Using too low a value in a LAN environment may cause a large number of small packets to be generated, which can degrade network performance.
NameEnumerator
This parameter specifies the file name of the module to load for server name enumeration. Default values are determined by the platform and protocol, as listed below:
For TCP
NameEnumeratorWin16 = NETCPW.DLL
NameEnumeratorWeb16 = NEHTTPW.DLL
Value Type Integer
Default Value 100
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)WFClient (WinDOS)
Value Type File name
Default Value This depends on the platform & the protocol. See below for more details.
Platforms WinDOS
Sections transportname
Chapter 3 Parameters 51
NameEnumeratorWin32 = NETCPN.DLL
NameEnumeratorWeb32 = NEHTTPN.DLL
For SPX/IPX
NameEnumerator = NEIPX.DDL
NameEnumeratorWin16 = NEIPXW.DLL
NameEnumeratorWin32 = NEIPXN.DLL
For NetBios
NameEnumerator = NENETB.DDL
NameEnumeratorWin16 = NENETBW.DLL
NameEnumeratorWin32 = NENETBN.DLL
For TCP/FTP
NameEnumerator = NETCPFTP.DDL
TCP/IP - Novell Lan WorkPlace
NameEnumerator = NETCPNOV.DDL
TCP/IP - Microsoft
NameEnumerator = NETCPMS.DDL
TCP/IP - VSL
NameEnumerator = NENUM.DDL
NameResolver
This parameter specifies the file name of the module to load for name-to-address resolution.
Value Type File name
Default Value None
Platforms WinDOS
Sections transportname
52 ICA Win32 Program Neighborhood Client Configuration Guide
NetBiosBrowserAddress
This parameter specifies the server name or NetBIOS address to use to locate the ICA Master Browser.
NoAutoDetectProtocol
This parameter specifies whether or not to auto-detect the network protocol to use. When the value is “Off,” Program Neighborhood automatically detects a protocol. When the value is “On,” it uses the transport driver specified in TransportDriver. Valid values are:
• On - Auto detection is enabled (default)
• Off - Auto detection is disabled
Value Type String
Default Value N/A
Platforms WinDOS
Sections WFClient
Value Type Boolean
Default Value On
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Chapter 3 Parameters 53
NoDeskInt
This parameter specifies whether or not to enable Desktop Integration. Desktop Integration adds icons to the Windows desktop and Start menu. This does not recreate icons removed from the Windows desktop or Start menu by the user. Valid values are:
• On - Desktop integration is enabled
• Off - Desktop integration is disabled (default)
Password
This parameter specifies the password to use when refreshing the specified application set. If specified, the password must be encrypted. To obtain the encrypted password when creating a custom .ini file, create a new entry using the ICA Client and then copy the encrypted password stored for the new entry in the Appsrv.ini file. If the user is not already authenticated to the application set, the value is left blank.
Value Type Boolean
Default Value Off
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Value Type String
Default Value None
Platforms WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
54 ICA Win32 Program Neighborhood Client Configuration Guide
PersistentCacheEnabled
This parameter specifies whether or not to use the persistent disk cache. The persistent disk cache stores commonly used graphical objects such as bitmaps on the client device’s hard disk. Valid values are:
• On - The persistent cache is enabled
• Off - The persistent cache is disabled (default)
Enabling caching increases performance across bandwidth-limited connections. If the client is on a high-speed LAN, disable caching to save disk space. Disk caching is enabled by default for Dial-in connections. This parameter is set by the Use disk cache for bitmaps option in the ICA Client UI.
PersistentCacheGlobalPath
This parameter specifies what type of cache directory is used. If on, a single cache directory is used for all users and located in the path specified in PersistentCachePath. If off, a separate cache directory is created for each user and stored in the user’s profile directory. In this case, PersistentCachePath specifies only the directory name.
Value Type Boolean
Default Value Off
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)WFClient (WinDOS)
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
Chapter 3 Parameters 55
PersistentCacheMinBitmap
This parameter specifies the minimum size in bytes of bitmaps to store in the persistent disk cache
PersistentCachePath
This parameter specifies the location of the persistent disk cache.
PersistentCacheSize
This parameter specifies the size of the persistent disk cache in bytes.
Value Type Integer
Default Value 8192
Platforms WinDOS
Sections WFClient
Value Type String
Default Value C:\Documents and Settings\username\Application Data\ICAClient\Cache
Platforms WinDOS
Sections WFClient
Value Type Integer
Default Value None
Platforms WinDOS
Sections WFClient
56 ICA Win32 Program Neighborhood Client Configuration Guide
PersistentCachePercent
This parameter specifies the percentage of hard drive space to use for the persistent disk cache. This parameter corresponds to the Amount of disk space to use option in the Bitmap Cache tab of the ICA Settings dialog box. When this parameter is changed using Program Neighborhood, PersistentCacheSize is recomputed based on PersistentCachePercent and the total size of the hard drive specified for the bitmap cache directory (PersistentCachePath). Valid values are any integer from 1 to 100 inclusive.
PingServer
This parameter specifies whether to transmit an ICMP packet in advance of sending a UDP broadcast to the first entry in the Server Location address list. Use PingServer when a client cannot contact a Citrix server across an ATM network initially, but successfully connects on the second attempt. Valid values are:
• On - An ICMP packet is transmitted
• Off - An ICMP packet is not transmitted (default)
Note The ICMP packet is sent only to the first address in the Server Location address list.
Value Type Integer
Default Value 1
Platforms WinDOS
Sections WFClient
Value Type Boolean
Default Value Off
Platforms Win32/Win16
Sections WFClient
Chapter 3 Parameters 57
PNCacheRefresh
This parameter specifies whether or not to automatically refresh the list of applications available in the application set the next time Program Neighborhood is run. Valid values are:
• On - Application list is refreshed
• Off - Application list is not refreshed (default)
PNName
This parameter specifies the display name for the application set.
Note Do not manually change this parameter.
Value Type Boolean
Default Value Off
Platforms PN
Sections applicationsetname
Value Type String
Default Value None
Platforms PN
Sections applicationsetname
58 ICA Win32 Program Neighborhood Client Configuration Guide
PNUIShowTB
This parameter specifies whether or not to display the Program Neighborhood toolbar. PNUIShowTB corresponds to the View|Toolbars|Standard Buttons menu item in the Program Neighborhood window. Valid values are:
• 1 - The toolbar is displayed (default)
• 2 - The toolbar is not displayed
PNUIShowTBText
This parameter specifies whether or not to display text labels for the Program Neighborhood toolbar. This parameter corresponds to the View|Toolbars|Text Labels menu item in the Program Neighborhood window. Valid values are:
• 1 - Text labels are displayed
• 2 - Text labels are not displayed
Note If the toolbar is not displayed, this parameter has no effect. See PNUIShowTB for displaying the toolbar.
Value Type Integer
Default Value 1
Platforms PN
Sections WFClient
Value Type Integer
Default Value 1
Platforms PN
Sections WFClient
Chapter 3 Parameters 59
PNUIShowSB
This parameter specifies whether or not to display the Program Neighborhood status bar. This parameter corresponds to the View|Status Bar menu item in the Program Neighborhood window. Valid values are:
• 1 - The status bar is displayed
• 2 - The status bar is not displayed
PNUIViewType
This parameter specifies the view options for the Program Neighborhood window. Valid values are:
• 40028 - Large icons
• 40029 - Small icons
• 40030 - List
• 40031 - Details
PNUIViewType corresponds to the options on the View menu in Program Neighborhood.
Value Type Integer
Default Value 1
Platforms PN
Sections WFClient
Value Type Integer
Default Value 40028 (large icons)
Platforms PN
Sections WFClient
60 ICA Win32 Program Neighborhood Client Configuration Guide
PNUINoAutoSearch
This parameter specifies whether or not the ICA Client should automatically search the network for application sets and add them to the list in the Program Neighborhood window.
By default, PNUINoAutoSearch is set to Off until Program Neighborhood is first run. Program Neighborhood then performs the search and changes the value of the parameter to On so that the search is not automatically performed again. Users can manually perform a search by double-clicking the Find New Application Set icon.
PNUIHPos
This parameter specifies the horizontal position of the Program Neighborhood window. The value is the distance, in pixels, of the left edge of the Program Neighborhood window from the left edge of the Windows desktop.
Value Type Boolean
Default Value (see description)
Platforms PN
Sections WFClient
Value Type Integer
Default Value 96
Platforms PN
Sections WFClient
Chapter 3 Parameters 61
PNUIVPos
This parameter specifies the vertical position of the Program Neighborhood window. The value is the distance, in pixels, of the top edge of the Program Neighborhood window from the top edge of the Windows desktop.
PNUIWidth
This parameter specifies the width, in pixels, of the Program Neighborhood window.
PNUIHeight
This parameter specifies the height, in pixels, of the Program Neighborhood window.
Value Type Integer
Default Value 71
Platforms PN
Sections WFClient
Value Type Integer
Default Value 576
Platforms PN
Sections WFClient
Value Type Integer
Default Value 429
Platforms PN
Sections WFClient
62 ICA Win32 Program Neighborhood Client Configuration Guide
PNDefault
This parameter specifies the default application set.
PreferTw1
This parameter specifies whether or not to use ICA Display version 1 compatibility mode. This parameter overrides the server-side preference. Valid values are:
• On - ICA Display version 1 compatibility mode is used
• Off - ICA Display version 1 compatibility mode is not used (default)
Note Older versions of the ICA Client that do not support ICA Display version 2 always use version 1, regardless of the value of this parameter.
Value Type String
Default Value None
Platforms PN
Sections WFClient
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections ThinWire3.0
Chapter 3 Parameters 63
ProtocolSupport
This parameter specifies the list of protocol drivers to load, in order. The list contains the section names that describe each specific protocol driver. Protocol drivers in this list that are not listed in the ProtocolSupport parameter of the WinStation driver section are not loaded. Flags within this section can be used to optionally select a particular driver.
Interrupt & COM Sections
ProtocolSupport = Modem, Frame, Reliable, Encrypt, Compress
IPX
ProtocolSupport = Reliable, Encrypt, Compress
SPX
ProtocolSupport = Encrypt, Compress
TCP/IP
ProtocolSupport = RFrame, Encrypt, Compress
NetBios
ProtocolSupport = Encrypt, Compress
TCP/IP - FTP
ProtocolSupport = RFrame, Encrypt, Compress
TCP/IP - Novell Lan WorkPlace
ProtocolSupport = RFrame, Encrypt, Compress
TCP/IP - Microsoft
ProtocolSupport = RFrame, Encrypt, Compress
TCP/IP - VSL
ProtocolSupport = RFrame, Encrypt, Compress
Value Type File name
Default Value Depends on protocol being used (see below).
Platforms WinDOS
Sections transportnamewinstationdrivername
64 ICA Win32 Program Neighborhood Client Configuration Guide
ICA 3.0
ProtocolSupport = Modem, RFrame, Frame, Reliable, Encrypt, Compress
Reducer
Warning Fixed value. Do not change.
ReducerWin16
Warning Fixed value. Do not change.
ReducerWin32
Warning Fixed value. Do not change.
Value Type File name
Default Value ICAREDU.DDL
Platforms DOS
Sections winstationdrivername
Value Type File name
Default Value ICAREDUW.DLL
Platforms Win16
Sections winstationdrivername
Value Type File name
Default Value ICAREDUN.DLL
Platforms Win32
Sections winstationdrivername
Chapter 3 Parameters 65
Reliable
This parameter specifies the flag associated with the Reliable protocol driver. If Reliable is set to on and Reliable is in the ProtocolSupport list, the Reliable protocol driver is loaded. Valid values are:
• On - See description (default)
• Off - Reliable protocol driver is not loaded
SavePNPassword
This parameter specifies whether or not to save the password for the entry. The password is saved in a dynamically created .vl file that is stored in the following path: <profile path>\Application Data\ICAClient. If this parameter is set to “Off,” the size of the .vl file is zero bytes. This parameter corresponds to the Save Password check box in Program Neighborhood. Valid values are:
• On - Password is saved
• Off - Password is not saved (default)
Value Type Boolean
Default Value On
Platforms WinDOS
Sections transportname
Value Type Boolean
Default Value Off
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WInDOS)
66 ICA Win32 Program Neighborhood Client Configuration Guide
ScreenPercent
If DesiredWinType is set to 5, this parameter is used to specify the size of the ICA session as a percentage of total screen size. Valid values are integers from 1 through 100 inclusive.
serverentryname
The ApplicationServers section contains an entry for each configured connection. For each name in this list, there is a section containing parameters for the connection.
SkipRedrawPerPaletteChange
This parameter specifies whether or not to skip redrawing the screen after a palette change. If this parameter is enabled, HowManySkipRedrawPerPaletteChange specifies how many palette changes are skipped before each redraw. Use this only as directed by Citrix Technical Support.
Value Type Integer
Default Value 0
Platforms PN, Win
Sections applicationsetname (PN)serverentryname (WinDOS)WFClient
Value Type N/A
Default Value N/A
Platforms WinDOS
Sections ApplicationServers
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
Chapter 3 Parameters 67
SSOnUserSetting
This parameter enables the ability to use local user name, password, and domain name to log on to ICA sessions using Program Neighborhood. You must choose to use this feature when installing the ICA Win32 Client for this parameter to have an effect. This parameter corresponds to the Use local username and password for logon check box in the General tab of the ICA Settings dialog box.
Related parameters: EnableSSOnThruICAFile, UseLocalUserAndPassword
SwapButtons
This parameter specifies whether to swap the function of the ICA Client device’s mouse buttons within the ICA session. Valid values are:
• On - Button functions are swapped
• Off - Button functions are not swapped (default)
Value Type Boolean
Default Value N/A
Platforms PN
Sections WFClient
Value Type Boolean
Default Value Off
Platforms WinDOS
Sections WFClient
68 ICA Win32 Program Neighborhood Client Configuration Guide
TcpBrowserAddress
This parameter specifies the TCP/IP name or address of a Citrix server in the desired server farm. A valid value is an IP name or number.
TransportDriver
This parameter specifies the transport protocol to use to connect to the specified connection or application set. This name must correspond to one of the transport drivers specified in the TransportDriver section of Module.ini. This is usually “TCP/IP,” but can also be “IPX,” “SPX,” or “NetBIOS.”
TWIMode
This parameter specifies whether to use Seamless mode for all connections in the specified application set. Set the parameters DesiredVRES, DesiredHRES, and DesiredWinType accordingly.
Value Type String
Default Value None
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)WFClient (WinDOS)
Value Type String
Default Value None
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Value Type Boolean
Default Value Off
Platforms PN, WinDOS
Sections applicationsetname (PN)
Chapter 3 Parameters 69
UpdatesAllowed
This parameter specifies whether or not to allow client updates. This parameter is set by the Allow automatic client updates option in the ICA Client UI. Valid values are:
• On - Updates are permitted (default)
• Off - Updates are not permitted
UseAlternateAddress
This parameter is useful in performing Network Address Translation (NAT). If set to 1, it defines whether to use the alternate address for ICA connectivity across a firewall or a router. Firewalls use IP address translation to convert public (Internet) IP addresses into private (intranet) IP addresses. Public IP addresses are called “external” addresses because they are external to the firewall, while private IP addresses are called “internal” addresses.
When an ICA Client is configured for TCP/IP server location, it sends a directed UDP datagram to the server location IP address using TCP/IP port 1604. For communication to be successful between the ICA Client and a Citrix server with an intervening firewall, the firewall must be configured so it will pass UDP port 1604 packets. Server location is configured in the ICA Client by selecting Settings from the Options menu.
Value Type Boolean
Default Value On
Platforms WinDOS
Sections WFClient
Value Type Boolean
Default Value 0
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)Wfclient.ini (WinDOS)
70 ICA Win32 Program Neighborhood Client Configuration Guide
If a fixed server location address is specified, the ICA Client contacts that server to determine the address of the ICA Master Browser. When the ICA Client connects by server or published application name, the ICA Master Browser returns the address of the desired server or published applications.
If UseAlternateAddress=1 is specified, the client requests the IP address of the Citrix server’s alternate address. UseAlternateAddress can be used only for TCP/IP connections. You must specify the IP address of the Citrix server that is configured for server location by including the statement TcpBrowserAddress=ipaddress in the [WFClient] section of the ICA file, where ipaddress is the IP address of the Citrix server; for example, 123.321.234.23. You must also use the ALTADDR command on the Citrix server with IP address ipaddress that is accessed by the ICA file.
See the MetaFrame Administrator’s Guide for more information about the ALTADDR command.
UseDefaultEncryption
This parameter specifies whether or not to use the Custom Default encryption setting for the specified custom connection. This value corresponds to the Use Custom Default option in the Options tab of the Properties dialog box for custom connections. Valid values are:
• On - Custom Default encryption setting is used
• Off - Custom Default encryption setting is not used (default)
Value Type Boolean
Default Value Off
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Chapter 3 Parameters 71
UseDefaultSound
This parameter specifies whether or not to use the Custom Default sound setting for the specified custom connection. This value corresponds to the Use Custom Default option in the Options tab of the Properties dialog box for custom connections. Valid values are:
• On - Custom Default sound setting is used (default)
• Off - Custom Default sound setting is not used
UseDefaultWinColor
This parameter specifies whether or not to use the Custom Default color setting for the specified custom connection. This value corresponds to the Use Custom Default option in the Options tab of the Properties dialog box for custom connections. Valid values are:
• On - Custom Default color setting is used
• Off - Custom Default color setting is not used (default)
Value Type Boolean
Default Value On
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Value Type Boolean
Default Value Off
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
72 ICA Win32 Program Neighborhood Client Configuration Guide
UseDefaultWinSize
This parameter specifies whether or not to use the Custom Default window size setting for the specified custom connection.This value corresponds to the Use Custom Default option in the Options tab of the Properties dialog box for custom connections. Valid values are:
• On - Custom Default window size setting is used
• Off - Custom Default window size setting is not used (default)
UseLocalUserAndPassword
This parameter specifies whether or not to use the same user name and password that the user used to log on to the client computer as the user name and password for the application set or custom connection. This parameter corresponds to the Use local username and password option on the Login Information tab of the application set and custom connection Properties dialog boxes. SSOnUserSetting must be “On” for this to work. Valid values are:
• On - Use same user name and password (default)
• Off - Do not use same user name and password
Related Parameters: EnableSSOnThruICAFile, SSOnUserSetting.
Value Type Boolean
Default Value Off
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Value Type Boolean
Default Value On
Platforms PN
Sections applicationsetnameserverentryname
Chapter 3 Parameters 73
Username
This parameter specifies the user name to use when refreshing the specified application set or connecting to a published application or server. If the user is not already authenticated, the value is left blank.
Version
Warning Fixed value. Do not change.
VirtualDriver
This parameter specifies a list of virtual drivers to load, in sequence. The listed items correspond to section names containing parameters for each specific virtual driver. Individual features can be disabled by removing their drivers from this list (for example, remove ClientDrive to disable client drive mapping).
Value Type String
Default Value None
Platforms PN, WinDOS
Sections applicationsetname (PN)serverentryname (WinDOS)
Value Type Integer
Default Value 2
Platforms WinDOS
Sections WFClient
Value Type String
Default Value None
Platforms WinDOS
Sections winstationdrivername
74 ICA Win32 Program Neighborhood Client Configuration Guide
winstationdrivername
This parameter specifies the name of the WinStation driver to use. The name corresponds to a name in the Module.ini file. This is usually “ICA 3.0.”
ZLKeyboardMode
This parameter specifies whether or not to use local text echo. Valid values are:
• 0 - Always off
• 1 - Always on
• 2 - Auto (see description)
For auto, local text echo is used if the connection latency exceeds the high latency threshold set using the SpeedScreen Latency Reduction Manager. The Citrix server must support SpeedScreen Latency Reduction for this setting to have any effect.
Value Type String
Default Value None
Platforms WinDOS
Sections serverentryname
Value Type Integer
Default Value 0 (always off)
Platforms Win
Sections applicationsetname (PN)serverentryname (WinDOS)
Chapter 3 Parameters 75
ZLMouseMode
This parameter specifies whether or not to use mouse click feedback. Valid values are:
• 0 - Always off
• 1 - Always on
• 2 - Auto (see description)
For auto, mouse click feedback is used if the connection latency exceeds the high latency threshold set using the SpeedScreen Latency Reduction Manager. The Citrix server must support SpeedScreen Latency Reduction for this setting to have any effect.
Value Type Integer
Default Value 2 (Auto)
Platforms Win
Sections applicationsetname (PN)serverentryname (WinDOS)
A P P E N D I X A
License Agreement
This is a legal agreement (AGREEMENT) between you, the licensed user or the authorized representative of the licensed user, and Citrix Systems, Inc. (CITRIX). BY DOWNLOADING, INSTALLING, COPYING OR OTHERWISE USING THE ATTACHED SOFTWARE DEVELOPMENT KIT, YOU ARE INDICATING THAT YOU ARE AUTHORIZED TO BIND THE LICENSED USER IN CONTRACT AND THAT THE LICENSED USER ACCEPTS THE TERMS OF THIS AGREEMENT. IF YOU, AS THE LICENSED USER OR REPRESENTATIVE OF THE LICENSED USER DO NOT AGREE TO THE TERMS OF THIS AGREEMENT, DO NOT DOWNLOAD, INSTALL, COPY OR OTHERWISE USE THE CITRIX SOFTWARE DEVELOPMENT KIT.
1. GRANT OF LICENSE. The CITRIX software development kit includes certain example source code, tools, utilities, program interfaces and text files (collectively called the “SOFTWARE DEVELOPMENT KIT”) to software that provides services on a computer called a server (“Server Software”) and software that allows a computer to access or utilize the services provided by the Server Software (“Client Software”). CITRIX grants to the licensed user the following limited, non-exclusive and non-transferable rights to the SOFTWARE DEVELOPMENT KIT and accompanying documentation downloaded or otherwise obtained from Citrix:
1. Installation and Transfer. The licensed user may install one copy of the SOFTWARE DEVELOPMENT KIT on a single computer owned by the licensed user. The licensed user may transfer the SOFTWARE DEVELOPMENT KIT to any other computer of the licensed user, provided that it is removed from the computer from which it is transferred. The licensed user may make one (1) copy of the SOFTWARE DEVELOPMENT KIT in machine-readable form solely for backup purposes, provided that the licensed user reproduces all proprietary notices on the copy.
2. Use of the SOFTWARE DEVELOPMENT KIT. The licensed user may use the SOFTWARE DEVELOPMENT KIT and accompanying documentation solely to develop applications that access or utilize the Server Software.
78 ICA Win32 Program Neighborhood Client Configuration Guide
3. Export Notice. The licensed user may not export or re-export the SOFTWARE DEVELOPMENT KIT in any form without the appropriate United States and foreign government licenses. The licensed user is responsible for maintaining the security of the environment in which the SOFTWARE DEVELOPMENT KIT is used. None of the SOFTWARE DEVELOPMENT KIT or underlying information or technology may be exported or re-exported (i) into (or to a national or resident of) Cuba, Iraq, Libya, Sudan, North Korea, Iran, Syria or any other country to which the United States has embargoed goods; or (ii) to anyone on the U.S. Treasury Department's list of Specially Designated Nationals or the U.S. Commerce Department's Table of Denial Orders. By installing or using the SOFTWARE DEVELOPMENT KIT, the licensed user is agreeing to the foregoing and is representing and warranting that such licensed user is not located in, under the control of, or a national or resident of any such country or on any such list. In addition, the licensed user is responsible for complying with any local laws in such licensed user’s jurisdiction which may impact such licensed user’s right to import, export or use the SOFTWARE DEVELOPMENT KIT.
4. If the SOFTWARE DEVELOPMENT KIT is identified as a North American or not-for-export product (for example, on the box, media or in the installation process), then, unless the licensed user has an exemption from the United States Department of State, the following applies: EXCEPT FOR EXPORT TO CANADA FOR USE IN CANADA BY CANADIAN CITIZENS, THE SOFTWARE DEVELOPMENT KIT AND ANY UNDERLYING TECHNOLOGY MAY NOT BE EXPORTED OUTSIDE THE UNITED STATES OR TO ANY FOREIGN ENTITY OR "FOREIGN PERSON" AS DEFINED BY U.S. GOVERNMENT REGULATIONS, INCLUDING WITHOUT LIMITATION, ANYONE WHO IS NOT A CITIZEN, NATIONAL OR LAWFUL PERMANENT RESIDENT OF THE UNITED STATES. BY DOWNLOADING OR USING THE SOFTWARE DEVELOPMENT KIT, THE LICENSED USER IS AGREEING TO THE FOREGOING AND THE LICENSED USER IS WARRANTING THAT SUCH LICENSED USER IS NOT A "FOREIGN PERSON" OR UNDER THE CONTROL OF A "FOREIGN PERSON."
5. Other. Notice to Users — The licensed user shall inform all users of the SOFTWARE DEVELOPMENT KIT of the terms and conditions of this AGREEMENT. Not For Resale Software - If the SOFTWARE DEVELOPMENT KIT is labeled “Not For Resale” or “NFR,” this license only permits use for demonstration, test, or evaluation purposes.
Appendix A License Agreement 79
2. DESCRIPTION OF OTHER RIGHTS AND LIMITATIONS. The licensed user may not rent, lease, sublicense, assign or otherwise transfer or distribute the SOFTWARE DEVELOPMENT KIT. The licensed user may not modify, translate, reverse engineer, decompile, or disassemble or copy (except for the backup copy of the SOFTWARE DEVELOPMENT KIT) any part of the SOFTWARE DEVELOPMENT KIT, except to the extent such foregoing restriction is expressly prohibited by applicable law. The licensed user may not remove any proprietary notices, labels, or marks on the SOFTWARE DEVELOPMENT KIT and accompanying documentation.
THE LICENSED USER MAY NOT USE, COPY, MODIFY, OR TRANSFER THE SOFTWARE DEVELOPMENT KIT OR ANY COPY IN WHOLE OR IN PART, OR GRANT ANY RIGHTS IN THE SOFTWARE DEVELOPMENT KIT OR ACCOMPANYING DOCUMENTATION, EXCEPT AS EXPRESSLY PROVIDED IN THIS LICENSE. ALL RIGHTS NOT EXPRESSLY GRANTED ARE RESERVED BY CITRIX OR ITS SUPPLIERS.
MAINTENANCE. Citrix is not obligated to provide maintenance, updates or any other support to the licensed user with respect to the SOFTWARE DEVELOPMENT KIT and accompanying documentation licensed under this AGREEMENT.
DISCLAIMER OF WARRANTY. THE SOFTWARE DEVELOPMENT KIT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, CITRIX AND ITS SUPPLIERS FURTHER DISCLAIM ALL WARRANTIES OR CONDITIONS, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT, TITLE, AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK ARISING OUT OF THE USE OR PERFORMANCE OF THE SOFTWARE DEVELOPMENT KIT AND ACCOMPANYING DOCUMENTATION REMAINS WITH RECIPIENT. CITRIX does not warrant that the SOFTWARE DEVELOPMENT KIT will be uninterrupted or error free.
SOME STATES DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES SO THE ABOVE EXCLUSIONS MAY NOT APPLY TO THE LICENSED USER. THIS WARRANTY GIVES THE LICENSED USER SPECIFIC LEGAL RIGHTS. THE LICENSED USER MAY ALSO HAVE OTHER RIGHTS WHICH VARY FROM STATE TO STATE.
PROPRIETARY RIGHTS. This license is not a sale. Title and copyrights to the SOFTWARE DEVELOPMENT KIT and accompanying documentation and any copy made by the licensed user remain with CITRIX or its suppliers.
80 ICA Win32 Program Neighborhood Client Configuration Guide
LIMITATION OF LIABILITY. IN NO EVENT WILL CITRIX OR ITS SUPPLIERS BE LIABLE FOR ANY DAMAGES WHATSOEVER, INCLUDING, WITHOUT LIMITATION, LOSS OF DATA, LOSS OF INCOME, LOSS OF OPPORTUNITY OR PROFITS, BUSINESS INTERRUPTION, COST OF RECOVERY OR OTHER PECUNIARY LOSS OR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING FROM THE USE OF THE SOFTWARE DEVELOPMENT KIT, REFERENCE MATERIALS OR ACCOMPANYING DOCUMENTATION OF THE SOFTWARE DEVELOPMENT KIT, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY. THIS LIMITATION WILL APPLY EVEN IF CITRIX, ITS SUPPLIERS OR AUTHORIZED DISTRIBUTORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
SOME STATES DO NOT ALLOW THE LIMITATION OR EXCLUSION OF LIABILITY FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THE ABOVE LIMITATION OR EXCLUSION MAY NOT APPLY TO THE LICENSED USER.
TERMINATION. This AGREEMENT is effective until terminated. The licensed user may terminate this AGREEMENT at any time by removing the SOFTWARE DEVELOPMENT KIT from such licensed user’s computer and destroying all copies of it. Unauthorized copying of the SOFTWARE DEVELOPMENT KIT or otherwise failing to comply with the terms and conditions of this AGREEMENT will result in automatic termination of this license and will make available to CITRIX other legal remedies. Upon termination of this AGREEMENT, the license granted herein will terminate and the licensed user must immediately destroy the SOFTWARE DEVELOPMENT KIT and all backup copies thereof.
GOVERNMENT END-USERS. The SOFTWARE DEVELOPMENT KIT and accompanying documentation are “commercial items,” developed exclusively at private expense, consisting of “commercial computer software” and “commercial computer software documentation” as such terms are defined in the applicable acquisition regulations. If the SOFTWARE DEVELOPMENT KIT and the documentation are licensed hereunder for distribution to Government End-Users, such SOFTWARE DEVELOPMENT KIT and documentation are licensed (i) only as a commercial item, and (ii) with only those rights as are granted to all other end users pursuant to the terms and conditions of this Agreement. If this Agreement fails to meet a Government End-User’s minimum needs or is inconsistent with Federal Procurement law, the licensed user agrees to notify Citrix. The following additional statement applies only to procurements governed by DFARS Subpart 227.4 (1988): “Restricted Rights Use, duplication and disclosure by the Government is subject to restrictions set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 (1988).”
Appendix A License Agreement 81
This AGREEMENT will be governed by the laws of the State of Florida, without reference to conflict of laws principles. In any dispute arising out of this AGREEMENT, the licensed user and CITRIX each consent to the exclusive personal jurisdiction and venue in the State and Federal courts within Broward County, Florida. If either Citrix or the licensed user employs attorneys to enforce any rights arising out of or relating to this Agreement, the prevailing party shall be entitled to recover reasonable attorneys’ fees and expenses.
Should you have any questions concerning this AGREEMENT, or if you desire to contact Citrix Systems, Inc. for any reason, please write: Citrix Systems, Inc., Customer Service, 6400 Northwest Sixth Way, Fort Lauderdale, Florida, 33309.