Marshal.PtrToStringAuto Method (IntPtr, Int32)

Allocates a managed String and copies the specified number of characters from a string stored in unmanaged memory into it.

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

public static string PtrToStringAuto(
	IntPtr ptr,
	int len
)

Parameters

ptr
Type: System.IntPtr

For Unicode platforms, the address of the first Unicode character.

-or-

For ANSI plaforms, the address of the first ANSI character.

len
Type: System.Int32

The number of characters to copy.

Return Value

Type: System.String
A managed string that holds a copy of the native string if the value of the ptr parameter is not null; otherwise, this method returns null.

ExceptionCondition
ArgumentException

len is less than zero.

On Unicode platforms, this method calls PtrToStringUni; on ANSI platforms, it calls PtrToStringAnsi. No transformations are done before these methods are called.

PtrToStringAuto is useful for custom marshaling or when mixing managed and unmanaged code. Because this method creates a copy of the unmanaged string's contents, you must free the original string as appropriate. PtrToStringAuto provides the opposite functionality of Marshal.StringToCoTaskMemAuto and Marshal.StringToHGlobalAuto.

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

  • SecurityCriticalAttribute 

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

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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