Determines if the system on which this extender was loaded has various Citrix-related functionality enabled.
wtsIsCitrixEnabled(Request)
(i) request: This is a number that identifies what Citrix API function library availability information is to be returned. The following values are valid:
0 = Citrix Client WFAPI presence
1 = Citrix Server Application Publishing API presence
2 = Citrix Server Session Monitoring & Control API presence
3 = Citrix Client Virtual Channel presence
(i) Returns @TRUE if the requested Citrix API library is present/enabled, or @FALSE if the component is missing or not enabled.
This function is used to determine if Citrix related API libraries are present and enabled on the current system. The presence or absence of any particular type of Citrix API function library is determined based on whether or not the appropriate API function library DLL can be loaded into memory. The presence or absence of these API function libraries then dictates which of the wtsCitrix*() functions in this extender can or cannot be used.
It is advisable to call this function first in a script that uses the wtsCitrix*() functions as this function is the only safe way to find out if the the required Citrix functionality is not present. Attempting to call any of the wtsCitrix*() functions [except for wtsIsCitrixEnabled()] when the required Citrix functionality is not present will result in an error being generated in the script that made the wtsCitrix*() function call.
The following DLLs are tested to determine the presence/absence of Citrix-related API function libraries:
WFAPI.DLL - Citrix Client WFAPI. This DLL will be present in a Citrix Session.
APSDK.DLL - Citrix Server Application Publishing API. This DLL will be present only on Citrix servers running MetaFrame v1.8 SP3, or on MetaFrame XP systems with the appropriate hot fix installed. All of the wtsCitrix*() functions that work with Citrix farms, published applications and application folders are dependent upon this API library being present.
CTXSMCAPI.DLL - Citrix Server Session Monitoring & Control API. This DLL be present only on Citrix servers running MetaFrame XP Feature Release 2 & newer. All of the wtsCitrix*() functions that work with session monitoring are dependent upon this API library being present.
If the Citrix Client Virtual Channel is present then the wts*() functions that support enhanced communication between the Citrix session and the Citrix client system can be used safely.
Example:
;Load 32-bit or 64-bit extender AddExtender( "WWWTS44I.DLL" , 0, "WWWTS64I.DLL" )
Title01 = 'Test wtsIsCitrixEnabled()' For option = 0 To 3 ErrorMode(@OFF) Result = wtsIsCitrixEnabled(option) RC = LastError() ErrorMode(@CANCEL) TempMsg = StrCat('wtsIsCitrixEnabled() OPTION = ',option,@CRLF,'RC = ',RC,@CRLF) TempMsg = StrCat(TempMsg,@CRLF,@CRLF,'Result = ',Result) Message(Title01,TempMsg) Next Exit