Skip to content

Latest commit

 

History

History
105 lines (73 loc) · 4.44 KB

nf-tapi-linesenduseruserinfo.md

File metadata and controls

105 lines (73 loc) · 4.44 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:tapi.lineSendUserUserInfo
lineSendUserUserInfo function (tapi.h)
The lineSendUserUserInfo function sends user-user information to the remote party on the specified call.
_tapi2_linesenduseruserinfo
lineSendUserUserInfo
lineSendUserUserInfo function [TAPI 2.2]
tapi/lineSendUserUserInfo
tapi2.linesenduseruserinfo
tapi2\linesenduseruserinfo.htm
tapi3
833827a0-bbb2-4df9-87a0-3b2eb1904611
12/05/2018
_tapi2_linesenduseruserinfo, lineSendUserUserInfo, lineSendUserUserInfo function [TAPI 2.2], tapi/lineSendUserUserInfo, tapi2.linesenduseruserinfo
tapi.h
Windows
Tapi32.lib
Tapi32.dll
Windows
19H1
lineSendUserUserInfo
tapi/lineSendUserUserInfo
c++
APIRef
kbSyntax
DllExport
Tapi32.dll
lineSendUserUserInfo

lineSendUserUserInfo function

-description

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

-parameters

-param hCall

Handle to the call on which to send user-user information. The application must be an owner of the call. The call state of hCall must be connected, offering, accepted, or ringback.

-param lpsUserUserInfo

Pointer to a 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). The protocol discriminator field for the user-user information, if required, should appear as the first byte of the buffer pointed to by lpsUserUserInfo, and must be accounted for in dwSize.

-param dwSize

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

-returns

Returns a positive request identifier if the function is completed asynchronously, or a negative error number if an error occurs. The dwParam2 parameter of the corresponding LINE_REPLY message is zero if the function succeeds or it is a negative error number if an error occurs. Possible return values are:

LINEERR_INVALCALLHANDLE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALCALLSTATE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_RESOURCEUNAVAIL, LINEERR_NOMEM, LINEERR_USERUSERINFOTOOBIG, LINEERR_NOTOWNER, LINEERR_UNINITIALIZED.

-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 dividing the information into a sequence of chained network messages (using "more data").

User-user information can also be sent as part of call accept, call reject, and call redirect, and when making calls. User-user information can also be received. The received information is available through the call's call-information record. Whenever user-user information arrives after call offering or prior to call disconnect, a LINE_CALLINFO message with a UserUserInfo parameter notifies the application 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 the application.

This function may send data over the wire in unencrypted form; therefore, someone eavesdropping on the network may be able to read the data. The security risk of sending the data in clear text should be considered before using this method.

-see-also

LINEDEVCAPS

LINE_CALLINFO

LINE_REPLY

Supplementary Line Service Functions

TAPI 2.2 Reference Overview