Export (0) Print
Expand All
Expand Minimize

Marshal.StringToHGlobalUni Method

Copies the contents of a managed String into unmanaged memory.

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

[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public static IntPtr StringToHGlobalUni(
	string s
)

Parameters

s
Type: System.String

A managed string to be copied.

Return Value

Type: System.IntPtr
The address, in unmanaged memory, to where the s was copied, or 0 if a null string was supplied.

ExceptionCondition
OutOfMemoryException

The method could not allocate enough native heap memory.

ArgumentOutOfRangeException

The s parameter exceeds the maximum length allowed by the operating system.

StringToHGlobalUni is useful for custom marshaling or for use when mixing managed and unmanaged code. Since this method allocates the unmanaged memory required for a string, always free the memory by calling FreeHGlobal. This method provides the opposite functionality of Marshal.PtrToStringUni.

NoteNote:

This method uses SecurityAction.LinkDemand to prevent it from being called from untrusted code; only the immediate caller is required to have SecurityPermissionAttribute.UnmanagedCode permission. If your code can be called from partially trusted code, do not pass user input to Marshal class methods without validation. For important limitations on using the LinkDemand member, see Demand vs. LinkDemand.

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

Community Additions

ADD
Show:
© 2014 Microsoft