lineSendUserUserInfo
The lineSendUserUserInfo
function sends user-to-user information to the remote party on the specified
call.
LONG lineSendUserUserInfo(
|
HCALL hCall, |
|
|
LPCSTR lpsUserUserInfo, |
|
|
DWORD dwSize |
|
|
); |
|
Parameters
hCall
A handle to
the call on which to send user-to-user information. The application must be an
owner of the call. The call state of hCall must be connected, offering,
accepted, or ringback.
lpsUserUserInfo
A pointer to
a string containing user-to-user information to be sent to the remote party.
User-to-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.
dwSize
The size in
bytes of the user-to-user information in lpsUserUserInfo.
Return Values
Returns a
positive request ID if the function will be completed asynchronously, or a
negative error number if an error has occurred. The dwParam2 parameter
of the corresponding LINE_REPLY
message is zero if the function is successful or it is a negative error number
if an error has occurred. 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-to-user information at any time during a connected
call. If the size of the specified information to be sent is larger than what
may 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-to-user
information can also be sent as part of call accept, call reject, and call
redirect, and when making calls. User-to-user information can also be received.
The received information is available through the call's call-information
record. Whenever user-to-user information arrives after call offering or prior
to call disconnect, a LINE_CALLINFO message with a UserUserInfo
parameter will notify the application that user-to-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.
See Also