Marshal.StringToCoTaskMemAuto(String) Method

Definition

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

public static IntPtr StringToCoTaskMemAuto (string? s);
public static IntPtr StringToCoTaskMemAuto (string s);
[System.Security.SecurityCritical]
public static IntPtr StringToCoTaskMemAuto (string s);

Parameters

s
String

A managed string to be copied.

Returns

IntPtr

The allocated memory block, or 0 if s is null.

Attributes

Exceptions

There is insufficient memory available.

The length for s is out of range.

Remarks

StringToCoTaskMemAuto 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 FreeCoTaskMem. This method provides the opposite functionality of Marshal.PtrToStringAuto.

The characters of the string are copied as Unicode characters.

Applies to

Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

See also