Export (0) Print
Expand All
Expand Minimize

Marshal.StringToBSTR Method

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

[Visual Basic]
Public Shared Function StringToBSTR( _
   ByVal s As String _
) As IntPtr
[C#]
public static IntPtr StringToBSTR(
 string s
);
[C++]
public: static IntPtr StringToBSTR(
 String* s
);
[JScript]
public static function StringToBSTR(
   s : String
) : IntPtr;

Parameters

s
The managed string to be copied.

Return Value

An unmanaged pointer to the BSTR, or 0 if a null reference (Nothing in Visual Basic) string was supplied.

Exceptions

Exception Type Condition
OutOfMemoryException There is insufficient memory available.

Remarks

StringToBSTR is useful for custom marshaling or when mixing managed and unmanaged code. Since 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.

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

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

Marshal Class | Marshal Members | System.Runtime.InteropServices Namespace | PtrToStringBSTR | FreeBSTR

Show:
© 2014 Microsoft