Export (0) Print
Expand All

UnmanagedType Enumeration

Identifies how to marshal parameters or fields to unmanaged code.

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

[SerializableAttribute]
[ComVisibleAttribute(true)]
public enum class UnmanagedType

Member nameDescription
Supported by Portable Class LibrarySupported in .NET for Windows Store appsAnsiBStrAn ANSI character string that is a length-prefixed single byte. You can use this member on the String data type.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsAsAnyA dynamic type that determines the type of an object at run time and marshals the object as that type. This member is valid for platform invoke methods only.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsBoolA 4-byte Boolean value (true != 0, false = 0). This is the Win32 BOOL type.
Supported by Portable Class LibrarySupported in .NET for Windows Store appsBStrA Unicode character string that is a length-prefixed double byte. You can use this member, which is the default string in COM, on the String data type.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsByValArrayWhen the MarshalAsAttribute::Value property is set to ByValArray, the SizeConst field must be set to indicate the number of elements in the array. The ArraySubType field can optionally contain the UnmanagedType of the array elements when it is necessary to differentiate among string types. You can use this UnmanagedType only on an array that whose elements appear as fields in a structure.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsByValTStrUsed for in-line, fixed-length character arrays that appear within a structure. The character type used with ByValTStr is determined by the System.Runtime.InteropServices::CharSet argument of the System.Runtime.InteropServices::StructLayoutAttribute attribute applied to the containing structure. Always use the MarshalAsAttribute::SizeConst field to indicate the size of the array.

.NET Framework ByValTStr types behave like C-style, fixed-size strings inside a structure (for example, char s[5]). The behavior in managed code differs from the Microsoft Visual Basic 6.0 behavior, which is not null terminated (for example, MyString As String * 5).

Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsCurrencyA currency type. Used on a System::Decimal to marshal the decimal value as a COM currency type instead of as a Decimal.
Supported by Portable Class LibraryCustomMarshalerSpecifies the custom marshaler class when used with the MarshalAsAttribute::MarshalType or MarshalAsAttribute::MarshalTypeRef field. The MarshalAsAttribute::MarshalCookie field can be used to pass additional information to the custom marshaler. You can use this member on any reference type.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsErrorA native type that is associated with an I4 or an U4 and that causes the parameter to be exported as an HRESULT in the exported type library.
Supported by Portable Class LibrarySupported in .NET for Windows Store appsFunctionPtrAn integer that can be used as a C-style function pointer. You can use this member on a Delegate data type or on a type that inherits from a Delegate.
Supported in .NET for Windows Store appsHStringA Windows Runtime string. You can use this member on the System::String data type.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsI1A 1-byte signed integer. You can use this member to transform a Boolean value into a 1-byte, C-style bool (true = 1, false = 0).
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsI2A 2-byte signed integer.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsI4A 4-byte signed integer.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsI8An 8-byte signed integer.
Supported by Portable Class LibrarySupported in .NET for Windows Store appsIDispatchA COM IDispatch pointer (Object in Microsoft Visual Basic 6.0).
Supported in .NET for Windows Store appsIInspectableA Windows Runtime interface pointer. You can use this member on the Object data type.
Supported by Portable Class LibrarySupported in .NET for Windows Store appsInterfaceA COM interface pointer. The Guid of the interface is obtained from the class metadata. Use this member to specify the exact interface type or the default interface type if you apply it to a class. This member produces the same behavior as UnmanagedType::IUnknown when you apply it to the Object data type.
Supported by Portable Class LibrarySupported in .NET for Windows Store appsIUnknownA COM IUnknown pointer. You can use this member on the Object data type.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsLPArrayA pointer to the first element of a C-style array. When marshaling from managed to unmanaged code, the length of the array is determined by the length of the managed array. When marshaling from unmanaged to managed code, the length of the array is determined from the MarshalAsAttribute::SizeConst and MarshalAsAttribute::SizeParamIndex fields, optionally followed by the unmanaged type of the elements within the array when it is necessary to differentiate among string types.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsLPStrA single byte, null-terminated ANSI character string. You can use this member on the System::String and System.Text::StringBuilder data types.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsLPStructA pointer to a C-style structure that you use to marshal managed formatted classes. This member is valid for platform invoke methods only.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsLPTStrA platform-dependent character string: ANSI on Windows 98, and Unicode on Windows NT and Windows XP. This value is supported only for platform invoke and not for COM interop, because exporting a string of type LPTStr is not supported.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsLPWStrA 2-byte, null-terminated Unicode character string.

