Copies the contents of a managed String into unmanaged memory, converting into ANSI format as it copies.
Namespace:
System.Runtime.InteropServices
Assembly:
mscorlib (in mscorlib.dll)
Visual Basic (Declaration)
<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags := SecurityPermissionFlag.UnmanagedCode)> _
Public Shared Function StringToHGlobalAnsi ( _
s As String _
) As IntPtr
Dim s As String
Dim returnValue As IntPtr
returnValue = Marshal.StringToHGlobalAnsi(s)
[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public static IntPtr StringToHGlobalAnsi(
string s
)
[SecurityPermissionAttribute(SecurityAction::LinkDemand, Flags = SecurityPermissionFlag::UnmanagedCode)]
public:
static IntPtr StringToHGlobalAnsi(
String^ s
)
public static function StringToHGlobalAnsi(
s : String
) : IntPtr
Return Value
Type:
System..::.IntPtrThe address, in unmanaged memory, to where s was copied, or 0 if a null string was supplied.
StringToHGlobalAnsi is useful for custom marshaling or when mixing managed and unmanaged code. Since this method allocates the unmanaged memory required for a string, always free the memory by calling FreeHGlobal. StringToHGlobalAnsi provides the opposite functionality of Marshal..::.PtrToStringAnsi.
The following code example demonstrates how to convert the contents of a managed String class to unmanaged memory and then dispose of the unmanaged memory when done.
using namespace System;
using namespace System::Runtime::InteropServices;
int main()
{
// Create a managed string.
String^ managedString = "Hello unmanaged world (from the managed world).";
// Marshal the managed string to unmanaged memory.
char* stringPointer = (char*) Marshal::StringToHGlobalAnsi(managedString ).ToPointer();
// Always free the unmanaged string.
Marshal::FreeHGlobal(IntPtr(stringPointer));
return 0;
}
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Reference