PtrToStringUni Method (IntPtr)
.NET Framework Class Library
Marshal..::.PtrToStringUni Method (IntPtr)

Allocates a managed String and copies all characters up to the first null character from an unmanaged Unicode string into it.

Namespace:  System.Runtime.InteropServices
Assembly:  mscorlib (in mscorlib.dll)
Visual Basic (Declaration)
<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags := SecurityPermissionFlag.UnmanagedCode)> _
Public Shared Function PtrToStringUni ( _
    ptr As IntPtr _
) As String
Visual Basic (Usage)
Dim ptr As IntPtr
Dim returnValue As String

returnValue = Marshal.PtrToStringUni(ptr)
C#
[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public static string PtrToStringUni(
    IntPtr ptr
)
Visual C++
[SecurityPermissionAttribute(SecurityAction::LinkDemand, Flags = SecurityPermissionFlag::UnmanagedCode)]
public:
static String^ PtrToStringUni(
    IntPtr ptr
)
JScript
public static function PtrToStringUni(
    ptr : IntPtr
) : String

Parameters

ptr
Type: System..::.IntPtr
The address of the first character of the unmanaged string.

Return Value

Type: System..::.String
A managed string holding a copy of the native string if the value of the ptr parameter is not nullNothingnullptra null reference (Nothing in Visual Basic); otherwise, this method returns nullNothingnullptra null reference (Nothing in Visual Basic).

PtrToStringUni is useful for custom marshaling or for use when mixing managed and unmanaged code. Since this method creates a copy of the unmanaged string's contents, you must free the original string as appropriate. This method provides the opposite functionality of Marshal..::.StringToCoTaskMemUni and Marshal..::.StringToHGlobalUni.

NoteNote:

This method uses SecurityAction..::.LinkDemand to prevent it from being called from untrusted code; only the immediate caller is required to have SecurityPermissionAttribute..::.UnmanagedCode permission. If your code can be called from partially trusted code, do not pass user input to Marshal class methods without validation. For important limitations on using the LinkDemand member, see Demand vs. LinkDemand.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
Page view tracker