Edit

lineGetAgentSessionList function (tapi.h)

  • Article

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.

Syntax

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

Parameters

hLine

Handle to the line device.

hAgent

Identifier of the agent whose information is to be retrieved.

lpAgentSessionList

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 must set the dwTotalSize member of this structure to indicate the amount of memory available to TAPI for returning information.

Note  If the size parameters in the structure are not correct, there is a possibility that memory could get overwritten. For more information on setting structure sizes, see the memory allocation topic.
 

Return value

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

Requirement Value
Target Platform Windows
Header tapi.h
Library Tapi32.lib
DLL Tapi32.dll

See also

About Call Center Controls

LINEAGENTSESSIONLIST

LINEPROXYREQUEST

LINE_PROXYREQUEST