Marshal.SecureStringToBSTR Method

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

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

public static IntPtr SecureStringToBSTR(
	SecureString s
)

Parameters

s
Type: System.Security.SecureString

The managed object to copy.

Return Value

Type: System.IntPtr
The address, in unmanaged memory, where the s parameter was copied to, or 0 if a null object was supplied.

ExceptionCondition
ArgumentNullException

The s parameter is null.

NotSupportedException

The current computer is not running Windows 2000 Service Pack 3 or later.

OutOfMemoryException

There is insufficient memory available.

The SecureStringToBSTR method 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 the ZeroFreeBSTR method.

Notes to Callers

This method is supported only on computers running Windows 2000 Service Pack 3 or later.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.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