Platform SDK: TAPI

ITAgent::EnumerateAgentSessions

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.

HRESULT EnumerateAgentSessions(
  IEnumAgentSession **ppEnumAgentSession
);

Parameters

ppEnumAgentSession
[out, retval] Pointer to an IEnumAgentSession agent session enumerator.

Return 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.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Version: Requires TAPI 3.0 or later.
  Header: Declared in Tapi3.h.
  Library: Use T3iid.lib.

See Also

ITAgent, ITAgentSession, IEnumAgentSession, ITAgent::CreateSession, ITAgent::CreateSessionWithPIN, get_AgentSessions