This documentation is archived and is not being maintained.

LCIDConversionAttribute Class

Indicates that a method's unmanaged signature expects a locale identifier (LCID) parameter.

Namespace: System.Runtime.InteropServices
Assembly: mscorlib (in mscorlib.dll)

<ComVisibleAttribute(True)> _
<AttributeUsageAttribute(AttributeTargets.Method, Inherited:=False)> _
Public NotInheritable Class LCIDConversionAttribute
	Inherits Attribute
Dim instance As LCIDConversionAttribute

/** @attribute ComVisibleAttribute(true) */ 
/** @attribute AttributeUsageAttribute(AttributeTargets.Method, Inherited=false) */ 
public final class LCIDConversionAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.Method, Inherited=false) 
public final class LCIDConversionAttribute extends Attribute
Not applicable.

You can apply this attribute to methods.

This attribute indicates that the marshaler should expect an LCID to be passed after the designated method argument. When calls are made from managed to unmanaged code, the marshaler supplies the LCID argument automatically.

The following example demonstrates different signature translations based on different values supplied to LCIDConversionAttribute.

Imports System
Imports System.Runtime.InteropServices
Imports System.Reflection

Class LCIDAttrSampler

    Const LCID_INSTALLED As Integer = 1
    Const LCID_SUPPORTED As Integer = 2

    <DllImport("KERNEL32.DLL", EntryPoint:="IsValidLocale", _
    SetLastError:=True, CharSet:=CharSet.Unicode, _
    CallingConvention:=CallingConvention.StdCall), _
    LCIDConversionAttribute(0)> _
    Public Shared Function IsValidLocale(ByVal dwFlags As Integer) As Boolean
    End Function

    Public Sub CheckCurrentLCID()
        Dim mthIfo As MethodInfo = Me.GetType().GetMethod("IsValidLocale")
        Dim attr As Attribute = Attribute.GetCustomAttribute(mthIfo, GetType(LCIDConversionAttribute))

        If Not(attr Is Nothing) Then
            Dim lcidAttr As LCIDConversionAttribute = CType(attr, LCIDConversionAttribute)
            Console.WriteLine("Position of the LCID argument in the unmanaged signature: " + lcidAttr.Value.ToString())
        End If

        Dim res As Boolean = IsValidLocale(LCID_INSTALLED)
        Console.WriteLine("Result LCID_INSTALLED " + res.ToString())
        res = IsValidLocale(LCID_SUPPORTED)
        Console.WriteLine("Result LCID_SUPPORTED " + res.ToString())
    End Sub

    Public Shared Sub Main()
        Dim smpl As LCIDAttrSampler = New LCIDAttrSampler()
    End Sub

End Class

import System.*;
import System.Runtime.InteropServices.*;
import System.Reflection.*;

class LCIDAttrSample
    private static final int LCID_INSTALLED = 1;
    private static final int LCID_SUPPORTED = 2;
    /** @attribute DllImport("KERNEL32.DLL", EntryPoint = "IsValidLocale",
        SetLastError = true, CharSet = CharSet.Auto) 
    /** @attribute LCIDConversionAttribute(0)
    public static native boolean IsValidLocale(int dwFlags);

    // Position of the LCID argument options
    public void CheckCurrentLCID()
        MethodInfo mthIfo = this.GetType().GetMethod("IsValidLocale");
        Attribute attr = Attribute.GetCustomAttribute(mthIfo,
        if (attr != null) {
            LCIDConversionAttribute lcidAttr = (LCIDConversionAttribute)attr;
            Console.WriteLine("Position of the LCID argument in the unmanaged "
                + "signature: " 
                + System.Convert.ToString(lcidAttr.get_Value()));

        boolean res = IsValidLocale(LCID_INSTALLED);
        Console.WriteLine("Result LCID_INSTALLED " 
            + System.Convert.ToString(res));
        res = IsValidLocale(LCID_SUPPORTED);
        Console.WriteLine("Result LCID_SUPPORTED " 
            + System.Convert.ToString(res));
    } //CheckCurrentLCID

    public static void main(String[] args)
        LCIDAttrSample smpl = new LCIDAttrSample();
    } //main
} //LCIDAttrSample


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0