This topic has not yet been rated - Rate this topic

Marshal.StringToBSTR Method

.NET Framework 4

Other Versions

Allocates a BSTR Data Type and copies the contents of a managed String into it.

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

Syntax

C++

Copy

public static IntPtr StringToBSTR(
	string s
)

Parameters

s: Type: System.String
The managed string to be copied.

Return Value

Type: System.IntPtr
An unmanaged pointer to the BSTR, or 0 if s is null.

Exceptions

Exception	Condition
OutOfMemoryException	There is insufficient memory available.
ArgumentOutOfRangeException	The length for s is out of range.

Remarks

StringToBSTR 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 BSTR when finished by calling Marshal.FreeBSTR. This method provides the opposite functionality of Marshal.PtrToStringBSTR.

Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET Framework Security

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

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

Marshal Class

System.Runtime.InteropServices Namespace

PtrToStringBSTR

FreeBSTR

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