0 out of 1 rated this helpful - Rate this topic

Marshal.SecureStringToBSTR Method

.NET Framework 2.0

Other Versions

Note: This method is new in the .NET Framework version 2.0.

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

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

Syntax

C++

Copy

public static IntPtr SecureStringToBSTR (
	SecureString s
)

Copy

public static IntPtr SecureStringToBSTR (
	SecureString s
)

JScript

Copy

public static function SecureStringToBSTR (
	s : SecureString
) : IntPtr

Parameters

s: The managed SecureString object to be copied.

Return Value

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

Exceptions

Exception type	Condition
ArgumentNullException	The s parameter is a null reference (Nothing in Visual Basic).
NotSupportedException	The current computer is not running Microsoft Windows 2000 Service Pack 3 or later.
OutOfMemoryException	There is insufficient memory available.

Remarks

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.

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.

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.

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

.NET Framework Security

SecurityPermission for permission to call unmanaged code. Associated enumeration: UnmanagedCode Security action: LinkDemand

Platforms

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

Version Information

.NET Framework

Supported in: 2.0

Reference

Marshal Class
Marshal Members
System.Runtime.InteropServices Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