Marshal::SecureStringToBSTR Method (SecureString^)

.NET Framework (current version)

Allocates an unmanaged binary string (BSTR) and copies the contents of a managed SecureString object into it.

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

Syntax

public:
[SecurityCriticalAttribute]
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.

Exceptions

Exception	Condition
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.

Security

SecurityCriticalAttribute

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

Version Information

.NET Framework
Available since 2.0