TSPI_lineSendUserUserInfo

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function sends user-user information to the remote party on the specified call.

Syntax

LONG TSPIAPI TSPI_lineSendUserUserInfo(
  DRV_REQUESTID dwRequestID,  
  HDRVCALL hdCall, 
  LPCSTR lpsUserUserInfo, 
  DWORD dwSize 
);

Parameters

• dwRequestID
  Identifier of the asynchronous request.

• hdCall
  Handle to the call on which to send user-user information. The call state of hdCall can be connected, offering, accepted, or ringback.

• lpsUserUserInfo
  Pointer to a null-terminated Unicode string containing user-user information to be sent to the remote party. User-user information is only sent if supported by the underlying network (see LINEDEVCAPS).

• dwSize
  Size, in bytes, of the user-user information in lpsUserUserInfo.

Return Value

Returns dwRequestID, or an error number if an error occurs. The lResult actual parameter of the corresponding ASYNC_COMPLETION is zero if the function succeeds, or an error number if an error occurs. The following table shows the return values for this function.

Remarks

This function can be used to send user-user information at any time during a connected call. If the size of the specified information to be sent is larger than what can fit into a single network message (as in ISDN), the service provider is responsible for breaking the information up into a sequence of chained network messages (using "more data").

User-user information can also be sent as part of call accept, call reject, call redirect, and when making calls. User-user information can also be received. The received information is reported in the call's LINECALLINFO structure. Whenever user-user information arrives after call offering or prior to call disconnect, a LINE_CALLINFO message with a UserUserInfo parameter notifies TAPI that user-user information in the call-information record has changed. If multiple network messages are chained, the information is assembled by the service provider and a single message is sent to TAPI.

Requirements

See Also

Reference

TSPI_lineAccept
TSPI_lineDrop
TSPI_lineGetCallInfo
TSPI_lineMakeCall
TSPI_lineRedirect