Share via

DataFunctions.GetLocaleInfo Method (PIA)

  • Article

Use this method to get information on the specified locale.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop
…
Public Function GetLocaleInfo(vtInfo As Integer,
 vtLocale As Object) As Object

[C#]

using Microsoft.CommerceServer.Interop;
…
public object GetLocaleInfo(intvtInfo,
 objectvtLocale);

Parameters

[Visual Basic .NET]

  • vtInfo
    An Integer that indicates the type of locale information to return. This value must map to one of the LCTYPE constants. For information about these constants, see the Win32 SDK Help.
  • vtLocale
    An Object that identifies the locale for which to return information. If this parameter is not specified, the value of the Locale property of the DataFunctions object is used.

[C#]

  • vtInfo
    An int that specifies the type of locale information to return in the returned object. This value must map to one of the LCTYPE constants. For information about these constants, see the Win32 SDK Help.
  • vtLocale
    An object that identifies the locale for which to return information. If you want the value of the Locale property of the DataFunctions object to be used, pass Type.Missing for this parameter.

Return Values

[Visual Basic .NET] If this method completes successfully, it returns a string Object that contains the requested locale information; otherwise, Null is returned.

[C#] This method returns an object containing the requested locale information.

Exceptions

This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

Remarks

The Locale property stores a number value that indicates the default locale to be used by the DataFunctions methods to format date, time, money, and number information. For those DataFunctions methods take a locale value for a parameter, if that value is not supplied, the value of this property is used.

Example

[Visual Basic .NET]

Dim vtResult As Object
Dim lInfo As Integer
DataFunctions df = New DataFunctions()
' Set Locale to USA
vtResult = df.GetLocaleInfo(lInfo)

[C#]

No example available.

Requirements

Namespace: Microsoft.CommerceServer.Interop

Platforms: Windows 2000, Windows Server 2003

Assembly: mscsasphelplib (in mscsasphelplib.dll)

See Also

DataFunctions Class

DataFunctions.Locale

Copyright © 2005 Microsoft Corporation.
All rights reserved.