ITAgent::get_State method (tapi3.h)

The get_State method gets the state of an agent session.

Syntax

HRESULT get_State(
  [out] AGENT_STATE *pAgentState
);

Parameters

[out] pAgentState

Pointer to an AGENT_STATE.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_POINTER
The pAgentState parameter is not a valid pointer.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.

Requirements

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

See also

AGENT_STATE

ITAgent

put_State