WS_CHANNEL_STATE enumeration (webservices.h)

  • Article

The different states that a channel can be in.

Syntax

typedef enum {
  WS_CHANNEL_STATE_CREATED = 0,
  WS_CHANNEL_STATE_OPENING = 1,
  WS_CHANNEL_STATE_ACCEPTING = 2,
  WS_CHANNEL_STATE_OPEN = 3,
  WS_CHANNEL_STATE_FAULTED = 4,
  WS_CHANNEL_STATE_CLOSING = 5,
  WS_CHANNEL_STATE_CLOSED = 6
} WS_CHANNEL_STATE;

Constants

 
WS_CHANNEL_STATE_CREATED
Value: 0
WS_CHANNEL_STATE_OPENING
Value: 1
WS_CHANNEL_STATE_ACCEPTING
Value: 2
WS_CHANNEL_STATE_OPEN
Value: 3
WS_CHANNEL_STATE_FAULTED
Value: 4
WS_CHANNEL_STATE_CLOSING
Value: 5
WS_CHANNEL_STATE_CLOSED
Value: 6

Remarks

The following are the state transitions for a channel.

Diagram of the state transitions for a Channel object. A second diagram shows the Sub-states for the Channel's Open state.

A channel may move to the WS_CHANNEL_STATE_FAULTED state even if WsAbortChannel was never called. This will only occur if the channel can no longer be used.

Note that only the valid state transitions are shown. Using a function not shown for a given state will result in an WS_E_INVALID_OPERATION error being returned from the function (or crash in the case of WsFreeChannel). For information on error codes, seeWindows Web Services Return Values.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Header webservices.h