Previous in Contents Next in Contents

IDataFunctions::GetLocaleInfo

The GetLocaleInfo method returns information on the specified locale in a BSTR VARIANT.

Syntax

HRESULT GetLocaleInfo(
long info,// in
VARIANT locale,// in
VARIANT *pvarRet
);

Parameters

info
A long integer that indicates the type of locale information to return in pvarRet. This value must map to one of the LCTYPE constants. For information about this constant, see the Win32® SDK Help.
locale
A long VARIANT that identifies the locale on which to return information. If this VARIANT is empty (VT_EMPTY) or null (VT_NULL), GetLocaleInfo returns information for the locale specified in a previous call to put_Locale.
pvarRet
If successful, pvarRet points to a BSTR VARIANT that contains the requested locale information; Otherwise, NULL.

Include

<commerce.h>

Return Values

Value Description
S_OK The method succeeded, and pvarRet contains the locale information.
E_FAIL The locale information could not be retrieved.

Related Topic

IDataFunctions::GetLocaleList


© 1997-2000 Microsoft Corporation. All rights reserved.