Note that you cannot use the LPWStr value with an unmanaged string unless the string was created by using the unmanaged CoTaskMemAlloc function.

Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsR4A 4-byte floating-point number.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsR8An 8-byte floating-point number.
Supported by Portable Class LibrarySupported in .NET for Windows Store appsSafeArrayA SafeArray, which is a self-describing array that carries the type, rank, and bounds of the associated array data. You can use this member with the MarshalAsAttribute::SafeArraySubType field to override the default element type.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsStructA VARIANT, which is used to marshal managed formatted classes and value types.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsSysIntA platform-dependent, signed integer: 4 bytes on 32-bit Windows, 8 bytes on 64-bit Windows.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsSysUIntA platform-dependent, unsigned integer: 4 bytes on 32-bit Windows, 8 bytes on 64-bit Windows.
Supported by Portable Class LibrarySupported in .NET for Windows Store appsTBStrA length-prefixed, platform-dependent char string: ANSI on Windows 98, Unicode on Windows NT. You rarely use this BSTR-like member.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsU1A 1-byte unsigned integer.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsU2A 2-byte unsigned integer.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsU4A 4-byte unsigned integer.
Supported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsU8An 8-byte unsigned integer.
Supported by Portable Class LibrarySupported in .NET for Windows Store appsVariantBoolA 2-byte, OLE-defined VARIANT_BOOL type (true = -1, false = 0).
Supported by Portable Class LibrarySupported in .NET for Windows Store appsVBByRefStrA value that enables Visual Basic to change a string in unmanaged code and have the results reflected in managed code. This value is only supported for platform invoke.

Use the UnmanagedType enumeration with the System.Runtime.InteropServices::MarshalAsAttribute attribute to specify how types are marshaled during interoperation with unmanaged code. You can use this enumeration to marshal code using simple value types (I1, I2, I4, I8, R4, R8, U2, U4, and U8), unmanaged types that are unavailable in the .NET Framework, and various miscellaneous types.

For more information, see Interoperating with Unmanaged Code.

The following code fragment demonstrates how to declare, in managed source code, an unmanaged interface implemented by a COM component. The System.Runtime.InteropServices::ComImportAttribute attribute prevents the IMyStorage interface from being exported back for use by COM. (COM clients should use the existing COM component directly.) In this example, MarshalAsAttribute specifies serveral UnmanagedType members, which represent the types used by the original COM interface.

using namespace System;
using namespace System::Runtime::InteropServices;

// If you do not have a type library for an interface 
// you can redeclare it using ComImportAttribute. 
// This is how the interface would look in an idl file. 
//[ 
//object, 
//uuid("73EB4AF8-BE9C-4b49-B3A4-24F4FF657B26"),
//dual, helpstring("IMyStorage Interface"),
//pointer_default(unique) 
//] 
//interface IMyStorage : IDispatch 
//{ 
// [id(1)] 
// HRESULT GetItem([in] BSTR bstrName, [out, retval] IDispatch ** ppItem); 
// [id(2)] 
// HRESULT GetItems([in] BSTR bstrLocation, [out] SAFEARRAY(VARIANT)* pItems); 
// [id(3)] 
// HRESULT GetItemDescriptions([in] BSTR bstrLocation, [out] SAFEARRAY(VARIANT) ** ppItems); 
// [id(4), propget] 
// HRESULT get_IsEmpty([out, retval] BOOL * pfEmpty); 
//}; 
// This is the managed declaration.

[ComImport]
[Guid("73EB4AF8-BE9C-4b49-B3A4-24F4FF657B26")]
interface class IMyStorage
{
   [DispId(1)]
   Object^ GetItem( [In,MarshalAs(UnmanagedType::BStr)]String^ bstrName );

   //[return : MarshalAs(UnmanagedType::Interface)]

   [DispId(2)]
   void GetItems( [In,MarshalAs(UnmanagedType::BStr)]String^ bstrLocation, [Out,MarshalAs(UnmanagedType::SafeArray,
   SafeArraySubType=VarEnum::VT_VARIANT)]array<Object^>^Items );

   [DispId(3)]
   void GetItemDescriptions( [In]String^ bstrLocation, [In,Out,MarshalAs(UnmanagedType::SafeArray)]array<Object^>^varDescriptions );

   property bool IsEmpty 
   {
      [DispId(4)]
      [returnvalue:MarshalAs(UnmanagedType::VariantBool)]
      bool get();
   }
};

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, 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.

Show:
© 2014 Microsoft