lineGetAgentSessionList

The lineGetAgentSessionList function returns a list of agent sessions created for the specified agent. It generates a LINE_PROXYREQUEST message to be sent to a registered proxy function handler, referencing a LINEPROXYREQUEST structure of type LINEPROXYREQUEST_GETAGENTSESSIONLIST.

LONG lineGetAgentSessionList(              
  HLINE hLine,                             
  HAGENT hAgent,             
  LPLINEAGENTSESSIONLIST lpAgentSessionList
);

Parameters

hLine

A handle to the line device.

hAgent

The identifier of the agent whose information is to be retrieved.

lpAgentSessionList

A pointer to a variably sized structure of type LINEAGENTSESSIONLIST. Upon successful completion of the request, this structure is filled with a list of the agent sessions that have been created for this agent. Prior to calling the lineGetAgentSessionList function, the application should set the dwTotalSize member of this structure to indicate the amount of memory available to TAPI for returning information.

Return Values

Returns a request identifier if the asynchronous operation starts; otherwise, the function returns one of the following error values:

LINEERR_INVALLINEHANDLE
LINEERR_INVALPARAM
LINEERR_NOMEM
LINEERR_OPERATIONFAILED
LINEERR_OPERATIONUNAVAIL
LINEERR_RESOURCEUNAVAIL
LINEERR_UNINITIALIZED

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Version: Requires TAPI 2.2 or later.
  Header: Declared in Tapi.h.
  Library: Use Tapi32.lib.

See Also

About TAPI 3.0 Call Center Controls, LINEAGENTSESSIONLIST, lineGetAgentSessionList, LINEPROXYREQUEST, LINE_PROXYREQUEST