| AnyConnect Secure Mobility Client 5.1.16.194

Macros | Enumerations
api.h File Reference
`#include "GlobalEnums.h"`

Go to the source code of this file.

## Macros
#define | UNICODE
#define | _UNICODE
#define | tstring std::wstring
#define | tostream std::wostream
#define | VPN_VPNAPI __declspec(dllimport)
#define | OUT
#define | IN

## Enumerations
enum | MessageType { MsgType_Error, MsgType_Alert, MsgType_Warn, MsgType_Info, MsgType_Status, MsgType_UrlError, MsgType_Announcement, MsgType_Ephemeral_Alert, MsgType_Critical }
enum | SDITokenType { SDITT_NONE, SDITT_HARDWARE, SDITT_SOFTWARE }
enum | VPNState { CONNECTED = STATE_CONNECTED, DISCONNECTED = STATE_DISCONNECTED, CONNECTING = STATE_CONNECTING, DISCONNECTING = STATE_DISCONNECTING, RECONNECTING = STATE_RECONNECTING, PAUSING = STATE_PAUSING, PAUSED = STATE_PAUSED, SSOPOLLING = STATE_SSOPOLLING, UNKNOWN = ~0 }
enum | VPNSubState { VPNSS_NORMAL = VCSS_NORMAL, VPNSS_INDEFINITE_DELAY = VCSS_INDEFINITE_DELAY, VPNSS_SESSION_EXPIRING = VCSS_SESSION_EXPIRING, VPNSS_MT_DISCONNECTED_DISABLED = VCSS_MT_DISCONNECTED_DISABLED, VPNSS_MT_DISCONNECTED_TRUSTED_NW = VCSS_MT_DISCONNECTED_TRUSTED_NW, VPNSS_MT_DISCONNECTED_USER_TUNNEL_ACTIVE = VCSS_MT_DISCONNECTED_USER_TUNNEL_ACTIVE, VPNSS_MT_DISCONNECTED_LAUNCH_FAILED = VCSS_MT_DISCONNECTED_LAUNCH_FAILED, VPNSS_MT_DISCONNECTED_CONNECT_FAILED = VCSS_MT_DISCONNECTED_CONNECT_FAILED, VPNSS_MT_DISCONNECTED_BAD_VPN_CONFIG = VCSS_MT_DISCONNECTED_BAD_VPN_CONFIG, VPNSS_MT_DISCONNECTED_SW_UP_PENDING = VCSS_MT_DISCONNECTED_SW_UP_PENDING, VPNSS_MTU_ADJUSTMENT_PENDING = VCSS_MTU_ADJUSTMENT_PENDING }
enum | VPNDisconnectReason { UserRequestedDisconnect, ApplicationTermination }
enum | WMHint { MINIMIZE, OPEN, QUIT, REFRESHHOSTNAMES, REFRESHPREFS, SHOWCONNECTING, CLOSECREDENTIALPOPUP }
enum | WMHintReason { SECONDGUISTART, PROXYREQUEST, SERVICEFAILURE, DISCONNECT, SERVICESTOPPED, CONNECT, REASONUNKNOWN }
enum | ConnectPromptType { CERTIFICATE, CREDENTIALS, PROXY, MANUAL_PKCS12_IMPORT, STATUS, SINGLESIGNON, SINGLELOGOUT, LEGACY_SINGLESIGNON }
enum | PromptType { Prompt_Input, Prompt_Password, Prompt_Banner, Prompt_Combo, Prompt_Header, Prompt_Hidden, Prompt_CheckBox, Prompt_SSO }
enum | PreferenceId { ServiceDisable, CertificateStoreOverride, CertificateStore, CertificateStoreMac, CertificateStoreLinux, ShowPreConnectMessage, AutoConnectOnStart, MinimizeOnConnect, LocalLanAccess, DisableCaptivePortalDetection, AutoReconnect, AutoReconnectBehavior, SuspendOnConnectedStandby, UseStartBeforeLogon, AutoUpdate, RSASecurIDIntegration, WindowsLogonEnforcement, WindowsVPNEstablishment, LinuxLogonEnforcement, LinuxVPNEstablishment, ProxySettings, AllowLocalProxyConnections, PPPExclusion, PPPExclusionServerIP, AutomaticVPNPolicy, TrustedNetworkPolicy, UntrustedNetworkPolicy, BypassConnectUponSessionTimeout, TrustedDNSDomains, TrustedDNSServers, TrustedHttpsServerList, DisableUntrustedInterfaces, AlwaysOn, ConnectFailurePolicy, AllowCaptivePortalRemediation, CaptivePortalRemediationTimeout, ApplyLastVPNLocalResourceRules, AllowVPNDisconnect, SuppressConnectionRetries, AllowedHosts, EnableScripting, TerminateScriptOnNextEvent, EnablePostSBLOnConnectScript, AutomaticCertSelection, RetainVpnOnLogoff, UserEnforcement, DeviceLockRequired, DeviceLockMaximumTimeoutMinutes, DeviceLockMinimumPasswordLength, DeviceLockPasswordComplexity, EnableAutomaticServerSelection, AutoServerSelectionImprovement, AutoServerSelectionSuspendTime, AuthenticationTimeout, SafeWordSofTokenIntegration, AllowIPsecOverSSL, ClearSmartcardPin, IPProtocolSupport, CaptivePortalRemediationBrowserFailover, AllowManualHostInput, BlockUntrustedServers, PublicProxyServerAddress, CertificatePinning, UnknownPreference }
enum | PreferenceScope { User, Global, UserAndGlobal }
enum | OperatingMode { FIPS = (1 << 0), StartBeforeLogon = (1 << 1), GUI = (1 << 2), TrustedNetworkDetection = (1 << 3), AlwaysOnVpn = (1 << 4), NetworkIssue = (1 << 5), Quarantined = (1 << 6), AutomaticHeadendSelection = (1 << 7), DisconnectAllowed = (1 << 8), VPNDisabled = (1 << 9), SCEPMode = (1 << 10), OnTrustedNetwork = (1 << 11), ManualHostInputAllowed = (1 << 12), ErrorSuppressed = (1 << 13), StrictMode = (1 << 14), CLI = (1 << 15), Management = (1 << 16) }
enum | VPNError { VPNSuccess = 0, VPNError_Generic_FatalError = 1, VPNError_Connection_Error = 100, VPNError_Connection_InvalidGroupURL, VPNError_Network_Error = 200, VPNError_Authentication_Error = 300, VPNError_Authentication_DAP_Terminate, VPNError_ClientCertificate_UnknownError = 400, VPNError_ClientCertificate_Missing, VPNError_ClientCertificate_Expired, VPNError_ClientCertificate_NotYetValid, VPNError_ServerCertificate_UnknownError = 500, VPNError_ServerCertificate_Expired, VPNError_ServerCertificate_NotYetValid }
enum | CertAuthMode { CertAuth_Automatic, CertAuth_Disabled, CertAuth_Manual }
enum | CertificateType { CertificateType_Client, CertificateType_SystemTrusted, CertificateType_Server }
enum | CertConfirmReason { CertConfirmReason_Unspecified, CertConfirmReason_NameMismatch, CertConfirmReason_Expired, CertConfirmReason_NotValidYet, CertConfirmReason_UntrustedSource, CertConfirmReason_InvalidUse, CertConfirmReason_Revoked, CertConfirmReason_Malformed, CertConfirmReason_NotFipsCompliant, CertConfirmReason_InvalidateDate, CertConfirmReason_SignatureAlgorithm, CertConfirmReason_KeySize }
enum | UserResponseError { UserResponseError_None, UserResponseError_Unspecified, UserResponseError_BadServerCert, UserResponseError_SsoNavigation, UserResponseError_SsoGettingCookie, UserResponseError_SsoTimeout, UserResponseError_SsoMissingDependency, UserResponseError_SsoClientCertRequest, UserResponseError_SsoAborted }
enum | ClientType { ClientType_GUI, ClientType_GUI_SBL, ClientType_CLI, ClientType_MGMT }

