lineTranslateAddress (Compact 2013)

3/26/2014

This function translates the specified address into a dialable string format.

Syntax

LONG lineTranslateAddress(
  HLINEAPP hLineApp, 
  DWORD dwDeviceID, 
  DWORD dwAPIVersion, 
  LPCWSTR lpszAddressIn, 
  DWORD dwCard, 
  DWORD dwTranslateOptions, 
  LPLINETRANSLATEOUTPUT lpTranslateOutput
);

Parameters

• hLineApp
  [in] Application handle returned by the lineInitialize function. If an application has not yet called lineInitialize, it can set the hLineApp parameter to NULL.

• dwDeviceID
  [in] Value that specifies the device identifier for the line device upon which the call is intended to be dialed, so that variations in dialing procedures on different lines can be applied to the translation process.

• dwAPIVersion
  [in] Highest version of TAPI supported by the application (not necessarily the value negotiated by lineNegotiateAPIVersion on some particular line device).

• lpszAddressIn
  [in] Pointer to a null-terminated string that contains the address from which the data is to be extracted for translation. Must be in either the canonical address format, or an arbitrary string of dialable digits (non-canonical). This parameter must not be NULL. If the AddressIn contains a subaddress or name field, or additional addresses separated from the first address by ASCII CR and LF characters, only the first address is translated, and the remainder of the string is returned to the application without modification.

• dwCard
  [in] Unsupported; set to zero.

• dwTranslateOptions
  [in] Value that specifies the associated operations to be performed prior to the translation of the address into a dialable string. This parameter uses LINETRANSLATEOPTION.

  Note

  If you have set the LINETRANSLATEOPTION_CANCELCALLWAITING bit, it is also advisable to set the LINECALLPARAMFLAGS_SECURE bit in the dwCallParamFlags member of the LINECALLPARAMS structure (passed in to the lineMakeCall functionthrough the lpCallParams parameter). This prevents the line device from using dialable digits to suppress call interrupts.

• lpTranslateOutput
  [out] Pointer to an application-allocated memory area to contain the output of the translation operation, of type LINETRANSLATEOUTPUT. Prior to calling lineTranslateAddress, the application should set the dwTotalSize member of this structure to indicate the amount of memory available to TAPI for returning data.

Return Value

Zero indicates success. A negative error number indicates that an error occurred. The following table shows the return values for this function.

Value	Description
LINEERR_BADDEVICEID	The device id is incorrect.
LINEERR_INCOMPATIBLEAPIVERSION	The API version is incompatible.
LINEERR_INIFILECORRUPT	The INI file is corrupted.
LINEERR_INVALADDRESS	The address is invalid.
LINEERR_INVALAPPHANDLE	The application handle is invalid.
LINEERR_INVALCARD	The card is invalid.
LINEERR_INVALPARAM	The parameter is invalid.
LINEERR_INVALPOINTER	The pointer is invalid.
LINEERR_NODRIVER	The driver was not found.
LINEERR_NOMEM	Not enough memory is available.
LINEERR_OPERATIONFAILED	The operation failed.
LINEERR_RESOURCEUNAVAIL	The resource is unavailable.
LINEERR_STRUCTURETOOSMALL	The structure is too small.

Remarks

This function does not translate multiplexed canonical addresses - that is, two canonical addresses separated by <CRLF>. Only the first address is translated. The other addresses are ignored.

When an address is specified with a country/region code but without the local area code, the translation is not as expected. Instead of translating the address as a local call, the system translates the address as a long distance call with no area code. To avoid this behavior, set the LINETRANSLATEOPTION_FORCELOCAL bit or provide the area code for all addresses, including local ones.

Requirements

Header	tapi.h
Library	TAPI32.dll

See Also

Reference

TAPI Line Device Functions
lineInitialize
lineMakeCall
lineNegotiateAPIVersion
LINECALLPARAMS
LINETRANSLATEOUTPUT