.NET Framework Class Library
LCIDConversionAttribute Class

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

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Runtime.InteropServicesLCIDConversionAttribute

Namespace:   System.Runtime.InteropServices
Assembly:  mscorlib (in mscorlib.dll)
Syntax
<[%$TOPIC/x576wh93_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/x576wh93_en-us_VS_110_2_0_0_0_1%].Method, Inherited := False)> _
<[%$TOPIC/x576wh93_en-us_VS_110_2_0_0_0_2%](True)> _
Public NotInheritable Class LCIDConversionAttribute _
	Inherits [%$TOPIC/x576wh93_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/x576wh93_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/x576wh93_en-us_VS_110_2_0_1_0_1%].Method, Inherited = false)]
[[%$TOPIC/x576wh93_en-us_VS_110_2_0_1_0_2%](true)]
public sealed class LCIDConversionAttribute : [%$TOPIC/x576wh93_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/x576wh93_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/x576wh93_en-us_VS_110_2_0_2_0_1%]::Method, Inherited = false)]
[[%$TOPIC/x576wh93_en-us_VS_110_2_0_2_0_2%](true)]
public ref class LCIDConversionAttribute sealed : public [%$TOPIC/x576wh93_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/x576wh93_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/x576wh93_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/x576wh93_en-us_VS_110_2_0_3_0_2%].Method, Inherited = false)>]
[<[%$TOPIC/x576wh93_en-us_VS_110_2_0_3_0_3%](true)>]
type LCIDConversionAttribute =  
    class 
        inherit [%$TOPIC/x576wh93_en-us_VS_110_2_0_3_0_4%] 
    end

The LCIDConversionAttribute type exposes the following members.

Constructors
  NameDescription
Public method LCIDConversionAttributeInitializes a new instance of the LCIDConversionAttribute class with the position of the LCID in the unmanaged signature.
Top
Properties
  NameDescription
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public property ValueGets the position of the LCID argument in the unmanaged signature.
Top
Methods
  NameDescription
Public method EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

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.

Examples

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()
        smpl.CheckCurrentLCID()
    End Sub 

End Class
using System;
	using System.Runtime.InteropServices;
	using System.Reflection;

	class LCIDAttrSample
	{
		private const int LCID_INSTALLED = 1;
		private const int LCID_SUPPORTED = 2;

		[DllImport("KERNEL32.DLL", EntryPoint="IsValidLocale", SetLastError = true, CharSet = CharSet.Auto)]
		[LCIDConversionAttribute(0)] // Position of the LCID argument 
		public static extern bool IsValidLocale(
													uint dwFlags            // options
												);

		public void CheckCurrentLCID()
		{
			MethodInfo mthIfo = this.GetType().GetMethod("IsValidLocale");
			Attribute attr = Attribute.GetCustomAttribute(mthIfo,typeof(LCIDConversionAttribute));

			if( attr != null)
			{
				LCIDConversionAttribute lcidAttr = (LCIDConversionAttribute)attr;
				Console.WriteLine("Position of the LCID argument in the unmanaged signature: " + lcidAttr.Value.ToString());
			}

			bool res = IsValidLocale(LCID_INSTALLED);
			Console.WriteLine("Result LCID_INSTALLED " + res.ToString());
			res = IsValidLocale(LCID_SUPPORTED);
			Console.WriteLine("Result LCID_SUPPORTED " + res.ToString());
		}

		static void Main(string[] args)
		{
			LCIDAttrSample smpl = new LCIDAttrSample();
			smpl.CheckCurrentLCID();
		}
	}
using namespace System;
using namespace System::Runtime::InteropServices;
using namespace System::Reflection;

#define LCID_INSTALLED 1
#define LCID_SUPPORTED 2

ref class LCIDAttrSample
{
public:

   // Position of the LCID argument

   [DllImport("KERNEL32.DLL",EntryPoint="IsValidLocale",SetLastError=true,CharSet=CharSet::Auto)]
   [LCIDConversionAttribute(0)]
   static bool IsValidLocale( int dwFlags ); // options 

   void CheckCurrentLCID()
   {
      MethodInfo^ mthIfo = this->GetType()->GetMethod( "IsValidLocale" );
      Attribute^ attr = Attribute::GetCustomAttribute( mthIfo, LCIDConversionAttribute::typeid );
      if ( attr != nullptr )
      {
         LCIDConversionAttribute^ lcidAttr = dynamic_cast<LCIDConversionAttribute^>(attr);
         Console::WriteLine( "Position of the LCID argument in the unmanaged signature: {0}", lcidAttr->Value );
      }

      bool res = IsValidLocale( LCID_INSTALLED );
      Console::WriteLine( "Result LCID_INSTALLED {0}", res );
      res = IsValidLocale( LCID_SUPPORTED );
      Console::WriteLine( "Result LCID_SUPPORTED {0}", res );
   }
};

int main()
{
   LCIDAttrSample^ smpl = gcnew LCIDAttrSample;
   smpl->CheckCurrentLCID();
}
Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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