Skip to content

Latest commit

 

History

History
122 lines (87 loc) · 5.17 KB

ns-tapi-linetranslateoutput.md

File metadata and controls

122 lines (87 loc) · 5.17 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NS:tapi.linetranslateoutput_tag
LINETRANSLATEOUTPUT (tapi.h)
The LINETRANSLATEOUTPUT structure describes the result of an address translation. The lineTranslateAddress function uses this structure.
*LPLINETRANSLATEOUTPUT
LINETRANSLATEOUTPUT
LINETRANSLATEOUTPUT structure [TAPI 2.2]
LPLINETRANSLATEOUTPUT
LPLINETRANSLATEOUTPUT structure pointer [TAPI 2.2]
_tapi2_linetranslateoutput_str
tapi/LINETRANSLATEOUTPUT
tapi/LPLINETRANSLATEOUTPUT
tapi2.linetranslateoutput_str
tapi2\linetranslateoutput_str.htm
tapi3
bcf094ad-8098-4e45-9131-25dbdb7e4093
12/05/2018
*LPLINETRANSLATEOUTPUT, LINETRANSLATEOUTPUT, LINETRANSLATEOUTPUT structure [TAPI 2.2], LPLINETRANSLATEOUTPUT, LPLINETRANSLATEOUTPUT structure pointer [TAPI 2.2], _tapi2_linetranslateoutput_str, tapi/LINETRANSLATEOUTPUT, tapi/LPLINETRANSLATEOUTPUT, tapi2.linetranslateoutput_str
tapi.h
Windows
Windows
LINETRANSLATEOUTPUT, *LPLINETRANSLATEOUTPUT
19H1
linetranslateoutput_tag
tapi/linetranslateoutput_tag
LPLINETRANSLATEOUTPUT
tapi/LPLINETRANSLATEOUTPUT
LINETRANSLATEOUTPUT
tapi/LINETRANSLATEOUTPUT
c++
APIRef
kbSyntax
HeaderDef
Tapi.h
LINETRANSLATEOUTPUT

LINETRANSLATEOUTPUT structure

-description

The LINETRANSLATEOUTPUT structure describes the result of an address translation. The lineTranslateAddress function uses this structure.

-struct-fields

-field dwTotalSize

Total size allocated to this data structure, in bytes.

-field dwNeededSize

Size needed for this data structure to hold all the returned information, in bytes.

-field dwUsedSize

Size of the portion of this data structure that contains useful information, in bytes.

-field dwDialableStringSize

Size dialable string, in bytes, including the terminating NULL.

-field dwDialableStringOffset

Offset from the beginning of this structure to the translated output that can be passed to the lineMakeCall, lineDial, or other function requiring a dialable string. The output is always a null-terminated string. Ancillary fields such as name and subaddress are included in this output string if they were in the input string. This string may contain private information such as calling card numbers. It should not be displayed to the user, to prevent inadvertent visibility to unauthorized persons. The size of the field is specified by dwDialableStringSize.

-field dwDisplayableStringSize

Size of the translated output that can be displayed to the user, including the null terminator, in bytes.

-field dwDisplayableStringOffset

Offset to the translated output that can be displayed to the user for confirmation. It is identical to DialableString, except the calling card digits are replaced with the friendly name of the card enclosed within bracket characters (for example, "[AT&T Card]"), and ancillary fields such as name and subaddress are removed. Use an appropriate message in dwDisplayableStringOffset, because the string might be displayed publicly in the call-status dialog box. This information is also appropriate to include in call logs. The size of the field is specified by dwDisplayableStringSize.

-field dwCurrentCountry

Country or region code configured in CurrentLocation. This value may be used to control the display by the application of certain user interface elements, for local call progress tone detection, and for other purposes.

-field dwDestCountry

Destination country/region code of the translated address. This value may be passed to the dwCountryCode parameter of lineMakeCall and other dialing functions (so that the call progress tones of the destination country/region such as a busy signal are properly detected). This field is set to zero if the destination address passed to lineTranslateAddress is not in canonical format.

-field dwTranslateResults

Information derived from the translation process, which may assist the application in presenting user-interface elements. This field uses one of the LINETRANSLATERESULT_ Constants.

-remarks

This structure cannot be extended.

-see-also

lineDial

lineMakeCall

lineTranslateAddress