CM_POLICY_CONFIG_DATA (Compact 2013)

  • Article

3/26/2014

This structure describes the policy data for a connection configuration.

Syntax

typedef struct CM_POLICY_CONFIG_DATA
{
    DWORD Version;
    CM_POLICY_TYPE Type;
    union
    {
        struct
        {
            BOOL fUseConnectionsInOrder;
            DWORD cConnection;
            CM_CONNECTION_SELECTION Connection[1];
        } ConnectionMappings;

        struct
        {
            BOOL fEnable;
        } RoamingConnections;

        struct
        {
            DWORD cConnection;
            CM_CONNECTION_SELECTION Connection[1];
        } DisabledConnections;        
    };
} CM_POLICY_CONFIG_DATA;

Members

  • ConnectionMappings

    • fUseConnectionsInOrder
      Specifies whether the order in which the connections are listed must be enforced.

      TRUE: Enforce the order in which connections are listed. The connections are listed in preference order, from most preferred to least preferred, and this order must be followed when constructing a candidate list of connections for an application. When this flag is set to TRUE, potential performance optimizations based on reordering of the list of candidate connections is disabled.

      FALSE: Do not enforce the order.

    • cConnection
      The number of connections in the list.

    • Connection
      An instance of a CM_CONNECTION_SELECTION structure.

      Connection specifies the connections associated with the given key and cConnection specifies the count of those connections. The list of connections can contain any connection, including always-connected and on-demand connections.

      An application’s candidate list of connections includes all connections listed in the policy that are available at the time of candidate list construction. Availability of connection is determined by connection state, enabled/disabled setting, resources, and other factors. Connections can be specified by one of the following, defined in CM_CONNECTION_SELECTION_TYPE:

      • CMST_CONNECTION_ALL
      • CMST_CONNECTION_NAME
      • CMST_CONNECTION_TYPE
      • CMST_CONNECTION_DEVICE_TYPE
      • CMST_CONNECTION_NETWORK_TYPE
      • CMST_LAST

  • RoamingConnections

    • fEnable
      Specifies whether roaming connections are enabled or disabled. By default, roaming connections are disabled. If TRUE, roaming connections are enabled. If FALSE, roaming connections are disabled.

  • DisabledConnections

    • cConnection
      Same as in ConnectionMappings.
    • Connection
      Same as in ConnectionMappings.

Requirements

Header

cmnet.h

See Also

Reference

Connection Manager Policy Structures
CM_POLICY_CONFIG_DATA