CM_NOTIFICATION (Compact 2013)

3/26/2014

This structure contains the details of a connection notification.

Syntax

typedef struct CM_NOTIFICATION {
    DWORD                Version;
    CM_NOTIFICATION_TYPE Type;
    union {
        struct {
            WCHAR szConnection[CM_CONNECTION_NAME_LENGTH];
            CM_CONNECTION_STATE State;
            CM_RESULT LastResult;
        } StateUpdate;

        struct {
            WCHAR szConnection[CM_CONNECTION_NAME_LENGTH];
            CM_CHARACTERISTIC Characteristic;
            DWORD Value;
        } CharacteristicUpdate;

        struct {
            WCHAR szConnection[CM_CONNECTION_NAME_LENGTH];
            CM_CONNECTION_NETWORK_TYPE Network;
        } NetworkUpdate;
                
        struct {
            WCHAR szConnection[CM_CONNECTION_NAME_LENGTH];
            DWORD cbData;
            BYTE  Data[1];
        } TypeSpecific;

        struct {
            WCHAR szConnection[CM_CONNECTION_NAME_LENGTH];
        } ConfigUpdate;

        struct {
            CM_SESSION_CONNECT_RETRY_REASON Reason;
        } Retry;

        struct {
            CM_SESSION_CONNECTION_SELECTION_PROGRESS_ACTION Action;
            WCHAR szConnection[CM_CONNECTION_NAME_LENGTH];
            CM_RESULT Result;
        } SelectionProgress;
    };
} CM_NOTIFICATION;

Members

  • StateUpdate
    This structure is used when the Type parameter is set to one of the following values.

    • CMNT_CONNECTION_STATE_CONNECTED
    • CMNT_CONNECTION_STATE_DISCONNECTED
    • CMNT_CONNECTION_STATE_LAST
  • StateUpdate.szConnection
    Description for this connection.
  • StateUpdate.LastResult
    Prior CM_RESULT enumeration value of the connection.
  • CharacteristicUpdate
    This structure is used when the Type parameter is set to CMNT_CHARACTERISTIC_UPDATE_LAST.
  • CharacteristicUpdate.szConnection
    Description for this connection.
  • CharacteristicUpdate.Characteristic
    The CM_CHARACTERISTIC enumeration value of the connection.
  • CharacteristicUpdate.Value
    Value of the Characteristic parameter of the connection.

    For example, if the Characteristic is CMCH_BANDWIDTH_KBITPS, this value could be 56000.

  • NetworkUpdate
    This structure is used when the Type parameter is set to CMNT_CONNECTION_NETWORK_TYPE_LAST.
  • NetworkUpdate.szConnection
    Description for this connection.
  • TypeSpecific
    This structure is used when the Type parameter is set to CMNT_CONNECTION_TYPE_SPECIFIC_LAST.
  • TypeSpecific.szConnection
    Description for this connection.
  • TypeSpecific.cbData
    Numeric connection type-specific data for this connection.
  • TypeSpecific.Data[1]
    Character connection type-specific data for this connection.
  • ConfigUpdate
    This structure is used when the Type parameter is set to one of the following values.

    • CMNT_CONNECTION_CONFIGURATION_ADDED
    • CMNT_CONNECTION_CONFIGURATION_UPDATED
    • CMNT_CONNECTION_CONFIGURATION_DELETED
    • CMNT_CONNECTION_CONFIGURATION_LAST
  • ConfigUpdate.szConnection
    Description for this connection.
  • Retry
    This structure is used when the Type parameter is set to CMNT_SESSION_CONNECT_RETRY_LAST.
  • SelectionProgress
    This structure is used when the Type parameter is set to

    CMNT_SESSION_CONNECTION_SELECTION_PROGRESS_LAST.

  • SelectionProgress.szConnection
    Description for this connection.
  • SelectionProgress.Result
    The CM_RESULT enumeration value of the connection.

Requirements

Header

cmnet.h

Library

cmnet.lib

See Also

Reference

Connection Manager Status and Notification Structures