ITAgent::get_AgentSessions method (tapi3.h)

Article
02/22/2024

The get_AgentSessions method creates a collection of current agent sessions. This method is provided for Automation client applications, such as those written in Visual Basic. C and C++ applications must use the EnumerateAgentSessions method.

Syntax

HRESULT get_AgentSessions(
  [out] VARIANT *pVariant
);

Parameters

[out] pVariant

Pointer to VARIANT containing an ITCollection of ITAgentSession interface pointers (agent session objects).

Return value

This method can return one of these values.

Value	Meaning
S_OK	Method succeeded.
E_POINTER	The pVariant parameter is not a valid pointer.
E_OUTOFMEMORY	Insufficient memory exists to perform the operation.

Remarks

TAPI calls the AddRef method on the ITAgentSession interface returned by ITAgent::get_AgentSessions. The application must call Release on the ITAgentSession interface to free resources associated with it.

Requirements

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