## Detailed Description

This file contains some basic compiler definitions as well as common enums.

## Macro Definition Documentation

## ◆ tstring

#define tstring std::wstring

std::wstring my wstring description

## Enumeration Type Documentation

## ◆ CertAuthMode

enum CertAuthMode

Enumerator
CertAuth_Automatic | Will try each available certificate in succession until authentication is obtained or we run out of available certificates
CertAuth_Disabled | Will disable Certificate Based Authentication
CertAuth_Manual | Will only use preconfigured certificate to attempt Certificate Based Authentication

641 {
642 CertAuth_Automatic, /**< Will try each available certificate in succession
643 until authentication is obtained or we run out of
644 available certificates */
645 CertAuth_Disabled, /**< Will disable Certificate Based Authentication */
646 CertAuth_Manual /**< Will only use preconfigured certificate to attempt
647 Certificate Based Authentication */
648 };
CertAuth_Disabled
Definition: api.h:645
CertAuth_Automatic
Definition: api.h:642
CertAuth_Manual
Definition: api.h:646

## ◆ ConnectPromptType

enum ConnectPromptType

provides an indication of the type of credential data being requested.

Enumerator
CERTIFICATE | Indicates a certificate-only type of connection and would not normally be sent to client unless a post-authentication banner is to be displayed.
CREDENTIALS | Indicates that the user is to be prompted for authentication credentials
PROXY | Indicates that the user is to be prompted for proxy-authentication credentials
MANUAL_PKCS12_IMPORT | Indicates that the user is to be prompted for passwords related to PKCS12 import
STATUS | Indicates that status messages are to be displayed to the user
SINGLESIGNON | Indicates an embedded browser based single sign-on authentication method is requested.
SINGLELOGOUT | Indicates an embedded browser based single sign-on authentication logout is requested.
LEGACY_SINGLESIGNON | (deprecated) Indicates a browser based single sign-on authentication method is requested.

245 {
246 CERTIFICATE, /**< Indicates a certificate-only type of connection and
247 would not normally be sent to client unless a
248 post-authentication banner is to be displayed. */
249 CREDENTIALS, /**< Indicates that the user is to be prompted for authentication
250 credentials */
251 PROXY, /**< Indicates that the user is to be prompted for
252 proxy-authentication credentials */
253 MANUAL_PKCS12_IMPORT, /**< Indicates that the user is to be prompted for passwords related
254 to PKCS12 import*/
255 STATUS, /**< Indicates that status messages are to be displayed to
256 the user*/
257 SINGLESIGNON, /**< Indicates an embedded browser based single sign-on authentication method is requested. */
258 SINGLELOGOUT, /**< Indicates an embedded browser based single sign-on authentication logout is requested. */
259 LEGACY_SINGLESIGNON, /**< (deprecated) Indicates a browser based single sign-on authentication method is requested. */
260 };
SINGLELOGOUT
Definition: api.h:258
SINGLESIGNON
Definition: api.h:257
LEGACY_SINGLESIGNON
Definition: api.h:259
CERTIFICATE
Definition: api.h:246
CREDENTIALS
Definition: api.h:249
MANUAL_PKCS12_IMPORT
Definition: api.h:253
PROXY
Definition: api.h:251
STATUS
Definition: api.h:255

## ◆ MessageType

enum MessageType

MessageType presents a level of severity associated with messages that are sent to the API. The severity can be useful for deciding how a message is to be shown. A UI might decide based on type to show a message as a modal dialog versus a message written to the status area for an existing UI.

Enumerator
MsgType_Error | Issue usually requiring user to acknowledge
MsgType_Alert | Warning message that must be shown to user.
MsgType_Warn | Less severe, not required to be shown to user
MsgType_Info | General message providing status, progress, etc.
MsgType_Status | Can be used to indicate unexpected tunnel status change.
MsgType_UrlError | Error message that provides additional information by opening browser.
MsgType_Announcement | Informational message that must be shown to the user. Announcements are currently only supported on desktop platforms.
MsgType_Ephemeral_Alert | Warning message that must be shown to the user, but is closed by the occurrence of an error, announcement, alert, or critical message. Ephemeral Alerts are currently only supported on desktop platforms
MsgType_Critical | Error message that MUST BE POPPED UP to the user, even if operating in ErrorSuppressed mode.

109 {
110 MsgType_Error, /**< Issue usually requiring user to acknowledge */
111 MsgType_Alert, /**< Warning message that must be shown to user. */
112 MsgType_Warn, /**< Less severe, not required to be shown to user */
113 MsgType_Info, /**< General message providing status, progress, etc. */
114 MsgType_Status, /**< Can be used to indicate unexpected tunnel status change. */
115 MsgType_UrlError, /**< Error message that provides additional information by opening browser. */
116 MsgType_Announcement, /**< Informational message that must be shown to the user.
117 Announcements are currently only supported on desktop platforms. */
118 MsgType_Ephemeral_Alert,/**< Warning message that must be shown to the user, but is closed by
119 the occurrence of an error, announcement, alert, or critical message.
120 Ephemeral Alerts are currently only supported on desktop platforms */
121 MsgType_Critical, /**< Error message that MUST BE POPPED UP to the user, even if operating in
122 ErrorSuppressed mode. */
123 };
MsgType_Info
Definition: api.h:113
MsgType_UrlError
Definition: api.h:115
MsgType_Critical
Definition: api.h:121
MsgType_Ephemeral_Alert
Definition: api.h:118
MsgType_Error
Definition: api.h:110
MsgType_Alert
Definition: api.h:111
MsgType_Warn
Definition: api.h:112
MsgType_Announcement
Definition: api.h:116
MsgType_Status
Definition: api.h:114

