Edit

Share via

CONTROL_CHANNEL_TRIGGER_STATUS enumeration (mstcpip.h)

  • Article

The CONTROL_CHANNEL_TRIGGER_STATUS enumeration specifies the status from a query for the REAL_TIME_NOTIFICATION_CAPABILITY transport setting for a TCP socket that is used with ControlChannelTrigger to receive background network notifications in a Windows Store app.

Syntax

typedef enum {
  CONTROL_CHANNEL_TRIGGER_STATUS_INVALID = 0,
  CONTROL_CHANNEL_TRIGGER_STATUS_SOFTWARE_SLOT_ALLOCATED = 1,
  CONTROL_CHANNEL_TRIGGER_STATUS_HARDWARE_SLOT_ALLOCATED = 2,
  CONTROL_CHANNEL_TRIGGER_STATUS_POLICY_ERROR = 3,
  CONTROL_CHANNEL_TRIGGER_STATUS_SYSTEM_ERROR = 4,
  CONTROL_CHANNEL_TRIGGER_STATUS_TRANSPORT_DISCONNECTED = 5,
  CONTROL_CHANNEL_TRIGGER_STATUS_SERVICE_UNAVAILABLE = 6
} CONTROL_CHANNEL_TRIGGER_STATUS, *PCONTROL_CHANNEL_TRIGGER_STATUS;

Constants

 
CONTROL_CHANNEL_TRIGGER_STATUS_INVALID
Value: 0
Status is invalid.
CONTROL_CHANNEL_TRIGGER_STATUS_SOFTWARE_SLOT_ALLOCATED
Value: 1
A software slot was allocated for the ControlChannelTrigger.
CONTROL_CHANNEL_TRIGGER_STATUS_HARDWARE_SLOT_ALLOCATED
Value: 2
A hardware slot was allocated for the ControlChannelTrigger.
CONTROL_CHANNEL_TRIGGER_STATUS_POLICY_ERROR
Value: 3
A status policy error.
CONTROL_CHANNEL_TRIGGER_STATUS_SYSTEM_ERROR
Value: 4
A status system error.
CONTROL_CHANNEL_TRIGGER_STATUS_TRANSPORT_DISCONNECTED
Value: 5
The TCP transport is disconnected.
CONTROL_CHANNEL_TRIGGER_STATUS_SERVICE_UNAVAILABLE
Value: 6
Service is unavailable.

Remarks

The CONTROL_CHANNEL_TRIGGER_STATUS structure is supported on Windows 8, and Windows Server 2012, and later versions of the operating system.

A CONTROL_CHANNEL_TRIGGER_STATUS enumeration value is returned as output from the SIO_QUERY_TRANSPORT_SETTING IOCTL to a query the REAL_TIME_NOTIFICATION_CAPABILITY transport setting for a TCP socket that is used with ControlChannelTrigger to receive background network notifications in a Windows Store app.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Header mstcpip.h

See also

ControlChannelTrigger

REAL_TIME_NOTIFICATION_SETTING_OUTPUT

SIO_APPLY_TRANSPORT_SETTING

SIO_QUERY_TRANSPORT_SETTING