LINETRANSLATEOUTPUT

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This structure describes the result of an address translation.

Syntax

typedef struct linetranslateoutput_tag {
  DWORD dwTotalSize;
  DWORD dwNeededSize;
  DWORD dwUsedSize;
  DWORD dwDialableStringSize;
  DWORD dwDialableStringOffset;
  DWORD dwDisplayableStringSize;
  DWORD dwDisplayableStringOffset;
  DWORD dwCurrentCountry;
  DWORD dwDestCountry;
  DWORD dwTranslateResults;
} LINETRANSLATEOUTPUT, *LPLINETRANSLATEOUTPUT;

Members

• dwTotalSize
  Total size, in bytes, allocated to this data structure.

• dwNeededSize
  Size, in bytes, for this data structure that is needed to hold all the returned data.

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

• dwDialableStringSize
  Size, in bytes, of the dialable string including the terminating NULL.

• dwDialableStringOffset
  Contain the translated output that can be passed to the lineMakeCall or other function requiring a dialable string. The output is always a null-terminated ASCII string (NULL is accounted for in Size). 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 data such as calling card numbers. It should not be displayed to the user, to prevent inadvertent visibility to unauthorized persons.

• dwDisplayableStringSize
  Contain the translated output that can be displayed to the user for confirmation. It is identical to DialableString, except that calling card digits are replaced with the friendly name of the card enclosed within bracket characters, 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.

• dwDisplayableStringOffset
  Contain the translated output that can be displayed to the user for confirmation. It is identical to DialableString, except that calling card digits are replaced with the friendly name of the card enclosed within bracket characters, and ancillary fields such as name and subaddress are removed. It should normally be safe to display this string in call-status dialog boxes without exposing private data to unauthorized persons. This data is also appropriate to include in call logs.

• dwCurrentCountry
  Country/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.

• 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 the lineTranslateAddress function is not in canonical format.

• dwTranslateResults
  Value that indicates the data derived from the translation process, which may assist the application in presenting user-interface elements. This field uses LINETRANSLATERESULT.

Remarks

No extensions.

Requirements

See Also

Reference

lineMakeCall
lineTranslateAddress