## ◆ OperatingMode

enum OperatingMode

Indicates the client mode of operation. Unlike tunneling mode or other mutually exclusive modes, client operating modes are independent settings, several of which can be turned on simultaneously.

Enumerator
FIPS | Indicates that the client is running in FIPS mode.
StartBeforeLogon | Indicates that the client is running in Start Before Login mode.
GUI | Indicates that the client is a GUI client.
TrustedNetworkDetection | Indicates that a Trusted Network Detection policy is enabled for the client.
AlwaysOnVpn | Indicates that the Always On policy is enabled for the client.
NetworkIssue | For user notifications only. Indication by API to the UI that there is a network condition.
Quarantined | Indicates that the VPN session is being Quarantined by the secure gateway.
AutomaticHeadendSelection | Indicates that Automatic Headend is enabled.
DisconnectAllowed | Indicates that the user is allowed to disconnect the VPN based on policy.
VPNDisabled | Indicates that the VPN service is to be marked as disabled.
SCEPMode | Indicates that the client is performing a SCEP cert enrollment.
OnTrustedNetwork | Indicates that at last check, the client detected that it was on a trusted network.
ManualHostInputAllowed | Indicates that the user is allowed to add a new host by typing its name in the VPN edit box.
ErrorSuppressed | Indicates a connection error has been returned fronm the agent, but was suppressed to warning to prevent popup dialog in the UI.
StrictMode | Indicates that the client is running in strict certificate trust mode.
CLI | Indicates that the client is a CLI client.
Management | Indicates that the client is strictly used for initiating a management tunnel.

546 {
547 FIPS = (1 << 0), /**< Indicates that the client is
548 running in FIPS mode. */
549 StartBeforeLogon = (1 << 1), /**< Indicates that the client is
550 running in Start Before Login
551 mode. */
552 GUI = (1 << 2), /**< Indicates that the client is
553 a GUI client. */
554 TrustedNetworkDetection = (1 << 3), /**< Indicates that a Trusted Network
555 Detection policy is enabled for
556 the client. */
557 AlwaysOnVpn = (1 << 4), /**< Indicates that the Always On
558 policy is enabled for the client. */
559 NetworkIssue = (1 << 5), /**< For user notifications only.
560 Indication by API to the UI that
561 there is a network condition. */
562 Quarantined = (1 << 6), /**< Indicates that the VPN session is being
563 Quarantined by the secure gateway. */
564 AutomaticHeadendSelection= (1 << 7), /**< Indicates that Automatic Headend
565 is enabled. */
566 DisconnectAllowed = (1 << 8), /**< Indicates that the user is allowed
567 to disconnect the VPN based on
568 policy. */
569 VPNDisabled = (1 << 9), /**< Indicates that the VPN service is
570 to be marked as disabled. */
571 SCEPMode = (1 << 10), /**< Indicates that the client is
572 performing a SCEP cert enrollment. */
573 OnTrustedNetwork = (1 << 11), /**< Indicates that at last check, the
574 client detected that it was on
575 a trusted network. */
576 ManualHostInputAllowed = (1 << 12), /**< Indicates that the user is allowed
577 to add a new host by typing its name
578 in the VPN edit box. */
579 ErrorSuppressed = (1 << 13), /**< Indicates a connection error has
580 been returned fronm the agent, but
581 was suppressed to warning to
582 prevent popup dialog in the UI. */
583 StrictMode = (1 << 14), /**< Indicates that the client is
584 running in strict certificate trust mode. */
585 CLI = (1 << 15), /**< Indicates that the client is
586 a CLI client. */
587 Management = (1 << 16) /**< Indicates that the client is strictly
588 used for initiating a management tunnel. */
589 };
OnTrustedNetwork
Definition: api.h:573
SCEPMode
Definition: api.h:571
StartBeforeLogon
Definition: api.h:549
NetworkIssue
Definition: api.h:559
CLI
Definition: api.h:585
StrictMode
Definition: api.h:583
ErrorSuppressed
Definition: api.h:579
ManualHostInputAllowed
Definition: api.h:576
Management
Definition: api.h:587
GUI
Definition: api.h:552
AutomaticHeadendSelection
Definition: api.h:564
Quarantined
Definition: api.h:562
TrustedNetworkDetection
Definition: api.h:554
VPNDisabled
Definition: api.h:569
AlwaysOnVpn
Definition: api.h:557
FIPS
Definition: api.h:547
DisconnectAllowed
Definition: api.h:566

## ◆ PreferenceId

enum PreferenceId

