Marshal::StringToHGlobalUni Method (String^)

.NET Framework (current version)

Copies the contents of a managed String into unmanaged memory.

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

Syntax

public:
[SecurityCriticalAttribute]
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.

Exceptions

Exception	Condition
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.

Security

SecurityCriticalAttribute

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

Version Information

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1