lineProxyMessage

The lineProxyMessage function is used by a registered proxy request handler to generate TAPI messages related to its role. For example, an ACD agent handler can use this function to generate LINE_AGENTSTATUS messages that are received by all applications that have the specified line open. TAPI suppresses generation of the message on the hLine specified in the function parameters.

LONG lineProxyMessage(
  HLINE hLine,    
  HCALL hCall,    
  DWORD dwMsg,    
  DWORD dwParam1, 
  DWORD dwParam2, 
  DWORD dwParam3  
);
 

Parameters

hLine

A handle to the open line device. This is converted by TAPI into the correct hLine for each application that receives the message.

hCall

If the message is related to a specific call (which it is not, in the case of LINE_AGENTSTATUS), specifies the proxy handler's handle to that call; shall be set to NULL for messages not related to a specific call. This is converted by TAPI into the correct hCall for each application that receives the message.

dwMsg

The TAPI message to be generated. This must be a message that is permitted to be generated by proxy handlers.

dwParam1

dwParam2

dwParam3

The parameters associated with the message to be sent.

Return Values

Returns zero if the function succeeds or one of these negative error values:

LINEERR_INVALLINEHANDLE, LINEERR_INVALCALLHANDLE, LINEERR_INVALPARAM, LINEERR_NOMEM, LINEERR_NOTREGISTERED, LINEERR_OPERATIONFAILED, LINEERR_OPERATIONUNAVAIL, LINEERR_RESOURCEUNAVAIL, 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, LINE_AGENTSTATUS