Platform SDK: TAPI

ITAgentSession::put_State

Sets the state of the agent session.

HRESULT put_State(
  AGENT_SESSION_STATE SessionState
);

Parameters

SessionState
[in] AGENT_SESSION_STATE.

Return Values

Value Meaning
S_OK Method succeeded.
E_OUTOFMEMORY Insufficient memory exists to perform the operation.
E_INVALIDARG The SessionState parameter is not a valid session state.
LINEERR_ See lineSetAgentSessionState for error codes returned from this TAPI 2.1 function.
TAPI_E_TIMEOUT The operation failed because the TAPI 3.0 DLL timed it out. The timeout interval is two minutes.

Remarks

This method wraps the TAPI 2.1 lineSetAgentSessionState function.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Version: Requires TAPI 3.0 or later.
  Header: Declared in Tapi3.h.
  Library: Use T3iid.lib.

See Also

ITAgentSession, get_State, lineSetAgentSessionState, AGENT_SESSION_STATE