Platform SDK: TAPI

lineGetAgentSessionInfo

The lineGetAgentSessionInfo function returns a structure that holds the ACD information associated with a particular agent session handle. It generates a LINE_PROXYREQUEST message to be sent to a registered proxy function handler, referencing a LINEPROXYREQUEST structure of type LINEPROXYREQUEST_GETAGENTSESSIONINFO.

LONG lineGetAgentSessionInfo(               
  HLINE hLine,                              
  HAGENTSESSION hAgentSession,              
  LPLINEAGENTSESSIONINFO lpAgentSessionInfo 
);

Parameters

hLine
A handle to the line device.
hAgentSession
The identifier of the agent session whose information is to be retrieved.
lpAgentSessionInfo
A pointer to a structure of type LINEAGENTSESSIONINFO. Upon successful completion of the request, this structure is filled with the agent session statistics. Prior to calling the lineGetAgentSessionInfo 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, LINEAGENTSESSIONINFO, LINEPROXYREQUEST, LINE_PROXYREQUEST