lineSetAgentSessionState function (tapi.h)
The lineSetAgentSessionState function sets the agent session state associated with a particular agent session handle. It generates a LINE_PROXYREQUEST message to be sent to a registered proxy function handler, referencing a LINEPROXYREQUEST structure of type LINEPROXYREQUEST_SETAGENTSESSIONSTATE.
Syntax
LONG lineSetAgentSessionState(
HLINE hLine,
HAGENTSESSION hAgentSession,
DWORD dwAgentSessionState,
DWORD dwNextAgentSessionState
);
Parameters
hLine
Handle to the line device.
hAgentSession
Identifier of the agent session whose information is to be changed.
dwAgentSessionState
New agent session state. Must be one of the LINEAGENTSESSIONSTATE_ constants or zero to leave the agent session state unchanged and modify only the next state.
dwNextAgentSessionState
Next agent session state. Must be one of the LINEAGENTSESSIONSTATE_ constants or zero.
Return value
Returns a request identifier if the asynchronous operation starts; otherwise, the function returns one of the following error values:
LINEERR_INVALAGENTSTATE, LINEERR_INVALLINEHANDLE, LINEERR_INVALPARAM, LINEERR_NOMEM, LINEERR_OPERATIONFAILED, LINEERR_OPERATIONUNAVAIL, LINEERR_RESOURCEUNAVAIL, LINEERR_UNINITIALIZED.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | tapi.h |
| Library | Tapi32.lib |
| DLL | Tapi32.dll |