Enumerator
ServiceDisable | This preference disable the VPN service. If more than one profile exists and any one profile has VPN enabled, then it will be enabled. False is the default.
CertificateStoreOverride | This preference will trigger an alternate authentication sequence in the API. The preference is only settable by an administrator.
CertificateStore | This preference indicates which Windows certificate store AnyConnect should look in for client certificates. The options are All, Machine and User with a default of All. The preference is only settable by an administrator.
CertificateStoreMac | This preference indicates which macOS keychain AnyConnect should look in for client certificates. The options are All, System and Login with a default of All. The preference is only settable by an administrator.
CertificateStoreLinux | This preference indicates which Linux certificate store AnyConnect should look in for client certificates. The options are All, Machine and User with a default of All. The preference is only settable by an administrator.
ShowPreConnectMessage | The ShowPreConnectMessage preference gives the administrator the ability to display an AnyConnect startup banner message. The message will appear only once per AnyConnect program start. The preference is only settable by an administrator.
AutoConnectOnStart | This preference allows the user to select whether to establish a connection automatically on startup or not.
MinimizeOnConnect | This preference allows the user to select if the GUI should minimize when the connection is established
LocalLanAccess | This preference will provide a mechanism where the user can disable access to their Local LAN.
DisableCaptivePortalDetection | This preference will provide a mechanism where the user can disable captive portal detection.
AutoReconnect | First control of the reconnect behavior. If the client becomes disconnected for any reason, a reconnect attempt is made.
AutoReconnectBehavior | Second control of the reconnect behavior. When coming out of suspend/hibernate/standby mode. Options are disconnect on suspend and reconnect after suspend.
SuspendOnConnectedStandby | This setting allows to control whether the VPN tunnel is suspended when the system enters the Connected Standby mode. It applies only to Windows 8 and above.
UseStartBeforeLogon | Deprecated. Start Before Logon is no longer controlled via profile preference and is enabled by default.
AutoUpdate | Once the Downloader has loaded the profile, it can check the AutoUpdate preference to see if updates are either disabled or enabled
RSASecurIDIntegration | This preference will enable the administrator and possibly end user to select the preferred method of managing their SDI PIN and PASSCODE interactions. Options are Automatic (default), SoftwareTokens and HardwareTokens.
WindowsLogonEnforcement | This preference allows an administrator to control if more than one user may be logged into the client PC during the VPN connection (Windows only).
WindowsVPNEstablishment | This preference allows an administrator to control whether or not remote users may initiate a VPN connection (Windows only).
LinuxLogonEnforcement | This preference allows an administrator to control if more than one user may be logged into the client PC during the VPN connection (Linux only).
LinuxVPNEstablishment | This preference allows an administrator to control whether or not remote users may initiate a VPN connection (Linux only).
ProxySettings | This preference allows an administrator to control how user's proxy setups are handled.
AllowLocalProxyConnections | This preference allows the administrator to control whether to allow establishing a connection through a local proxy.
PPPExclusion | This preference allows an administrator to control the policy used to exclude routes to PPP servers when connecting over L2TP or PPTP. Options are Automatic (default), Disable, and Override.
PPPExclusionServerIP | When PPPExclusion is set to Manual, the value of this preference allows an end user to specify the address of a PPP server that should be excluded from tunnel traffic.
AutomaticVPNPolicy | This preference allows an administrator to define a policy to automatically manage when a VPN connection should be started or stopped.
TrustedNetworkPolicy | This preference allows an administrator to define a policy for users in trusted networks. The options are: Disconnect or DoNothing.
UntrustedNetworkPolicy | This preference allows an administrator to define a policy for users in untrusted networks. The options are: Connect or DoNothing.
BypassConnectUponSessionTimeout | This preference allows an administrator the ability to instruct the client to bypass the automatic connection retry after a VPN session timeout.
TrustedDNSDomains | This preference defines a list of comma separated DNS suffixes that a network interface in a trusted network might have.
TrustedDNSServers | This preference defines a list of comma separated DNS servers that a network interface in a trusted network might have.
TrustedHttpsServerList | This preference defines a list of comma separated https servers reachable only via a trusted network.
DisableUntrustedInterfaces | This preference disables interface without trusted server connectivity while in trusted network when there are multiple network interfaces.
AlwaysOn | This preference governs VPN reestablishment after interruptions
ConnectFailurePolicy | This preference gives the network administrator the ability to dictate the network access allowed by the client endpoint device following a VPN connection establishment failure. It is a component of Always On
AllowCaptivePortalRemediation | This preference gives the network administrator the ability to dictate the network access allowed by the client endpoint device following a VPN connection establishment failure it is a component of Always On
CaptivePortalRemediationTimeout | This preference allows the network administrator the ability to impose a time limit for captive portal remediation when the ConnectFailurePolicy value is Closed It is a component of Always On
ApplyLastVPNLocalResourceRules | This preference gives the network administrator the ability to allow split routes and firewall rules to be applied following a VPN connection establishment failure when the ConnectFailurePolicy value is Closed It is a component of Always On
AllowVPNDisconnect | During Always On, this specifies that the user is allowed to disconnect the VPN session.
SuppressConnectionRetries | During Always On, this preference gives the network administrator the ability to suppress the VPN connection retry attempts
AllowedHosts | During Always On, user has access to the specified hosts when VPN is disconnected.
EnableScripting | This preference allows an administrator to enable scripting (on connect or on disconnect).
TerminateScriptOnNextEvent | This preference dictates whether or not AnyConnect will terminate a running script process if a transition to another scriptable event occurs.
EnablePostSBLOnConnectScript | This preference is used to control whether or not the OnConnect script will be launched from the desktop GUI when a tunnel has been established via SBL.
AutomaticCertSelection | This preference dictates whether or not to disable the default automatic certificate selection for user certificates. If disabled, a certificate selection dialog is displayed. This only applies if the GUI is enabled and not SBL. This only applies to Windows (not WinMobile).
RetainVpnOnLogoff | First control of the logoff behavior. This preference allows an administrator to control if the VPN is terminated or retained after user logs off.
UserEnforcement | Second control of the logoff behavior. When the VPN connection has been retained after user logged off. Controls what user can log in and keep the VPN connection. Options are same user only and any user.
DeviceLockRequired | This preference indicates whether or not a Windows Mobile device must be configured with a password or PIN prior to establishing a VPN connection. This configuration is only valid on Windows Mobile devices that use the Microsoft Default Local Authentication Provider (LAP).
DeviceLockMaximumTimeoutMinutes | When set to a non-negative number, this preference specifies the maximum number of minutes a device can be inactive before device lock takes into effect. (WM5/WM5AKU2+)
DeviceLockMinimumPasswordLength | When set to a non-negative number, this preference specifies that any PIN/password used for device lock must be equal to or longer than the specified value, in characters. This setting must be pushed down to the mobile device by syncing with an Exchange server before it can be enforced. (WM5AKU2+)
DeviceLockPasswordComplexity | This preference checks whether or not the password belongs to one of three subtypes: alpha, pin, strong
EnableAutomaticServerSelection | Automatic server selection will automatically select the optimal secure gateway for the endpoint
AutoServerSelectionImprovement | During a reconnection attempt after a system resume, this setting specifies the minimum estimated performance improvement required to justify transitioning a user to a new server This value represents percentage in 0..100
AutoServerSelectionSuspendTime | During a reconnection attempt after a system resume, this specifies the minimum time a user must have been suspended in order to justify a new server selection calculation. Unit is hours
AuthenticationTimeout | Time, in seconds, that the client waits for authentication to be completed.
SafeWordSofTokenIntegration | This preference will enable the administrator and possibly the end user to enable SafeWord SofToken integration. Options are Enabled (true) and Disabled (false - default).
AllowIPsecOverSSL | if 'true' then tunneling of IPSEC over SSL is made possible with help from the ASA.
ClearSmartcardPin | This preference controls whether the smartcard pin will be cleared on a successful connection
IPProtocolSupport | This preference controls which protocol(s) will be allowed for the connection
CaptivePortalRemediationBrowserFailover | This preference is applicable to enhanced captive portal remediation and specifies whether the user is allowed to opt for an external browser for remediation, as opposed to the AnyConnect browser.
AllowManualHostInput | This preference specifies whether the user is allowed to type a new hostname in the VPN edit box.
BlockUntrustedServers | This preference specifies whether the user wants to allow for connections to secure gateways with certificate errors.
PublicProxyServerAddress | This preference specifies the public proxy server address to be used. This number is in the format ServerAddr:ServerPort (ex. 101.89.85.444:8080) or just the FQDN.
CertificatePinning | This preference specifies whether Certificate Pinning check should be performed during server certificate verification.

