Marshal::PtrToStringBSTR Method (IntPtr)

.NET Framework (current version)

Allocates a managed String and copies a binary string (BSTR) stored in unmanaged memory into it.

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

Syntax

public:
[SecurityCriticalAttribute]
static String^ PtrToStringBSTR(
	IntPtr ptr
)

Parameters

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

Return Value

Type: System::String^

A managed string that holds a copy of the unmanaged string.

Exceptions

Exception	Condition
ArgumentNullException	ptr equals IntPtr::Zero.

Remarks

Call this method only on strings that were allocated with the unmanaged SysAllocString and SysAllocStringLen functions.

PtrToStringBSTR 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. This method provides the opposite functionality of the Marshal::StringToBSTR method.

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