Share via


IAppCfg::GetRegionCodeFromCountryCodeAndRegionName Method

Use this method to get a string that contains the state/province code for the specified country/region code and state/province name.

HRESULT IAppCfg::GetRegionCodeFromCountryCodeAndRegionName(
  BSTR bstrCountryCode,
  BSTR bstrRegionName,
  BSTR* pbstrRegionCode
);
Function GetRegionCodeFromCountryCodeAndRegionName(
    bstrCountryCodeAs String,
    bstrRegionNameAs String
) As String

Parameters

  • bstrCountryCode
    [C++]

    [in] A BSTR that contains the code of the country/region for which the state/province code is being requested.

    [Visual Basic]

    A String that contains the code of the country/region for which the state/province code is being requested.

  • bstrRegionName
    [C++]

    [in] A BSTR that contains the name of the state/province within the specified country/region for which the state/province code is being requested.

    [Visual Basic]

    A String that contains the name of the state/province within the specified country/region for which the state/province code is being requested.

  • pbstrRegionCode
    [C++]

    [out, retval] The address of a BSTR used to return the requested state/province code. An empty BSTR indicates that the code was not found.

    [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 requested state/province code. An empty String indicates that the code was not found.

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 pbstrRegionCode parameter contains valid data only if the method returns successfully.

This method returns an empty string if the state/province code was not found.

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.GetRegionCodeFromCountryCodeAndRegionName("us", "Utah")

See Also

Other Resources

AppConfig Object