lineGetAgentInfo function (tapi.h)

Article
02/22/2024

The lineGetAgentInfo function returns a structure holding the ACD information associated with a particular agent handle. It generates a LINE_PROXYREQUEST message to be sent to a registered proxy function handler, referencing a LINEPROXYREQUEST structure of type LINEPROXYREQUEST_GETAGENTINFO.

Syntax

LONG lineGetAgentInfo(
  HLINE           hLine,
  HAGENT          hAgent,
  LPLINEAGENTINFO lpAgentInfo
);

Parameters

hLine

Handle to the line device.

hAgent

Identifier of the agent whose information is to be retrieved.

lpAgentInfo

Pointer to a structure of type LINEAGENTINFO. If the request succeeds, this structure is filled with the agent statistics.

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.

Remarks

Prior to calling the lineGetAgentInfo function, the application should set the dwTotalSize member of the LINEAGENTINFO structure to indicate the amount of memory available to TAPI for returning information.

Requirements

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