lineGetAgentActivityList

The lineGetAgentActivityList function obtains the identities of activities that the application can select using lineSetAgentActivity to indicate what function the agent is actually performing at the moment.

LONG lineGetAgentActivityList(
  HLINE hLine,                                 
  DWORD dwAddressID,                           
  LPLINEAGENTACTIVITYLIST lpAgentActivityList  
);
 

Parameters

hLine

A handle to the open line device.

dwAddressID

The address on the open line device whose agent status is to be queried.

lpAgentAcvitityList

A pointer to a variably sized structure of type LINEAGENTACTIVITYLIST. Upon successful completion of the request, this structure is filled with a list of the agent activity codes that can be selected using lineSetAgentActivity. Prior to calling lineGetAgentActivityList, 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_INVALADDRESSID, LINEERR_OPERATIONFAILED, LINEERR_INVALAGENTID, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALLINEHANDLE, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALPOINTER, LINEERR_STRUCTURETOOSMALL, LINEERR_NOMEM, LINEERR_UNINITIALIZED.

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, LINEAGENTACTIVITYLIST, lineSetAgentActivity