Marshal::StringToCoTaskMemUni Method (String^)

.NET Framework (current version)

Copies the contents of a managed String to a block of memory allocated from the unmanaged COM task allocator.

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

Syntax

public:
[SecurityCriticalAttribute]
static IntPtr StringToCoTaskMemUni(
	String^ s
)

Parameters

s: Type: System::String^
A managed string to be copied.

Return Value

Type: System::IntPtr

An integer representing a pointer to the block of memory allocated for the string, or 0 if s is null.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The s parameter exceeds the maximum length allowed by the operating system.
OutOfMemoryException	There is insufficient memory available.

StringToCoTaskMemUni 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 Marshal::FreeCoTaskMem. This method provides the opposite functionality of Marshal::PtrToStringUni. The characters of the string are copied as Unicode characters.

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