LINELOCATIONENTRY (Compact 2013)
3/26/2014
The LINELOCATIONENTRY structure describes a location used to provide an address translation context.
Syntax
typedef struct linelocationentry_tag {
DWORD dwPermanentLocationID;
DWORD dwLocationNameSize;
DWORD dwLocationNameOffset;
DWORD dwCountryCode;
DWORD dwCityCodeSize;
DWORD dwCityCodeOffset;
DWORD dwPreferredCardID;
DWORD dwLocalAccessCodeSize;
DWORD dwLocalAccessCodeOffset;
DWORD dwLongDistanceAccessCodeSize;
DWORD dwLongDistanceAccessCodeOffset;
DWORD dwTollPrefixListSize;
DWORD dwTollPrefixListOffset;
DWORD dwCountryID;
DWORD dwOptions;
DWORD dwCancelCallWaitingSize;
DWORD dwCancelCallWaitingOffset;
} LINELOCATIONENTRY, FAR* LPLINELOCATIONENTRY;
Members
- dwPermanentLocationID
Permanent identifier that identifies the location.
- dwLocationNameSize
Contains a null-terminated ASCII string (size includes the NULL) that describes the location in a user-friendly manner.
- dwLocationNameOffset
Contains a null-terminated ASCII string (size includes the NULL) that describes the location in a user-friendly manner.
- dwCountryCode
Country/region code of the location.
- dwPreferredCardID
Preferred calling card when dialing from this location.
- dwCityCodeSize
Contains a null-terminated ASCII string specifying the city/area code associated with the location (the size includes the NULL). This data, along with the country/region code, can be used by applications to default entry fields for the user when entering phone numbers, to encourage the entry of proper canonical numbers.
- dwCityCodeOffset
Contains a null-terminated ASCII string specifying the city/area code associated with the location (the size includes the NULL). This data, along with the country/region code, can be used by applications to default entry fields for the user when entering phone numbers, to encourage the entry of proper canonical numbers.
- dwLocalAccessCodeSize
Size, in bytes, of a null-terminated ASCII string containing the access code to be dialed before calls to addresses in the local calling area.
- dwLocalAccessCodeOffset
Offset in bytes from the beginning of the LINETRANSLATECAPS structure.
- dwLongDistanceAccessCodeSize
Size, in bytes, of a null-terminated ASCII string containing the access code to be dialed before calls to addresses outside the local calling area.
- dwLongDistanceAccessCodeOffset
Offset in bytes from the beginning of the LINETRANSLATECAPS structure.
- dwTollPrefixListSize
Size, in bytes, of a null-terminated ASCII string containing the toll prefix list for the location. The string contains only prefixes consisting of the digits 0 through 9, separated from each other by a single comma (,) character.
- dwTollPrefixListOffset
Offset in bytes from the beginning of the LINETRANSLATECAPS structure.
- dwCountryID
Country/region identifier of the country/region selected for the location.
- dwOptions
Value that indicates options in effect for this location, with values taken from the LINELOCATIONOPTION.
- dwCancelCallWaitingSize
Size, in bytes, of a null-terminated ASCII string containing the dial digits and modifier characters that should be prefixed to the dialable string (after the pulse/tone character) when an application sets the LINETRANSLATEOPTION_CANCELCALLWAITING bit in the dwTranslateOptions parameter of the lineTranslateAddress function. If no prefix is defined, this can be indicated by dwCancelCallWaitingSize being set to zero, or by it being set to 1 and dwCancelCallWaitingOffset pointing to an empty string (single NULL byte).
- dwCancelCallWaitingOffset
Offset, in bytes, from the beginning of the LINETRANSLATECAPS structure.
Remarks
No extensions.
Older applications are compiled without knowledge of these new fields, and using a SIZEOF LINELOCATIONENTRY smaller than the new size. Because this is an array in the variable portion of a LINETRANSLATECAPS structure, it is imperative that older applications receive LINELOCATIONENTRY structures in the format they previously expected, or they are not able to index through the array properly. The application passes in a dwAPIVersion parameter with the lineGetTranslateCaps function, which can be used for guidance by TAPI in handling this situation. The lineGetTranslateCaps function should use the LINELOCATIONENTRY members and size that match the indicated API version, when building the LINETRANSLATECAPS structure to be returned to the application.
Requirements
Header |
tapi.h |