Platform SDK: TAPI

lineSetAgentGroup

The lineSetAgentGroup function sets the agent groups into which the agent is logged into on a particular address.

LONG WINAPI lineSetAgentGroup(
  HLINE hLine,                           
  DWORD dwAddressID,                     
  LPLINEAGENTGROUPLIST lpAgentGroupList  
);

Parameters

hLine
Handle to the line device.
dwAddressID
Identifier of the address for which the agent information is to be changed. An address identifier is permanently associated with an address; the identifier remains constant across operating system upgrades.
lpAgentGroupList
Pointer to a LINEAGENTGROUPLIST structure identifying the groups into which the current agent is to be logged in on the address. If the pointer is NULL or the number of groups in the indicated structure is zero, then the agent is logged out of any ACD groups into which it is currently logged in.

Note  The "Name" fields in the LINEAGENTGROUPENTRY items in the list are ignored for purposes of this function; the control of the logged-in groups is based on the group identifier values only.

Return Values

Returns a positive request identifier if the asynchronous operation starts; otherwise, the function returns one of these negative error values:

LINEERR_INVALADDRESSID, LINEERR_INVALADDRESSSTATE, LINEERR_INVALAGENTGROUP, LINEERR_INVALAGENTID, LINEERR_INVALAGENTSKILL, LINEERR_INVALAGENTSUPERVISOR, LINEERR_INVALLINEHANDLE, LINEERR_INVALPARAM, LINEERR_INVALPASSWORD, LINEERR_INVALPOINTER, LINEERR_NOMEM, LINEERR_OPERATIONFAILED, LINEERR_OPERATIONUNAVAIL, LINEERR_RESOURCEUNAVAIL, LINEERR_UNINITIALIZED.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
  Windows 95/98: Requires Windows 95 or later.
  Version: Requires TAPI 2.0 or later.
  Header: Declared in Tapi.h.
  Library: Use Tapi32.lib.

See Also

TAPI 2.2 Reference Overview, Supplementary Line Service Functions, LINEAGENTGROUPENTRY, LINEAGENTGROUPLIST