Edit

TCP_BOOLEAN_OPTIONAL enumeration (tcpestats.h)

  • Article

The TCP_BOOLEAN_OPTIONAL enumeration defines the states that a caller can specify when updating a member in the read/write information for a TCP connection.

Syntax

typedef enum _TCP_BOOLEAN_OPTIONAL {
  TcpBoolOptDisabled = 0,
  TcpBoolOptEnabled,
  TcpBoolOptUnchanged = -1
} TCP_BOOLEAN_OPTIONAL, *PTCP_BOOLEAN_OPTIONAL;

Constants

 
TcpBoolOptDisabled
Value: 0
The option should be disabled.
TcpBoolOptEnabled
The option should be enabled.
TcpBoolOptUnchanged
Value: -1
The option should be unchanged.

Remarks

The TCP_BOOLEAN_OPTIONAL enumeration is defined on Windows Vista and later.

The collection of extended statistics on a TCP connection are enabled and disabled using calls to the SetPerTcp6ConnectionEStats and SetPerTcpConnectionEStats functions where the type of extended statistics specified is one of values from the TCP_ESTATS_TYPE enumeration type. A value from the TCP_BOOLEAN_OPTIONAL enumeration is used to specify how a member in the TCP_ESTATS_BANDWIDTH_RW_v0 structure should be updated to enable or disable extended statistics on a TCP connection for bandwidth estimation.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Header tcpestats.h

See also

SetPerTcp6ConnectionEStats

SetPerTcpConnectionEStats

TCP_ESTATS_BANDWIDTH_RW_v0

TCP_ESTATS_TYPE