IAppCfg::GetRegionNameFromCountryCodeAndRegionCode Method
For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.
Use this method to get the name of the state/province associated with the specified country/region code and state/province code.
HRESULT IAppCfg::GetRegionNameFromCountryCodeAndRegionCode(
BSTR bstrCountryCode,
BSTR bstrRegionCode,
BSTR* pbstrRegionName
);
Function GetRegionNameFromCountryCodeAndRegionCode(
bstrCountryCodeAs String,
bstrRegionCodeAs String
) As String
Parameters
bstrCountryCode
[C++][in] A BSTR that contains the code of the country/region for which the state/province name is being requested.
[Visual Basic]
A String that contains the code of the country/region for which the state/province name is being requested.
bstrRegionCode
[C++][in] A BSTR that contains the code of the state/province within the specified country/region for which the state/province name is being requested.
[Visual Basic]
A String that contains the code of the state/province within the specified country/region for which the state/province name is being requested.
bstrRegionCode
[C++][out, retval] The address of a BSTR used to return the state/province name. If the state/province name is not found, the BSTR will contain the state/province code specified in the bstrRegionCodeparameter.
[Visual Basic]
Not applicable.
Return Value
[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.
[Visual Basic] If this method completes successfully, it returns a String that contains the state/province name. If the state/province name is not found, the String will contain the state/province code specified in the bstrRegionCodeparameter.
Error Values
[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.
[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.
Remarks
[C++] The pbstrRegionName parameter contains valid data only if the method returns successfully.
If the state/province name is not found, this method returns the state/province code specified in the bstrRegionCodeparameter.
You can set country/region codes and country/region names by using the Commerce Server Marketing Manager.
Example
' oAppCfg is a AppConfig object, sResult is a String.
sResult = oAppCfg.GetRegionNameFromCountryCodeAndRegionCode("us", "UT")