lineGetGroupListA function (tapi.h)

Article
02/09/2023

The lineGetGroupList function returns a list of ACD groups available on the ACD system. It generates a LINE_PROXYREQUEST message to be sent to a registered proxy function handler, referencing a LINEPROXYREQUEST structure of type LINEPROXYREQUEST_GETGROUPLIST.

Syntax

LONG lineGetGroupListA(
  HLINE                hLine,
  LPLINEAGENTGROUPLIST lpGroupList
);

Parameters

hLine

Handle to the line device.

lpGroupList

Pointer to a variably sized structure of type LINEAGENTGROUPLIST. Upon successful completion of the request, this structure is filled with a list of the available ACD groups. Prior to calling the lineGetGroupList 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 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.

Remarks

Note

The tapi.h header defines lineGetGroupList as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

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