tapiRequestMakeCall
The tapiRequestMakeCall
function requests the establishment of a voice call. A call-manager application
is responsible for establishing the call on behalf of the requesting
application, which is then controlled by the user's call-manager application.
LONG tapiRequestMakeCall(
LPCSTR lpszDestAddress, |
|
LPCSTR lpszAppName, |
|
LPCSTR lpszCalledParty, |
|
LPCSTR lpszComment |
|
); |
|
Parameters
lpszDestAddress
A pointer to
a memory location where the NULL-terminated destination address of the call
request is located. The address can use the canonical address format (address
formats are discussed in Line Devices Overview
lpszAppName
A pointer to
a memory location where the ASCII NULL-terminated user-friendly application
name of the call request is located. This pointer may be left NULL if the
application does not wish to supply an application name. The maximum length of
the address is TAPIMAXAPPNAMESIZE characters, which includes the NULL
terminator. Longer strings are truncated.
lpszCalledParty
A pointer to
a memory location where the ASCII NULL-terminated called party name for the
called party of the call is located. This pointer may be left NULL if the
application does not wish to supply this information. The maximum length of the
string is TAPIMAXCALLEDPARTYSIZE characters, which includes the NULL
terminator. Longer strings are truncated.
lpszComment
A pointer to
a memory location where the ASCII NULL-terminated comment about the call is
located. This pointer may be left NULL if the application does not wish to
supply a comment. The maximum length of the address is TAPIMAXCOMMENTSIZE
characters, which includes the NULL terminator. Longer strings are truncated.
Return Values
Returns zero
if the request is successful or a negative error number if an error has
occurred. Possible error return value are:
TAPIERR_NOREQUESTRECIPIENT,
TAPIERR_INVALDESTADDRESS, TAPIERR_REQUESTQUEUEFULL, TAPIERR_INVALPOINTER.
Remarks
A
telephony-enabled application can request that a call be placed on its behalf
by invoking tapiRequestMakeCall, providing only the destination address
for the call. This request is forwarded to the user's call-control application,
which places the call on behalf of the original application. A default
call-control application is provided as part of Win32 Telephony. Users can
replace this with a call-control application of their choice.
Invoking tapiRequestMakeCall
when no call control application is running returns the TAPIERR_NOREQUESTRECIPIENT
error indication. If the call control application is not running, TAPI will
attempt to launch the highest-priority call control application (which is
listed for RequestMakeCall in the registry ). Invoking this function when the
Assisted TAPI request queue is full returns the TAPIERR_REQUESTQUEUEFULL error.