lineGetCountry

The lineGetCountry function fetches the stored dialing rules and other information related to a specified country, the first country in the country list, or all countries.

LONG lineGetCountry(
  DWORD dwCountryID,                   
  DWORD dwAPIVersion,                  
  LPLINECOUNTRYLIST lpLineCountryList  
);
 

Parameters

dwCountryID

The country identifier (not the country code) of the country for which information is to be obtained. If the value 1 is specified, information on the first country in the country list is obtained. If the value 0 is specified, information on all countries is obtained (which can require a great deal of memory—20 KB or more).

dwAPIVersion

The highest version of TAPI supported by the application (not necessarily the value negotiated by lineNegotiateAPIVersion on some particular line device).

lpLineCountryList

A pointer to a location to which a LINECOUNTRYLIST structure is loaded. Prior to calling lineGetCountry, the application should set the dwTotalSize member of this structure to indicate the amount of memory available to TAPI for returning information.

Return Values

Returns zero if the request succeeds or a negative error number if an error occurs. Possible return values are:

LINEERR_INCOMPATIBLEAPIVERSION, LINEERR_NOMEM, LINEERR_INIFILECORRUPT, LINEERR_OPERATIONFAILED, LINEERR_INVALCOUNTRYCODE, LINEERR_STRUCTURETOOSMALL, LINEERR_INVALPOINTER.

Remarks

Although this is a new function that older applications would not be expected to call, for backward compatibility they should not be prevented from doing so. The function works the same way for all applications.

QuickInfo

  Version: Use TAPI version 1.4 and later.
  Header: Declared in tapi.h.
  Import Library: Link with tapi32.lib.

See Also

TAPI Reference Overview, Basic Telephony Services Reference, LINECOUNTRYLIST, lineNegotiateAPIVersion