VpnApi.idl

/**************************************************************************
*   Copyright (c) 2008, 2022 Cisco Systems, Inc.
*   All Rights Reserved. Cisco Highly Confidential.
***************************************************************************
*
*   File:   VpnApi.idl -- interface definition of the AnyConnect 
*                         VPN API COM wrapper.
*   Author: Vincent E. Parla
*   Date:   07/14/2008
*
**************************************************************************/
 
/** @defgroup COM_API COM API 
* This is the interface definition of the AnyConnect Secure Mobility VPN API COM wrapper.
* Users of the COM API will #import vpnapi.dll to obtain the interface, method
* and enumerator defintions.  
* The .idl file is included in documentation for reference purposes only.
*
* NOTE: This interface specification is not immutable and can be broken by future versions.
*       It is expected that your code will be recompiled / refactored to match the version
*       of client installed on the system.
*
*  @{
*/
import "oaidl.idl";
import "ocidl.idl";
import "api.h";                 /*obtain the api enumerators to embed in the type library*/
import "VpnApiStringEnums.h";   /*obtain the string table enumerators to embed in the type library*/
import "RegValueUpgradeCodes.h";/*obtain the upgrade code enumerator to embed in the type library*/
 
cpp_quote("#ifdef __cplusplus")
cpp_quote("    using namespace VpnApiStringEnums;")
cpp_quote("#endif //__cplusplus")
 
    interface IVpnApiEvents;        //forward declaration of the IVpnApiEvents callback interface.
    interface IVpnStats;            //forward declaration of the IVpnStats interface.
    interface IConnectPromptInfo;   //forward declaration of the IConnectPromptInfo interface.
    interface IPromptEntry;         //forward declaration of the IPromptEntry interface.
    interface IPreferenceInfo;      //forward declaration of the IPreferenceInfo interface.
    interface IPreference;          //forward declaration of the IPreference interface.
 
    interface IStringCollection;    //forward declaration of the string collection utility interface
    interface IInterfaceCollection; //forward declaration of the interface collection utilty interface.
 
    /**
    * interface IVpnApi
    * Cisco Secure Client - AnyConnect VPN API IDispatch interface specification.  This is the VPN API COM Server instantiated by the user via CoCreateInstance.
    */
    [
        object,
        uuid(027E04AD-347B-4E63-9E10-00BACB3970C8),
        oleautomation,
        nonextensible,
        dual,
        helpstring("Cisco Secure Client - AnyConnect VPN API IVpnApi Interface specification.  This is the VPN API COM Server instantiated by the user via CoCreateInstance."),
        pointer_default(unique)
    ]
    interface IVpnApi : IDispatch
    {
        [id(1), helpstring("method Register. This is a convenience method for attaching one or more callback interface(s) without using the IConnectionPoint interface directly.")] 
        HRESULT Register([in] IVpnApiEvents * pVpnApiEvents, [out, retval] DWORD * pdwCookie);
        
        [id(2), helpstring("method Unregister. This is a convenience method for detaching a callback interface without using the IConnectionPoint interface directly.")] 
        HRESULT Unregister([in] DWORD dwCookie);
 
        [id(3), helpstring("method Attach. This is the first method that is called to configure the VPN API engine.  An event callback IVpnApiEvents is assumed to be already associated, prior to calling this method.  Languages like C# would use this method after wiring up the events.")]
        HRESULT Attach([in, defaultvalue(ClientType_GUI)] enum ClientType clientType,
                       [in, defaultvalue(-1)/*true*/] VARIANT_BOOL bRequestFullCapabilities,
                       [in, defaultvalue(-1)/*true*/] VARIANT_BOOL bSuppressAutoConnect);
       
        [id(4), helpstring("method Detach. This is the last method that is called to terminate the VPN API engine. Languages like C# would use this method after wiring up the events.")] 
        HRESULT Detach();
 
        [id(5), helpstring("method RegisterAndAttach. This method combines Register and Attach into a single convenience method.  This supports only one IVpnApiEvents instance per IVpnApi instance.  Languages that handle connection points under the covers, like C#, would not use this method, but would instead simply use Attach().")]
        HRESULT RegisterAndAttach([in] IVpnApiEvents * pVpnApiEvents, 
                                  [in, defaultvalue(ClientType_GUI)] enum ClientType clientType,
                                  [in, defaultvalue(-1)/*true*/] VARIANT_BOOL bRequestFullCapabilities,
                                  [in, defaultvalue(-1)/*true*/] VARIANT_BOOL bSuppressAutoConnect);
       
        [id(6), helpstring("method UnregisterAndDetach. This method combines Unregister and Detach into a single convenience method.  This supports only one IVpnApiEvents instance per IVpnApi instance. Languages that handle connection points under the covers, like C#, would not use this method, but would instead simply use Detach().")] 
        HRESULT UnregisterAndDetach();
 
        [id(7), propput, helpstring("property EnableConsumerDrivenEventModel.  Call this before attaching, to enable a consumer-driven event model.  This enables the IVpnApiEvents::VpnEventAvailableNotification.  It's required to always enable this as the old event model is deprecated.")] 
        HRESULT EnableConsumerDrivenEventModel([in] VARIANT_BOOL bEnable);
 
        [id(8), helpstring("method ProcessEvents. Use this method if the consumer-driven event model is configured and an IVpnApiEvents::VpnEventAvailableNotification was fired.")] 
        HRESULT ProcessEvents();
 
        [id (9), propget, helpstring("property HasFullCapabilities.  Indicates whether this instance of the VPN API engine is the principal instance.")] 
        HRESULT HasFullCapabilities([out, retval] VARIANT_BOOL* pbHasFullCapabilities);
        
        [id(10), propget, helpstring("property IsConnected.  Indicates that there is a VPN connection.")]
        HRESULT IsConnected([out, retval] VARIANT_BOOL* pbIsConnected);
 
        [id(11), propget, helpstring("property IsVPNServiceAvailable.  Indicates that the VPN Service is active. (This is also delivered to the IVpnApiEvents callback.)")]
        HRESULT IsVPNServiceAvailable([out, retval] VARIANT_BOOL* pbIsVPNServiceAvailable);
        
        [id(12), propget, helpstring("property HostNames.  Obtains a collection of hostname strings from the profile.")] 
        HRESULT HostNames([out, retval] IStringCollection** ppIStringCollection);
 
        [id(13), propget, helpstring("property DefaultHostName.  Obtains the default hostname from the profile or the last hostname from a previous connection.")] 
        HRESULT DefaultHostName([out, retval] BSTR* pstrGetDefaultHostName);
        
        [id(14), helpstring("method ConnectVpn.  Connects to the secure gateway using a hostname or ip address.")] 
        HRESULT ConnectVpn([in] BSTR strHostNameOrAddress);
        
        [id(15), helpstring("method DisconnectVpn.  Disconnects from the secure gateway VPN session")] 
        HRESULT DisconnectVpn();
 
        [id(16), helpstring("method GetState.  Causes the VPN API engine to invoke the IVpnApiEvents::VpnStateNotification method to deliver the current state.")] 
        HRESULT GetState();
 
        [id(17), helpstring("method ResetStats.  Resets the the internal stat counters back to initial values.")] 
        HRESULT ResetStats();
 
        [id(18), helpstring("method StartStats.  Starts the automatic stats notification mechanism.  This results in IVpnApiEvents::VpnStatsNotification being fired periodically.")]
        HRESULT StartStats();
 
        [id(19), helpstring("method StopStats.  Stops the automatic stats notification mechanism.")] 
        HRESULT StopStats();
 
        [id(20), helpstring("method UserSubmit.  The caller must release the IConnectPromptInfo object, obtained from IVpnApiEvents::VpnUserPromptNotification, prior to calling this method.")] 
        HRESULT UserSubmit();
 
        [id(21), propget, helpstring("property Preferences.  Obtains a collection of IPreference interface instances.")] 
        HRESULT Preferences([out, retval] IPreferenceInfo** ppPreferenceInfo);
  
        [id(22), helpstring("method SavePreferences.  The caller must release the IPreferenceInfo object prior to calling this method.")] 
        HRESULT SavePreferences();
 
        [id(23), propput, helpstring("property BannerResponse.  Call this with the user response to the banner.")] 
        HRESULT BannerResponse([in] VARIANT_BOOL bResponse);
 
        [id(24), propget, helpstring("property OperatingMode.  Indicates if an operating mode is enabled.")] 
        HRESULT IsOperatingMode([in] enum OperatingMode eOperatingMode, [out, retval] VARIANT_BOOL* pbIsEnabled);
 
        [id(25), helpstring("method GetStats.  Causes the VPN API engine to invoke the IVpnApiEvents::VpnStatsNotification method to deliver the current stats.")] 
        HRESULT GetStats();
 
        [id(26), propget, helpstring("property LastVpnError.  Indicates the last error seen while establishing VPN.")] 
        HRESULT LastVpnError([out, retval] enum VPNError* peLastVpnError);
 
        [id(27), propput, helpstring("property CertBlockedResponse.  Call this with the user response to the CertBlockedCB.")]
        HRESULT CertBlockedResponse([in] VARIANT_BOOL bUnblock);
 
        [id(28), propput, helpstring("property CertWarningResponse.  Call this with the user response to the CertWarningCB.")]
        HRESULT CertWarningResponse([in] VARIANT_BOOL bConnect, [in] VARIANT_BOOL bImport);
 
        [id(29), propput, helpstring("property PreConnectReminderResponse.  Call this with the user response to the pre-connect reminder.")] 
        HRESULT PreConnectReminderResponse([in] VARIANT_BOOL bResponse);
 
        [id(99), propget, helpstring("property VpnStatsTranslatedLabel.  Allows for pre-fetching translated labels for various VPN statistics prior to obtaining an IVpnStats interface")] 
        HRESULT VpnStatsTranslatedLabel([in] enum VPNStatsTag eVPNStatsTag, [out, retval] BSTR* pstrTranslatedLabel);
 
        
        //methods used to obtain the registry key and value to query to determine when a vpn software upgrade is completed.
        //
        [id(998), propget, helpstring("property UpgradeRegistryKeyName.  returns the name of the registry key to monitor for core software upgrade completions.")]
        HRESULT UpgradeRegistryKeyName([out, retval] BSTR* pstrUpgradeRegistryKeyName);
        [id(999), propget, helpstring("property UpgradeRegistryValueName.  returns the name of the registry value to query for core software upgrade completions when the key change is notified.")]
        HRESULT UpgradeRegistryValueName([out, retval] BSTR* pstrUpgradeRegistryValueName);
    };
 
    /**
    * interface IVpnApiEvents
    * Cisco Secure Client - AnyConnect VPN API Event Callback IDispatch interface specification.  This is the VPN API COM Event Callback interface that a developer implements and passes to the COM Server using the Attach, RegisterAndAttach, or indirectly via connection points in languages such as C#.
    */
    [
        object,
        uuid(5D446DC1-A494-4D3D-B5AD-0ADACB3B3EE3),
        oleautomation,
        nonextensible,
        dual,
        helpstring("Cisco Secure Client - AnyConnect VPN API IVpnApiEvents callback Interface specification.  A user of the VpnApi COM Server provides this interface to receive event notifications."),
        pointer_default(unique)
    ]
    interface IVpnApiEvents : IDispatch
    { 
        [id(1000), helpstring("method VpnStatsNotification.  Callback containing a IVpnStats object to be queried for stats.")] 
        HRESULT VpnStatsNotification([in] IVpnStats * pVpnStats);
 
        [id(1001), helpstring("method VpnStateNotification.  Callback containing the state of the VPN session")]
        HRESULT VpnStateNotification([in] enum VPNState eState, [in] enum VPNSubState eSubState, [in] BSTR strState);
 
        [id(1002), helpstring("method VpnBannerNotification.  Callback containing a Banner notification string.")]
        HRESULT VpnBannerNotification([in] BSTR strBannerMessage);
 
        [id(1003), helpstring("method VpnStateNotification.  Callback containing a notice pertaining to the VPN session")]
        HRESULT VpnNoticeNotification([in] BSTR strNoticeMessage, [in] enum MessageType eMessageType);
 
        [id(1004), helpstring("method VpnExitNotification.  Callback containing a notice indicating to shutdown the VPN API release to COM component.")]
        HRESULT VpnExitNotification([in] BSTR strExitMessage, [in] long exitCode);
 
        [id(1005), helpstring("method VpnServiceReadyNotification.  Callback indicating the VPN Service is online")] /*this could be a prop_put*/
        HRESULT VpnServiceReadyNotification();
 
        [id(1006), helpstring("method VpnUserPromptNotification.  Callback indicating the VPN Service is online")] /*this could be a prop_put*/
        HRESULT VpnUserPromptNotification([in] IConnectPromptInfo * pConnectPromptInfo);
 
        [id(1007), helpstring("method VpnWMHintNotification.  Callback containing UI behavior hint and reason.")]
        HRESULT VpnWMHintNotification([in] enum WMHint eHint, [in] enum WMHintReason eReason);
 
        [id(1008), helpstring("method VpnWebLaunchHostNotification.  Callback containing the Active Host pertaining to the VPN session")]
        HRESULT VpnWebLaunchHostNotification([in] BSTR strActiveHost);
 
        [id(1009), helpstring("method VpnEventAvailableNotification.  Callback indicating an API Event is available to consume.  This notification is sent only if configured to use the consumer-driven event model.  A COM user then calls IVpnApi::ProcessEvents.")]/*this could be a prop_put*/
        HRESULT VpnEventAvailableNotification();
 
        [id(1010), helpstring("method VpnCertBlockedNotification.  Callback indicating strUntrustedServer is an untrusted server.")]
        HRESULT VpnCertBlockedNotification([in] BSTR strUntrustedServer);
 
        [id(1011), helpstring("method VpnCertWarningNotification.  Callback indicating strUntrustedServer is an untrusted server because of the certificate errors in pCertErrors.")]
        HRESULT VpnCertWarningNotification([in] BSTR strUntrustedServer, [in] IStringCollection *pCertErrors, [in] VARIANT_BOOL bImportAllowed);
 
        [id(1012), helpstring("method VpnPreConnectReminderNotification.  Callback containing a pre-connect reminder notification string.")]
        HRESULT VpnPreConnectReminderNotification([in] BSTR strPreConnectReminderMessage);
    };
 
    /**
    * interface IVpnStats
    * Cisco Secure Client - AnyConnect VPN API Statistics IDispatch interface specification.  This is a non-creatable interface that is passed to via an Event Callback method and represents a VPN Statistics object.
    */
    [
        object,
        uuid(42B1B1F3-5E1E-4d5d-9C59-2E484C726CE6),
        oleautomation,
        nonextensible,
        dual,
        helpstring("Cisco Secure Client - AnyConnect VPN API IVpnStats Interface specification."),
        pointer_default(unique)
    ]
    interface IVpnStats : IDispatch
    { 
        [id(100), propget, helpstring("property SecureRoutes.  Obtains a collection of IRouteInfo interface instances.")] 
        HRESULT SecureRoutes([out, retval] IInterfaceCollection** ppSecureRouteInfoCollection);
        
        [id(101), propget, helpstring("property NonsecureRoutes.  Obtains a collection of IRouteInfo interface instances.")] 
        HRESULT NonsecureRoutes([out, retval] IInterfaceCollection** ppNonsecureRouteInfoCollection);
        
        [id(102), propget, helpstring("property ProtocolInfo.  Obtains a collection of IProtocolInfo interface instances.")] 
        HRESULT ProtocolInfo([out, retval] IInterfaceCollection** ppProtocolInfoCollection);
        
        [id(103), propget, helpstring("property FirewallInfo.  Obtains a collection of IFirewallInfo interface instances.")] 
        HRESULT FirewallInfo([out, retval] IInterfaceCollection** ppFirewallInfoCollection);
        
        [id(DISPID_VALUE), propget, helpstring("property StatValue.  Obtains the value for various VPN statistics associated IVpnStats interface. (NOTE: This is functionally the same as GetVpnStatsTranslatedLabel.)")] 
        HRESULT StatValue([in] enum VPNStatsTag eVPNStatsTag, [out,retval] BSTR* pstrStatValue);
 
        [id(104), propget, helpstring("property TranslatedLabel.  Obtains the translated labels for various VPN statistics associated IVpnStats interface. (NOTE: This is functionally the same as GetVpnStatsTranslatedLabel.)")] 
        HRESULT TranslatedLabel([in] enum VPNStatsTag eVPNStatsTag, [out,retval] BSTR* pstrTranslatedLabel);
    };
 
    /**
    * interface IConnectPromptInfo
    * Cisco Secure Client - AnyConnect VPN API Connection Prompt IDispatch interface specification.  This is a non-creatable interface that is passed to via an Event Callback method and represents a VPN Connect Prompt Information object.
    */
    [
        object,
        uuid(811A60FE-D3E0-4fe6-B627-30723A93554C),
        oleautomation,
        nonextensible,
        dual,
        helpstring("Cisco Secure Client - AnyConnect VPN API IConnectPromptInfo Interface specification."),
        pointer_default(unique)
    ]
    interface IConnectPromptInfo : IDispatch
    { 
        [id(200), propget, helpstring("property ConnectPromptType.  The type of prompt entry.")] 
        HRESULT ConnectPromptType([out, retval] enum ConnectPromptType* peConnectPromptType);
 
        [id(201), propget, helpstring("property CountPromptEntry.  The number of prompt entries in the collection.")] 
        HRESULT CountPromptEntry([out, retval] unsigned long* pulEntryCount);
        
        [id(202), propget, helpstring("property Message.  Provides a message associated with the credentials being entered.")] 
        HRESULT Message([out, retval] BSTR* pMessage);
        
        [id(203), propget, helpstring("property PromptNames.  Obtains a collection of prompt name strings if available.")] 
        HRESULT PromptNames([out, retval] IStringCollection** ppPromptNamesCollection);
 
        [id(DISPID_VALUE), propget, helpstring("property PromptEntry. Obtains a prompt entry based on a tag value provided.")]
        HRESULT PromptEntry([in] BSTR strPromptName, [out, retval] IPromptEntry ** ppPromptEntry);
 
        [id(205), propget, helpstring("property PromptEntries.  Obtains a collection of prompt entries.")] 
        HRESULT PromptEntries([out, retval] IInterfaceCollection** ppPromptEntriesCollection);
 
        [id(206), propget, helpstring("property HasAuthenticationError.  Indicates whether an authentication error has occurred.")]
        HRESULT HasAuthenticationError([out, retval] VARIANT_BOOL* pbAuthErr);
        
        [id(207), propget, helpstring("property SubmitButtonName. Provides the name to be used for the Submit Button.")] 
        HRESULT SubmitButtonName([out, retval] BSTR* pstrSubmitButton);
        
        [id(208), propget, helpstring("property HasEnrollmentCA. Indicates an Enrollment CA is available.")] 
        HRESULT HasEnrollmentCA([out, retval] VARIANT_BOOL* pbCAAvailable);
        
        [id(209), propput, helpstring("property UseEnrollmentCA.  Inform the VPN API to use the Enrollement CA.")] 
        HRESULT UseEnrollmentCA([in] VARIANT_BOOL bUseCA);
        
        [id(210), propput, helpstring("property TunnelGroup.  Allows the setting of the currently selected Tunnel group")] 
        HRESULT TunnelGroup([in] BSTR strSelectedTunnelGroup);
 
        [id(211), propget, helpstring("property IsCanceled.  Indicates if the user has canceled the prompt.")] 
        HRESULT IsCanceled([out, retval] VARIANT_BOOL* pbIsCanceled);
 
        [id(212), propput, helpstring("property Canceled.  Inform the VPNAPI that the user has canceled the prompt.")] 
        HRESULT Canceled([in] VARIANT_BOOL bIsCanceled);
    };
 
    /**
    * interface IVpnStats
    * Cisco Secure Client - AnyConnect VPN API Prompt Entry IDispatch interface specification.  This is a non-creatable interface that is contains Prompt Entry information.
    */
    [
        object,
        uuid(548A1F06-AECE-4506-8ABB-5E3D3A99B67B),
        oleautomation,
        nonextensible,
        dual,
        helpstring("Cisco Secure Client - AnyConnect VPN API IPromptEntry Interface specification."),
        pointer_default(unique)
    ]
    interface IPromptEntry : IDispatch
    { 
        [id(301), propget, helpstring("property Value. Gets the current value for the prompt entry.")] 
        HRESULT Value([out, retval] BSTR* pstrValue);
 
        [id(301), propput, helpstring("property Value.  Sets a value explicitly for a prompt entry.")] 
        HRESULT Value([in] BSTR strValue);
 
        [id(302), propget, helpstring("property PromptName.  This is the non-translated prompt.")] 
        HRESULT PromptName([out, retval] BSTR* pstrPromptName);
 
        [id(303), propget, helpstring("property PromptLabel.  This is the translated prompt.")] 
        HRESULT PromptLabel([out, retval] BSTR* pstrPromptLabel);
 
        [id(304), propget, helpstring("property PromptType.  Obtains the type of prompt (for example, password), etc.")] 
        HRESULT PromptType([out, retval] enum PromptType* pPromptType);
 
        [id(305), propget, helpstring("property IsEnabled.  Indicates whether this should be user editable.")] 
        HRESULT IsEnabled([out, retval] VARIANT_BOOL* pbIsEnabled);
 
        [id(306), propget, helpstring("property IsVisible.  Indicates whether this should be displayed to the user.")] 
        HRESULT IsVisible([out, retval] VARIANT_BOOL* pbIsVisible);
 
        [id(307), propget, helpstring("property ValueOptions.  Obtains a collection of value option strings.")] 
        HRESULT ValueOptions([out, retval] IStringCollection** ppValueOptionsCollection);
 
        [id(308), propget, helpstring("property IsEntryGroup")] 
        HRESULT IsEntryGroup([out, retval] VARIANT_BOOL* pbIsEntryGroup);
    };
 
    /**
    * interface IRouteInfo
    * Cisco Secure Client - AnyConnect VPN API Route Information IDispatch interface specification.  This is a non-creatable interface that represents a Route Information object.
    */
    [
        object,
        uuid(02E2AE5E-A8C8-458e-92B0-B72B322B623C),
        oleautomation,
        nonextensible,
        dual,
        helpstring("Cisco Secure Client - AnyConnect VPN API IRouteInfo Interface specification."),
        pointer_default(unique)
    ]
    interface IRouteInfo : IDispatch
    { 
        [id(401), propget, helpstring("property Network route")] 
        HRESULT Network([out, retval] BSTR* pstrNetwork);
 
        [id(402), propget, helpstring("property Subnet for the route.")] 
        HRESULT Subnet([out, retval] BSTR* pstrSubnet);
    };
 
    /**
    * interface IProtocolInfo
    * Cisco Secure Client - AnyConnect VPN API Protocol Information IDispatch interface specification.  This is a non-creatable interface that represents a Protocol Information object.
    */
    [
        object,
        uuid(A0D63CA4-68E6-44e8-8738-19D6E4BC82BE),
        oleautomation,
        nonextensible,
        dual,
        helpstring("Cisco Secure Client - AnyConnect VPN API IProtocolInfo Interface specification."),
        pointer_default(unique)
    ]
    interface IProtocolInfo : IDispatch
    { 
        [id(501), propget, helpstring("property ProtocolLabel.  Obtain a protocol label string from the enumerated type.")] 
        HRESULT ProtocolLabel([in] enum ProtocolInfoTag eProtocolInfoTag, 
                              [out, retval] BSTR* pstrProtocolLabel);
 
        [id(DISPID_VALUE), propget, helpstring("property ProtocolValue.  Obtain a protocol value string from the enumerated type.")] 
        HRESULT ProtocolValue([in] enum ProtocolInfoTag eProtocolInfoTag, 
                              [out, retval] BSTR* pstrProtocolValue);
 
        [id(503), propget, helpstring("property IsActive.  Indicates if the protocol is active.")] 
        HRESULT IsActive([out, retval] VARIANT_BOOL * pbIsActive);
    };
 
    /**
    * interface IFirewallInfo
    * Cisco Secure Client - AnyConnect VPN API Firewall Information IDispatch interface specification.  This is a non-creatable interface that represents a Firweall Information object containing firewall rule information.
    */
    [
        object,
        uuid(F71DC93F-C07D-44a3-95B4-864177AE0F7E),
        oleautomation,
        nonextensible,
        dual,
        helpstring("Cisco Secure Client - AnyConnect VPN API IFirewallInfo Interface specification."),
        pointer_default(unique)
    ]
    interface IFirewallInfo : IDispatch
    { 
        [id(541), propget, helpstring("property Permission of a firewall rule")] 
        HRESULT Permission([out, retval] BSTR* pstrPermission);
 
        [id(542), propget, helpstring("property Protocol for a firewall rule.")] 
        HRESULT Protocol([out, retval] BSTR* pstrProtocol);
 
        [id(543), propget, helpstring("property Interface for a firewall rule.")] 
        HRESULT Interface([out, retval] BSTR* pstrInterface);
 
        [id(544), propget, helpstring("property Source Port Range for a firewall rule.")] 
        HRESULT SrcPortRange([out, retval] BSTR* pstrSrcPortRange);
 
        [id(545), propget, helpstring("property Destination Port Range for a firewall rule.")] 
        HRESULT DstPortRange([out, retval] BSTR* pstrDstPortRange);
 
        [id(546), propget, helpstring("property Destination Address for a firewall rule.")] 
        HRESULT DstAddr([out, retval] BSTR* pstrDstAddr);
    };
 
 
    /**
    * interface IPreferenceInfo
    * Cisco Secure Client - AnyConnect VPN API User Preference Information IDispatch interface specification.  This is a non-creatable interface that represents a User Preference Information object.
    */
    [
        object,
        uuid(3E73BCCD-C4E4-4842-AB58-9F973E7D226F),
        oleautomation,
        nonextensible,
        dual,
        helpstring("Cisco Secure Client - AnyConnect VPN API IPreferenceInfo Interface specification."),
        pointer_default(unique)
    ]
    interface IPreferenceInfo : IDispatch
    {
        [id(601), propget, helpstring("property CountPreferences.  The number of preferences available.")]
        HRESULT CountPreferences([out, retval] unsigned long * pulCountPreferences);
  
        [id(DISPID_VALUE), propget, helpstring("property Preference.  Gets the instance of an IPreference interface associated with the preference tag.")]
        HRESULT Preference([in] enum PreferenceId ePreferenceId, [out, retval] IPreference** ppPreference);
 
        [id(603), propget, helpstring("property Preferences.  Obtains a collection of IPreference interface instances.")] 
        HRESULT Preferences([out, retval] IInterfaceCollection** ppPreferencesCollection);
 
        [id(604), propget, helpstring("property PreferenceHeading.  The heading string for preferences.")]
        HRESULT PreferenceHeading([out, retval] BSTR * pstrPreferenceHeading);
    };
 
    /**
    * interface IPreference
    * Cisco Secure Client - AnyConnect VPN API Usser Preference IDispatch interface specification.  This is a non-creatable interface that represents a User Preference object.
    */
    [
        object,
        uuid(01F3D78C-AC49-48d1-8782-0EB481961341),
        oleautomation,
        nonextensible,
        dual,
        helpstring("Cisco Secure Client - AnyConnect VPN API IPreference Interface specification."),
        pointer_default(unique)
    ]
    interface IPreference : IDispatch
    {
        [id(701), propget, helpstring("property PreferenceValue. Gets the current value for the preference entry.")] 
        HRESULT PreferenceValue([out, retval] BSTR* pstrPreferenceValue);
 
        [id(701), propput, helpstring("property PreferenceValue. Sets the value explicitly for a preference entry.")] 
        HRESULT PreferenceValue([in] BSTR strPreferenceValue);
        
        [id(703), propget, helpstring("property PreferenceId. Gets the preference identifier enumeration value for the preference entry.")] 
        HRESULT PreferenceId([out, retval] enum PreferenceId * pPreferenceId);
 
        [id(704), propget, helpstring("property Children.  Obtains a collection of IPreference interface instances that are sub-entries of this preference.")] 
        HRESULT Children([out, retval] IInterfaceCollection** ppChildPreferencesCollection);
 
        [id(705), propget, helpstring("property PromptEntry. Obtains a prompt entry instance associated with this preference.")]
        HRESULT PromptEntry([out, retval] IPromptEntry ** ppPromptEntry);
    };
 
 
    //Collection interfaces//
 
    /**
    * interface IStringCollection
    * Cisco Secure Client - AnyConnect VPN API String Collection IDispatch interface specification.  This is a non-creatable interface that represents a Collection of Strings.
    */
    [
        object,
        uuid(6292ECAC-42CD-43ea-A96C-0C072772B4BE),
        oleautomation,
        nonextensible,
        dual,
        helpstring("Cisco Secure Client - AnyConnect VPN API Utility String Collection Interface specification."),
        pointer_default(unique)
    ]
    interface IStringCollection : IDispatch
    {
        [id(DISPID_NEWENUM), propget, helpstring("method _NewEnum.  Obtains a new String Collection enumerator interface.")]
        HRESULT _NewEnum([out, retval] IUnknown** ppUnk);
 
        [id(DISPID_VALUE), propget, helpstring("property Item.  Obtains a string object in the collection.  NOTE: collections are 1's based indexing.")]
        HRESULT Item([in] long nIndex, [out, retval] BSTR* pString);
 
        [id(1), propget, helpstring("property Count.  Obtains the count of the number of objects in the collection.")] 
        HRESULT Count([out, retval] long * pCount);
    };
 
    /**
    * interface IStringCollection
    * Cisco Secure Client - AnyConnect VPN API Interface Collection IDispatch interface specification.  This is a non-creatable interface that represents a Collection of Interface instances of objects.
    */
    [
        object,
        uuid(E0854B5E-16D3-46b5-8767-420EB1F48041),
        oleautomation,
        nonextensible,
        dual,
        helpstring("Cisco Secure Client - AnyConnect VPN API Utility IUnknown Collection Interface specification."),
        pointer_default(unique)
    ]
    interface IInterfaceCollection : IDispatch
    {
        [id(DISPID_NEWENUM), propget, helpstring("property _NewEnum.  Obtains a new Interface Collection enumerator interface.")]
        HRESULT _NewEnum([out, retval] IUnknown** ppUnk);
 
        [id(DISPID_VALUE), propget, helpstring("property Item.  Obtains an IUnknown interface for an object in the collection.  The user would then QI for the actual interface they wanted to obtain.  NOTE: collections are 1's based indexing.")]
        HRESULT Item([in] long nIndex, [out, retval] IUnknown** ppInterface);
 
        [id(1), propget, helpstring("property Count.  Obtains the count of the number of objects in the collection.")] 
        HRESULT Count([out, retval] long * pCount);
    };
 
/////////////////////////////////////// VPN API Type Library //////////////////////////////////////
[
    uuid(C15C09AE-FCCE-9221-FFA2-7465FEAAE55A),
    version(1.0),
    helpstring("Cisco Secure Client - AnyConnect VPN API 1.0 Type Library")
]
library VpnApiLib
{
    importlib("stdole32.tlb");
    importlib("stdole2.tlb");
 
    [
        uuid(C15C0F4F-DDFB-4591-AD53-C9A71C9C15C0),
        helpstring("VpnApi Class")
    ]
    coclass VpnApi
    {
        [default] interface IVpnApi;
        [default, source] dispinterface IVpnApiEvents;
    };
 
    interface IRouteInfo;
    interface IProtocolInfo;
    interface IFirewallInfo;
    enum RegValueUpgradeCodesTag;
}
 
/** @} */