ITAgentSession::put_State method (tapi3.h)

The put_State method sets the state of the agent session.

Syntax

HRESULT put_State(
  [in] AGENT_SESSION_STATE SessionState
);

Parameters

[in] SessionState

AGENT_SESSION_STATE.

Return value

This method can return one of these values.

Return code	Description
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 DLL timed it out. The timeout interval is two minutes.

Remarks

This method wraps the TAPI 2.1 lineSetAgentSessionState function.

Requirements

Requirement	Value
Target Platform	Windows
Header	tapi3.h (include Tapi3.h)
Library	Uuid.lib
DLL	Tapi3.dll

See also

AGENT_SESSION_STATE

ITAgentSession

get_State

lineSetAgentSessionState