CharSet Enum
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Dictates which character set marshaled strings should use.
public enum class CharSetpublic enum CharSet[System.Serializable]
public enum CharSet[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public enum CharSettype CharSet = [<System.Serializable>]
type CharSet = [<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type CharSet = Public Enum CharSet- Inheritance
- Attributes
Fields
| Name | Value | Description |
|---|---|---|
| None | 1 | This value is obsolete and has the same behavior as Ansi. |
| Ansi | 2 | Marshal strings as multiple-byte character strings: the system default Windows (ANSI) code page on Windows, and UTF-8 on Unix. |
| Unicode | 3 | Marshal strings as Unicode 2-byte character strings. |
| Auto | 4 | Automatically marshal strings appropriately for the target operating system. See Charsets and marshaling for details. Although the common language runtime default is Auto, languages may override this default. For example, by default C# and Visual Basic mark all methods and types as Ansi. |
Examples
The following code example shows how to specify a CharSet enumeration value when applying the StructLayoutAttribute to a managed definition.
[StructLayout(LayoutKind::Sequential, CharSet=CharSet::Ansi)]
public ref struct MyPerson
{
public:
String^ first;
String^ last;
};
[StructLayout(LayoutKind.Sequential, CharSet=CharSet.Ansi)]
public struct MyPerson
{
public String first;
public String last;
}
<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Ansi)> _
Public Structure MyPerson
Public first As String
Public last As String
End Structure
Remarks
Because there are several unmanaged string types and only one managed string type, you must use a character set to specify how managed strings should be marshaled to unmanaged code. This enumeration, which provides character set options, is used by DllImportAttribute and StructLayoutAttribute. For a detailed description of the string marshaling and name matching behavior associated with this enumeration, see Specifying a Character Set.