295 {
296 ServiceDisable, /**< This preference disable the VPN service.
297 If more than one profile exists and any one
298 profile has VPN enabled, then it will be
299 enabled. False is the default. */
300 CertificateStoreOverride,/**< This preference will trigger an alternate
301 authentication sequence in the API. The
302 preference is only settable by an
303 administrator. */
304 CertificateStore, /**< This preference indicates which Windows certificate
305 store AnyConnect should look in for client certificates.
306 The options are All, Machine and User with a default of All.
307 The preference is only settable by an administrator. */
308 CertificateStoreMac, /**< This preference indicates which macOS keychain
309 AnyConnect should look in for client certificates.
310 The options are All, System and Login with a default of All.
311 The preference is only settable by an administrator. */
312 CertificateStoreLinux, /**< This preference indicates which Linux certificate
313 store AnyConnect should look in for client certificates.
314 The options are All, Machine and User with a default of All.
315 The preference is only settable by an administrator. */
316 ShowPreConnectMessage, /**< The ShowPreConnectMessage preference gives the
317 administrator the ability to display an AnyConnect
318 startup banner message. The message will appear
319 only once per AnyConnect program start. The
320 preference is only settable by an
321 administrator. */
322 AutoConnectOnStart, /**< This preference allows the user to select
323 whether to establish a connection automatically
324 on startup or not. */
325 MinimizeOnConnect, /**< This preference allows the user to select if
326 the GUI should minimize when the connection is
327 established */
328 LocalLanAccess, /**< This preference will provide a mechanism where
329 the user can disable access to their Local LAN. */
330 DisableCaptivePortalDetection, /**<This preference will provide a mechanism where
331 the user can disable captive portal detection.*/
332 AutoReconnect, /**< First control of the reconnect behavior. If the
333 client becomes disconnected for any reason, a
334 reconnect attempt is made. */
335 AutoReconnectBehavior, /**< Second control of the reconnect behavior. When
336 coming out of suspend/hibernate/standby mode.
337 Options are disconnect on suspend and reconnect
338 after suspend. */
339 SuspendOnConnectedStandby, /**< This setting allows to control whether the VPN tunnel
340 is suspended when the system enters the Connected Standby
341 mode. It applies only to Windows 8 and above. */
342 UseStartBeforeLogon, /**< Deprecated. Start Before Logon is no longer controlled
343 via profile preference and is enabled by default. */
344 AutoUpdate, /**< Once the Downloader has loaded the profile, it
345 can check the AutoUpdate preference to see if
346 updates are either disabled or enabled */
347 RSASecurIDIntegration, /**< This preference will enable the administrator
348 and possibly end user to select the preferred
349 method of managing their SDI PIN and PASSCODE
350 interactions. Options are Automatic (default),
351 SoftwareTokens and HardwareTokens. */
352 WindowsLogonEnforcement,/**< This preference allows an administrator to
353 control if more than one user may be logged into
354 the client PC during the VPN connection (Windows
355 only). */
356 WindowsVPNEstablishment,/**< This preference allows an administrator to
357 control whether or not remote users may initiate
358 a VPN connection (Windows only). */
359 LinuxLogonEnforcement, /**< This preference allows an administrator to
360 control if more than one user may be logged into
361 the client PC during the VPN connection (Linux
362 only). */
363 LinuxVPNEstablishment, /**< This preference allows an administrator to
364 control whether or not remote users may initiate
365 a VPN connection (Linux only). */
366 ProxySettings, /**< This preference allows an administrator to
367 control how user's proxy setups are handled.*/
368 AllowLocalProxyConnections, /**< This preference allows the administrator to control
369 whether to allow establishing a connection through
370 a local proxy. */
371 PPPExclusion, /**< This preference allows an administrator to control
372 the policy used to exclude routes to
373 PPP servers when connecting over L2TP or PPTP.
374 Options are Automatic (default), Disable,
375 and Override. */
376 PPPExclusionServerIP, /**< When PPPExclusion is set to Manual,
377 the value of this preference allows an
378 end user to specify the address of a
379 PPP server that should be excluded
380 from tunnel traffic. */
381 AutomaticVPNPolicy, /**< This preference allows an administrator to
382 define a policy to automatically manage when a
383 VPN connection should be started or stopped. */
384 TrustedNetworkPolicy, /**< This preference allows an administrator to
385 define a policy for users in trusted networks.
386 The options are: Disconnect or DoNothing. */
387 UntrustedNetworkPolicy, /**< This preference allows an administrator to
388 define a policy for users in untrusted networks.
389 The options are: Connect or DoNothing. */
390 BypassConnectUponSessionTimeout, /**< This preference allows an administrator
391 the ability to instruct the client to bypass the
392 automatic connection retry after a VPN session timeout. */
393 TrustedDNSDomains, /**< This preference defines a list of comma
394 separated DNS suffixes that a network interface
395 in a trusted network might have. */
396 TrustedDNSServers, /**< This preference defines a list of comma
397 separated DNS servers that a network interface
398 in a trusted network might have. */
399 TrustedHttpsServerList, /**< This preference defines a list of comma separated
400 https servers reachable only via a trusted network.*/
401 DisableUntrustedInterfaces, /**< This preference disables interface without trusted
402 server connectivity while in trusted network
403 when there are multiple network interfaces. */
404 AlwaysOn, /**< This preference governs VPN reestablishment after
405 interruptions */
406 ConnectFailurePolicy, /**< This preference gives the network administrator
407 the ability to dictate the network access allowed
408 by the client endpoint device following a VPN
409 connection establishment failure. It is a component
410 of Always On */
411 AllowCaptivePortalRemediation, /**< This preference gives the network administrator
412 the ability to dictate the network access
413 allowed by the client endpoint device following
414 a VPN connection establishment failure it is a
415 component of Always On */
416 CaptivePortalRemediationTimeout, /**< This preference allows the network administrator
417 the ability to impose a time limit for captive portal
418 remediation when the ConnectFailurePolicy value is Closed
419 It is a component of Always On */
420 ApplyLastVPNLocalResourceRules, /**< This preference gives the network administrator
421 the ability to allow split routes and firewall rules
422 to be applied following a VPN connection establishment
423 failure when the ConnectFailurePolicy value is Closed
424 It is a component of Always On */
425 AllowVPNDisconnect, /**< During Always On, this specifies that the user is allowed to
426 disconnect the VPN session. */
427 SuppressConnectionRetries, /**< During Always On, this preference gives the network administrator
428 the ability to suppress the VPN connection retry attempts */
429 AllowedHosts, /**< During Always On, user has access to the specified hosts
430 when VPN is disconnected. */
431 EnableScripting, /**< This preference allows an administrator to
432 enable scripting (on connect or on
433 disconnect). */
434 TerminateScriptOnNextEvent, /**< This preference dictates whether or not
435 AnyConnect will terminate a running script
436 process if a transition to another
437 scriptable event occurs. */
438 EnablePostSBLOnConnectScript, /**< This preference is used to control whether
439 or not the OnConnect script will be launched
440 from the desktop GUI when a tunnel has been
441 established via SBL. */
442 AutomaticCertSelection, /**< This preference dictates whether or not to disable
443 the default automatic certificate selection for user
444 certificates. If disabled, a certificate selection dialog is
445 displayed. This only applies if the GUI is enabled
446 and not SBL. This only applies to Windows (not WinMobile). */
447 RetainVpnOnLogoff, /**< First control of the logoff behavior. This preference allows
448 an administrator to control if the VPN is terminated or retained
449 after user logs off.*/
450 UserEnforcement, /**< Second control of the logoff behavior. When the VPN connection has
451 been retained after user logged off. Controls what user can log in
452 and keep the VPN connection. Options are same user only and any user. */
453 DeviceLockRequired, /**< This preference indicates whether or not
454 a Windows Mobile device must be configured
455 with a password or PIN prior to establishing
456 a VPN connection. This configuration is
457 only valid on Windows Mobile devices that
458 use the Microsoft Default Local
459 Authentication Provider (LAP). */
460 DeviceLockMaximumTimeoutMinutes, /**< When set to a non-negative number,
461 this preference specifies the maximum
462 number of minutes a device can be
463 inactive before device lock takes
464 into effect. (WM5/WM5AKU2+) */
465 DeviceLockMinimumPasswordLength, /**< When set to a non-negative number,
466 this preference specifies that any
467 PIN/password used for device lock
468 must be equal to or longer than
469 the specified value, in characters.
470 This setting must be pushed down to
471 the mobile device by syncing with
472 an Exchange server before it can be
473 enforced. (WM5AKU2+) */
474 DeviceLockPasswordComplexity, /**< This preference checks whether or
475 not the password belongs to one of
476 three subtypes: alpha, pin, strong */
477 EnableAutomaticServerSelection, /**< Automatic server selection will
478 automatically select the optimal
479 secure gateway for the endpoint */
480 AutoServerSelectionImprovement, /**< During a reconnection attempt after
481 a system resume, this setting
482 specifies the minimum estimated
483 performance improvement required to
484 justify transitioning a user to a new server
485 This value represents percentage in 0..100 */
486 AutoServerSelectionSuspendTime, /**< During a reconnection attempt after
487 a system resume, this specifies the
488 minimum time a user must have been
489 suspended in order to justify a new
490 server selection calculation. Unit is hours */
491 AuthenticationTimeout, /**< Time, in seconds, that the client waits
492 for authentication to be completed.*/
493 SafeWordSofTokenIntegration, /**< This preference will enable the administrator and possibly
494 the end user to enable SafeWord SofToken integration.
495 Options are Enabled (true) and Disabled (false - default). */
496 AllowIPsecOverSSL, /**< if 'true' then tunneling of IPSEC over SSL
497 is made possible with help from the ASA.
498 */
499 ClearSmartcardPin, /**< This preference controls whether the smartcard pin
500 will be cleared on a successful connection*/
501 IPProtocolSupport, /**< This preference controls which protocol(s) will be
502 allowed for the connection*/
503 CaptivePortalRemediationBrowserFailover, /**< This preference is applicable to enhanced captive portal
504 remediation and specifies whether the user is allowed to
505 opt for an external browser for remediation, as opposed to
506 the AnyConnect browser. */
507 AllowManualHostInput, /**< This preference specifies whether the user
508 is allowed to type a new hostname in the VPN
509 edit box. */
510 BlockUntrustedServers, /**< This preference specifies whether the user wants
511 to allow for connections to secure gateways with
512 certificate errors. */
513 PublicProxyServerAddress, /**< This preference specifies the public proxy server
514 address to be used. This number is in the format
515 ServerAddr:ServerPort (ex. 101.89.85.444:8080)
516 or just the FQDN. */
517 CertificatePinning, /**< This preference specifies whether Certificate Pinning
518 check should be performed during server certificate
519 verification. */
520 UnknownPreference
521 };
EnableScripting
Definition: api.h:431
AllowManualHostInput
Definition: api.h:507
CertificateStoreOverride
Definition: api.h:300
AllowCaptivePortalRemediation
Definition: api.h:411
RetainVpnOnLogoff
Definition: api.h:447
TrustedDNSServers
Definition: api.h:396
TerminateScriptOnNextEvent
Definition: api.h:434
BlockUntrustedServers
Definition: api.h:510
CertificatePinning
Definition: api.h:517
AutoReconnectBehavior
Definition: api.h:335
MinimizeOnConnect
Definition: api.h:325
AutomaticVPNPolicy
Definition: api.h:381
AutomaticCertSelection
Definition: api.h:442
UserEnforcement
Definition: api.h:450
PPPExclusionServerIP
Definition: api.h:376
AutoConnectOnStart
Definition: api.h:322
AllowVPNDisconnect
Definition: api.h:425
ShowPreConnectMessage
Definition: api.h:316
ServiceDisable
Definition: api.h:296
TrustedDNSDomains
Definition: api.h:393
LocalLanAccess
Definition: api.h:328
LinuxLogonEnforcement
Definition: api.h:359
DeviceLockMaximumTimeoutMinutes
Definition: api.h:460
TrustedNetworkPolicy
Definition: api.h:384
AllowLocalProxyConnections
Definition: api.h:368
BypassConnectUponSessionTimeout
Definition: api.h:390
RSASecurIDIntegration
Definition: api.h:347
AuthenticationTimeout
Definition: api.h:491
DeviceLockRequired
Definition: api.h:453
AutoReconnect
Definition: api.h:332
CertificateStoreLinux
Definition: api.h:312
IPProtocolSupport
Definition: api.h:501
SafeWordSofTokenIntegration
Definition: api.h:493
PublicProxyServerAddress
Definition: api.h:513
UntrustedNetworkPolicy
Definition: api.h:387
TrustedHttpsServerList
Definition: api.h:399
CaptivePortalRemediationBrowserFailover
Definition: api.h:503
WindowsVPNEstablishment
Definition: api.h:356
SuppressConnectionRetries
Definition: api.h:427
ClearSmartcardPin
Definition: api.h:499
CaptivePortalRemediationTimeout
Definition: api.h:416
CertificateStore
Definition: api.h:304
AllowIPsecOverSSL
Definition: api.h:496
AlwaysOn
Definition: api.h:404
AutoUpdate
Definition: api.h:344
AutoServerSelectionSuspendTime
Definition: api.h:486
CertificateStoreMac
Definition: api.h:308
DisableUntrustedInterfaces
Definition: api.h:401
DeviceLockMinimumPasswordLength
Definition: api.h:465
EnableAutomaticServerSelection
Definition: api.h:477
DisableCaptivePortalDetection
Definition: api.h:330
SuspendOnConnectedStandby
Definition: api.h:339
ApplyLastVPNLocalResourceRules
Definition: api.h:420
ProxySettings
Definition: api.h:366
WindowsLogonEnforcement
Definition: api.h:352
UseStartBeforeLogon
Definition: api.h:342
AllowedHosts
Definition: api.h:429
DeviceLockPasswordComplexity
Definition: api.h:474
ConnectFailurePolicy
Definition: api.h:406
LinuxVPNEstablishment
Definition: api.h:363
AutoServerSelectionImprovement
Definition: api.h:480
EnablePostSBLOnConnectScript
Definition: api.h:438
PPPExclusion
Definition: api.h:371

