ITAgent::EnumerateAgentSessions method (tapi3.h)

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

Syntax

HRESULT EnumerateAgentSessions(
  [out] IEnumAgentSession **ppEnumAgentSession
);

Parameters

[out] ppEnumAgentSession

Pointer to an IEnumAgentSession agent session enumerator.

Return value

This method can return one of these values.

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

Remarks

TAPI calls the AddRef method on the IEnumAgentSession interface returned by ITAgent::EnumerateAgentSessions. The application must call Release on the IEnumAgentSession 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

See also

IEnumAgentSession

ITAgent

ITAgent::CreateSession

ITAgent::CreateSessionWithPIN

ITAgentSession

get_AgentSessions