ITAddressTranslation::TranslateDialog method (tapi3if.h)
The TranslateDialog method displays an application-modal dialog box that allows the user to change the current location of a phone number about to be dialed, adjust location and calling card parameters, and see the effect.
Syntax
HRESULT TranslateDialog(
[in] TAPIHWND hwndOwner,
[in] BSTR pAddressIn
);
Parameters
[in] hwndOwner
A handle to a window to which the dialog box is to be attached. Can be a NULL value to indicate that any window created during the function should have no owner window.
[in] pAddressIn
A pointer to BSTR containing a phone number that is used to show the effect of the user's changes on the location parameters. The number must be in canonical format. This pointer can be left NULL, in which case the phone number portion of the dialog box is not displayed. If the pAddressIn parameter 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 used in the dialog box.
Return value
This method can return one of these values.
| Return code | Description |
|---|---|
|
Method succeeded. |
|
The hwndOwner parameter is not a valid handle or the pAddressIn parameter is not a valid phone number. |
|
The pAddressIn parameter is not a valid pointer. |
|
Insufficient memory exists to perform the operation. |
|
An unexpected error occurred. |
|
The registry settings for address translation are not valid. |
|
No TSP exists that can do translation for this address. |
|
The dialog is already open and in use. |
|
The current address is not valid. |
|
TAPI was not able to complete the operation. |
Remarks
The application must use SysAllocString to allocate memory for pAddressIn and use SysFreeString to free the memory when the variable is no longer needed.
The TranslateDialog method is a COM wrapper for the TAPI 2.1 LineTranslateDialog function.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | tapi3if.h (include Tapi3.h) |
| Library | Uuid.lib |
| DLL | Tapi3.dll |