## ◆ PreferenceScope

enum PreferenceScope

Indicates the scope of the preferences contained in a PreferenceInfo object

Enumerator
User | Indicates that the preferences were set by a user
Global | Indicates that the preferences are global
UserAndGlobal | Indicates that we have both user and global preferences

531 {
532 User, /**< Indicates that the preferences were set by a user */
533 Global, /**< Indicates that the preferences are global */
534 UserAndGlobal /**< Indicates that we have both user and global preferences */
535 };
User
Definition: api.h:532
Global
Definition: api.h:533
UserAndGlobal
Definition: api.h:534

## ◆ PromptType

enum PromptType

Indicates the prompt or credential type.

Enumerator
Prompt_Input | label and value.
Prompt_Password | label and value, indicates user response should be masked.
Prompt_Banner | value (the banner) with no label set.
Prompt_Combo | list with choices options.
Prompt_Header | label intended as header and with value.
Prompt_Hidden | hidden value, should be ignored and left unchanged in response.
Prompt_CheckBox | label and value (contrained to true or false)
Prompt_SSO | single sign-on authentication token prompt

269 { Prompt_Input, /**< label and value. */
270 Prompt_Password, /**< label and value, indicates user
271 response should be masked. */
272 Prompt_Banner, /**< value (the banner) with no label set. */
273 Prompt_Combo, /**< list with choices options. */
274 Prompt_Header, /**< label intended as header and with
275 value. */
276 Prompt_Hidden, /**< hidden value, should be ignored and
277 left unchanged in response. */
278 Prompt_CheckBox, /**< label and value (contrained to true or false) */
279 Prompt_SSO /**< single sign-on authentication token prompt */
280 };
Prompt_Input
Definition: api.h:269
Prompt_Combo
Definition: api.h:273
Prompt_Password
Definition: api.h:270
Prompt_SSO
Definition: api.h:279
Prompt_Header
Definition: api.h:274
Prompt_Banner
Definition: api.h:272
Prompt_Hidden
Definition: api.h:276
Prompt_CheckBox
Definition: api.h:278

