lineGetAgentCaps

The lineGetAgentCaps function obtains the agent-related capabilities supported on the specified line device. If a specific agent is named, the capabilities include a listing of ACD groups into which the agent is permitted to log in.

LONG lineGetAgentCaps(
  HLINEAPP hLineApp,           
  DWORD dwDeviceID,            
  DWORD dwAddressID,           
  DWORD dwAppAPIVersion,       
  LPLINEAGENTCAPS lpAgentCaps  
);
 

Parameters

hLineApp

The handle to the application's registration with TAPI.

dwDeviceID

The line device containing the address to be queried.

dwAddressID

The address on the given line device whose capabilities are to be queried.

dwAppAPIVersion

The highest API version supported by the application. This should not be the value negotiated using lineNegotiateAPIVersion on the device being queried.

lpAgentCaps

A pointer to a variably sized structure of type LINEAGENTCAPS. Upon successful completion of the request, this structure is filled with agent capabilities information. Prior to calling lineGetAgentCaps, 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 positive request identifier if the asynchronous operation starts; otherwise, this function returns one of these negative error values:

LINEERR_BADDEVICEID, LINEERR_NOMEM, LINEERR_INCOMPATIBLEAPIVERSION, LINEERR_OPERATIONFAILED, LINEERR_INVALADDRESSID, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALAPPHANDLE, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALPOINTER, LINEERR_STRUCTURETOOSMALL, LINEERR_NODRIVER, LINEERR_UNINITIALIZED, LINEERR_NODEVICE.

QuickInfo

  Version: Use TAPI version 2.0 and later
  Header: Declared in tapi.h.
  Import Library: Link with tapi32.lib.

See Also

TAPI Reference Overview, Supplementary Line Services Functions, LINEAGENTCAPS, lineNegotiateAPIVersion