tapiRequestMakeCall (Compact 2013)

3/26/2014

Use this function to start a voice call; the voice call is then controlled by the call-manager application of the device.


LONG tapiRequestMakeCall (
  LPCTSTR lpszDestAddress,
  LPCTSTR lpszAppName,
  LPCTSTR lpszCalledParty,
  LPCTSTR lpszComment 
);

lpszDestAddress

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. Validity of the specified address is not checked by this operation. The maximum length of the address is TAPIMAXDESTADDRESSSIZE characters which includes the NULL terminator.

lpszAppName

Reserved; set to NULL.

lpszCalledParty

Pointer to a memory location where the null-terminated comment for the call is located. This pointer can be left NULL if the application does not supply this information. The maximum length of the string is TAPIMAXCALLEDPARTYSIZE characters, which includes the NULL terminator. Longer strings are truncated.

lpszComment

Reserved; set to NULL.

Returns zero if the request succeeds, or it returns a negative error number if an error occurs. The following table describes possible error return values.

Value

Description

TAPIERR_NOREQUESTRECIPIENT

The phone API set is either not yet available when the function was called, or the phone API set is unavailable on the device.

TAPIERR_REQUESTQUEUEFULL

Reserved.

TAPIERR_INVALDESTADDRESS

The pointer to the destination address is NULL, or the destination address string is either too long or has a zero length.

TAPIERR_REQUESTFAILED

Reserved.

TAPIERR_REQUESTCANCELLED

The caller did not have sufficient permission to make the call.

TAPIERR_INVALPOINTER

A pointer does not reference a valid memory location.

One or more of the following pointers are defined but invalid:

  • lpszDestAddress
  • lpszAppName
  • lpszCalledParty
  • lpszComment

A telephony-enabled application can request that a call be made on its behalf by invoking tapiRequestMakeCall and providing the destination address for the call. This request is forwarded to the phone dial API of the system.

If tapiRequestMakeCall is invoked when no call control application is available, tapiRequestMakeCall returns TAPIERR_NOREQUESTRECIPIENT.

Header

astdtapi.h

Library

cellcore.lib

Show: