lineCreateAgent

The lineCreateAgent function creates a new Agent object. It generates a LINE_PROXYREQUEST message to be sent to a registered proxy function handler, referencing a LINEPROXYREQUEST structure of type LINEPROXYREQUEST_CREATEAGENT.

LONG lineCreateAgent(
  HLINE hLine,               
  LPWSTR lpszAgentID,        
  LPWSTR lpszAgentPIN,       
  LPHAGENT lphAgent          
);

Parameters

hLine

A handle to the line device.

lpszAgentID

A pointer to a null-terminated Unicode string containing the agent identifier. Used when working with legacy ACD systems. With an ACD system that uses the operating system's user login for authentication, lpszAgentID is set to NULL.

lpszAgentPIN

A pointer to a null-terminated Unicode string containing the agent PIN or password. Used when working with legacy ACD systems. With an ACD system that uses the operating system's user login for authentication, lpszAgentPIN is set to NULL.

lphAgent

A handle of the created agent, returned by the ACD proxy. It is the responsibility of the agent handler proxy application to generate and maintain uniqueness of this identifier.

Return Values

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

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Version: Requires TAPI 2.2 or later.
  Header: Declared in Tapi.h.
  Library: Use Tapi32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows 2000.

See Also

LINEPROXYREQUEST, LINE_PROXYREQUEST