Export (0) Print
Expand All

Marshal.StringToCoTaskMemAnsi Method

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

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

public static IntPtr StringToCoTaskMemAnsi(
	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.

ExceptionCondition
OutOfMemoryException

There is insufficient memory available.

ArgumentOutOfRangeException

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

StringToCoTaskMemAnsi is useful for custom marshaling or 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.PtrToStringAnsi. The characters of the string are copied as ANSI characters.

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

Show:
© 2015 Microsoft