## ◆ SDITokenType

enum SDITokenType

Identifies the type of token that was used successfully when SDI Authentication is in use.

134 {
135 SDITT_NONE,
136 SDITT_HARDWARE,
137 SDITT_SOFTWARE
138 };

## ◆ VPNDisconnectReason

enum VPNDisconnectReason

Provides a disconnect reason to terminate the VPN tunnel.

189 {
190 UserRequestedDisconnect,
191 ApplicationTermination,
192 };

## ◆ VPNError

enum VPNError

Indicates the last error seen by the API in this connection attempt.

Enumerator
VPNSuccess | No error has occurred.
VPNError_Generic_FatalError | An error of unknown type has occured
VPNError_Connection_Error | An unknown connection error has occured, such as bad hostname, bad group, etc.
VPNError_Connection_InvalidGroupURL | Invalid Group URL specified in the server address
VPNError_Network_Error | An unknown network error has occured, such as DNS resolution error, unable to open socket, routing error, captive portal, etc.
VPNError_Authentication_Error | An unknown user authenication error has occured.
VPNError_Authentication_DAP_Terminate | Access Denied: Your system does not meet policy requirements (DAP).
VPNError_ClientCertificate_UnknownError | An unknown client certificate error has occured.
VPNError_ClientCertificate_Missing | A client certificate is required but no client certificate has been found on the system.
VPNError_ClientCertificate_Expired | The client certificate has expired
VPNError_ClientCertificate_NotYetValid | The client certificate is not yet valid.
VPNError_ServerCertificate_UnknownError | An unknown error has occured when validating the server certificate.
VPNError_ServerCertificate_Expired | The server certificate has expired.
VPNError_ServerCertificate_NotYetValid | The server certificate is not yet valid.

598 {
599 VPNSuccess = 0, /**< No error has occurred. */
600 VPNError_Generic_FatalError = 1, /**< An error of unknown type has
601 occured */
602
603 VPNError_Connection_Error = 100, /**< An unknown connection error has
604 occured, such as bad hostname, bad
605 group, etc. */
606 VPNError_Connection_InvalidGroupURL, /**< Invalid Group URL specified in the
607 server address */
608
609 VPNError_Network_Error = 200, /**< An unknown network error has
610 occured, such as DNS resolution
611 error, unable to open socket,
612 routing error, captive portal,
613 etc. */
614
615 VPNError_Authentication_Error = 300, /**< An unknown user authenication
616 error has occured. */
617
618 VPNError_Authentication_DAP_Terminate, /**< Access Denied: Your system does
619 not meet policy requirements (DAP). */
620
621 VPNError_ClientCertificate_UnknownError = 400, /**< An unknown client
622 certificate error has
623 occured. */
624 VPNError_ClientCertificate_Missing, /**< A client certificate is required
625 but no client certificate has been
626 found on the system. */
627 VPNError_ClientCertificate_Expired, /**< The client certificate has expired */
628 VPNError_ClientCertificate_NotYetValid, /**< The client certificate is not
629 yet valid. */
630
631 VPNError_ServerCertificate_UnknownError = 500, /**< An unknown error has
632 occured when validating
633 the server certificate. */
634 VPNError_ServerCertificate_Expired, /**< The server certificate has
635 expired. */
636 VPNError_ServerCertificate_NotYetValid /**< The server certificate is not
637 yet valid. */
638 };
VPNError_Authentication_Error
Definition: api.h:615
VPNError_ClientCertificate_Missing
Definition: api.h:624
VPNError_ClientCertificate_UnknownError
Definition: api.h:621
VPNSuccess
Definition: api.h:599
VPNError_ClientCertificate_NotYetValid
Definition: api.h:628
VPNError_Generic_FatalError
Definition: api.h:600
VPNError_ServerCertificate_UnknownError
Definition: api.h:631
VPNError_ServerCertificate_Expired
Definition: api.h:634
VPNError_ServerCertificate_NotYetValid
Definition: api.h:636
VPNError_Network_Error
Definition: api.h:609
VPNError_Connection_InvalidGroupURL
Definition: api.h:606
VPNError_ClientCertificate_Expired
Definition: api.h:627
VPNError_Authentication_DAP_Terminate
Definition: api.h:618
VPNError_Connection_Error
Definition: api.h:603

