ITAgent::put_State method (tapi3.h)

The put_State method sets the state of an agent session.

Syntax

HRESULT put_State(
  [in] AGENT_STATE AgentState
);

Parameters

[in] AgentState

AGENT_STATE.

Return value

This method can return one of these values.

Return code	Description
S_OK	Method succeeded.
E_INVALIDARG	Agent session state is incorrect.
E_OUTOFMEMORY	Insufficient memory exists to perform the operation.
TAPI_E_TIMEOUT	The operation failed because the TAPI 3 DLL timed it out. The timeout interval is two minutes.

Remarks

The ITAgent::put_State method is a COM wrapper for the TAPI 2.1 lineSetAgentStateEx function.

Requirements

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

See also

AGENT_STATE

ITAgent

get_State