lineGetQueueInfo function (tapi.h)

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

Syntax

LONG lineGetQueueInfo(
  HLINE           hLine,
  DWORD           dwQueueID,
  LPLINEQUEUEINFO lpLineQueueInfo
);

Parameters

hLine

Handle to the line device.

dwQueueID

Identifier of the queue whose information is to be retrieved.

lpLineQueueInfo

Pointer to a structure of type LINEQUEUEINFO. Upon successful completion of the request, this structure is filled with the queue statistics. Prior to calling lineGetQueueInfo, 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 data 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

LINEPROXYREQUEST

LINEQUEUEINFO

LINE_PROXYREQUEST