## ◆ VPNState

enum VPNState

Provides the current state of the VPN tunnel.

Enumerator
CONNECTED | VPN is active
DISCONNECTED | VPN is inactive
CONNECTING | VPN is being established
DISCONNECTING | VPN is being terminated
RECONNECTING | VPN is being re-connected. This state can occur due to network or other temporary problems. The state indicates that the VPN is temporarily unavailable and indicates the connection is being re-established.
PAUSING | VPN is being paused.
PAUSED | VPN is paused.
SSOPOLLING | API is doing auth-poll, VPN is disconnected.

147 {
148 CONNECTED = STATE_CONNECTED, /**< VPN is active */
149 DISCONNECTED = STATE_DISCONNECTED, /**< VPN is inactive */
150 CONNECTING = STATE_CONNECTING, /**< VPN is being established */
151 DISCONNECTING = STATE_DISCONNECTING, /**< VPN is being terminated */
152 RECONNECTING = STATE_RECONNECTING, /**< VPN is being re-connected. This state
153 can occur due to network or other
154 temporary problems. The state
155 indicates that the VPN is temporarily
156 unavailable and indicates the
157 connection is being re-established. */
158 PAUSING = STATE_PAUSING, /**< VPN is being paused. */
159 PAUSED = STATE_PAUSED, /**< VPN is paused. */
160 SSOPOLLING = STATE_SSOPOLLING, /**< API is doing auth-poll, VPN is disconnected. */
161 UNKNOWN = ~0
162 };
CONNECTED
Definition: api.h:148
DISCONNECTING
Definition: api.h:151
CONNECTING
Definition: api.h:150
RECONNECTING
Definition: api.h:152
PAUSING
Definition: api.h:158
DISCONNECTED
Definition: api.h:149
SSOPOLLING
Definition: api.h:160
PAUSED
Definition: api.h:159

## ◆ VPNSubState

enum VPNSubState

Provides the current sub-state of the VPN tunnel.

171 {
172 VPNSS_NORMAL = VCSS_NORMAL,
173 VPNSS_INDEFINITE_DELAY = VCSS_INDEFINITE_DELAY,
174 VPNSS_SESSION_EXPIRING = VCSS_SESSION_EXPIRING,
175 VPNSS_MT_DISCONNECTED_DISABLED = VCSS_MT_DISCONNECTED_DISABLED,
176 VPNSS_MT_DISCONNECTED_TRUSTED_NW = VCSS_MT_DISCONNECTED_TRUSTED_NW,
177 VPNSS_MT_DISCONNECTED_USER_TUNNEL_ACTIVE= VCSS_MT_DISCONNECTED_USER_TUNNEL_ACTIVE,
178 VPNSS_MT_DISCONNECTED_LAUNCH_FAILED = VCSS_MT_DISCONNECTED_LAUNCH_FAILED,
179 VPNSS_MT_DISCONNECTED_CONNECT_FAILED = VCSS_MT_DISCONNECTED_CONNECT_FAILED,
180 VPNSS_MT_DISCONNECTED_BAD_VPN_CONFIG = VCSS_MT_DISCONNECTED_BAD_VPN_CONFIG,
181 VPNSS_MT_DISCONNECTED_SW_UP_PENDING = VCSS_MT_DISCONNECTED_SW_UP_PENDING,
182 VPNSS_MTU_ADJUSTMENT_PENDING = VCSS_MTU_ADJUSTMENT_PENDING
183 };

## ◆ WMHint

enum WMHint

WMHint provides a hint for the GUI to either minimize or un-minimize.

Enumerator
MINIMIZE | hint to minimize GUI
OPEN | hint to un-minimize GUI
QUIT | hint that GUI should close. See also WMHintReason
REFRESHHOSTNAMES | hint to refresh the list of secure gateways
REFRESHPREFS | hint to refresh the preferences
SHOWCONNECTING | hint to display "connecting" status
CLOSECREDENTIALPOPUP | hint to close the credentials popup

202 {
203 MINIMIZE, /**< hint to minimize GUI */
204 OPEN, /**< hint to un-minimize GUI */
205 QUIT, /**< hint that GUI should close. @see WMHintReason */
206 REFRESHHOSTNAMES,/**< hint to refresh the list of secure gateways */
207 REFRESHPREFS, /**< hint to refresh the preferences */
208 SHOWCONNECTING, /**< hint to display "connecting" status */
209 CLOSECREDENTIALPOPUP, /**< hint to close the credentials popup */
210 };
SHOWCONNECTING
Definition: api.h:208
MINIMIZE
Definition: api.h:203
OPEN
Definition: api.h:204
QUIT
Definition: api.h:205
REFRESHHOSTNAMES
Definition: api.h:206
REFRESHPREFS
Definition: api.h:207
CLOSECREDENTIALPOPUP
Definition: api.h:209

## ◆ WMHintReason

enum WMHintReason

WMHintReason provides a reason indicator for the WMHint

Enumerator
SECONDGUISTART | Indicates a second GUI has been launched. This indicator is used to suggest that the GUI already running be OPENed and that the first one should exit.
PROXYREQUEST | Proxy credential request can be for web-launch or standalone-initiated connections.
SERVICEFAILURE | This tag is used when the VPN service is no longer available.
DISCONNECT | Any disconnect notices should be seen by the user.
SERVICESTOPPED | This tag will be used in cases where the VPN service has been stopped.
CONNECT | Tag indicating an action to be taken due to connect, for example a request to minimize the UI.

221 {
222 SECONDGUISTART, /**< Indicates a second GUI has been launched. This
223 indicator is used to suggest that the GUI
224 already running be OPENed and that the first one
225 should exit. */
226 PROXYREQUEST, /**< Proxy credential request can be for web-launch or
227 standalone-initiated connections. */
228 SERVICEFAILURE, /**< This tag is used when the VPN service
229 is no longer available. */
230 DISCONNECT, /**< Any disconnect notices should be seen by the user. */
231 SERVICESTOPPED, /**< This tag will be used in cases where the VPN service
232 has been stopped. */
233 CONNECT, /**< Tag indicating an action to be taken due to connect,
234 for example a request to minimize the UI. */
235 REASONUNKNOWN /**< */
236 };
SERVICEFAILURE
Definition: api.h:228
SERVICESTOPPED
Definition: api.h:231
CONNECT
Definition: api.h:233
SECONDGUISTART
Definition: api.h:222
PROXYREQUEST
Definition: api.h:226
DISCONNECT
Definition: api.h:230