Marshal.StringToHGlobalUni Method

Copies the contents of a managed String into unmanaged memory.

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

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 s is null.

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. Because 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.

This method copies embedded null characters, and includes a terminating null character.

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

  • SecurityCriticalAttribute 

    requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft