Copies the contents of a managed SecureString object to a block of memory allocated from the unmanaged COM task allocator.
Namespace:
System.Runtime.InteropServices
Assembly:
mscorlib (in mscorlib.dll)
Visual Basic (Declaration)
<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags := SecurityPermissionFlag.UnmanagedCode)> _
Public Shared Function SecureStringToCoTaskMemAnsi ( _
s As SecureString _
) As IntPtr
Dim s As SecureString
Dim returnValue As IntPtr
returnValue = Marshal.SecureStringToCoTaskMemAnsi(s)
[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public static IntPtr SecureStringToCoTaskMemAnsi(
SecureString s
)
[SecurityPermissionAttribute(SecurityAction::LinkDemand, Flags = SecurityPermissionFlag::UnmanagedCode)]
public:
static IntPtr SecureStringToCoTaskMemAnsi(
SecureString^ s
)
public static function SecureStringToCoTaskMemAnsi(
s : SecureString
) : IntPtr
Return Value
Type:
System..::.IntPtrThe address, in unmanaged memory, where the s parameter was copied to, or 0 if a null SecureString object was supplied.
The SecureStringToCoTaskMemAnsi 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 memory by calling ZeroFreeCoTaskMemAnsi. The characters of the string are copied as ANSI characters.
Notes to Callers: This method is supported only on computers running Microsoft Windows 2000 Service Pack 3 or later.
The following code example uses the SecureStringToCoTaskMemAnsi method to marshal and decrypt the contents of a SecureString object to a block of unmanaged memory. It then uses the ZeroFreeCoTaskMemAnsi method to zero out and dispose the unmanaged block.
Imports System
Imports System.Diagnostics
Imports System.Runtime.InteropServices
Imports System.Security
Imports System.Security.Principal
Imports System.Text
Module MarshalExample
Sub Main(ByVal args() As String)
Dim unmanagedRef As IntPtr
Try
' Ask the user for a password.
Console.Write("Please enter your password:")
Dim passWord As SecureString = GetPassword()
Console.WriteLine("Copying and decrypting the string to unmanaged memory...")
' Copy the Secure string to unmanaged memory (and decrypt it).
unmanagedRef = Marshal.SecureStringToCoTaskMemAnsi(passWord)
Catch e As Exception
Console.WriteLine(e.Message)
Finally
If unmanagedRef <> IntPtr.Size Then
Console.WriteLine("Zeroing out unmanaged memory...")
Marshal.ZeroFreeCoTaskMemAnsi(unmanagedRef)
End If
End Try
Console.WriteLine("Done.")
Console.ReadLine()
End Sub
Function GetPassword() As SecureString
Dim password As New SecureString()
' get the first character of the password
Dim nextKey As ConsoleKeyInfo = Console.ReadKey(True)
While nextKey.Key <> ConsoleKey.Enter
If nextKey.Key = ConsoleKey.BackSpace Then
If password.Length > 0 Then
password.RemoveAt(password.Length - 1)
' erase the last * as well
Console.Write(nextKey.KeyChar)
Console.Write(" ")
Console.Write(nextKey.KeyChar)
End If
Else
password.AppendChar(nextKey.KeyChar)
Console.Write("*")
End If
nextKey = Console.ReadKey(True)
End While
Console.WriteLine()
' lock the password down
password.MakeReadOnly()
Return password
End Function
End Module
using System;
using System.Diagnostics;
using System.Runtime.InteropServices;
using System.Security;
using System.Security.Principal;
using System.Text;
namespace SecureStringExample
{
class MarshalExample
{
static void Main(string[] args)
{
IntPtr unmanagedRef = IntPtr.Zero;
try
{
// Ask the user for a password.
Console.Write("Please enter your password:");
SecureString passWord = GetPassword();
Console.WriteLine("Copying and decrypting the string to unmanaged memory...");
// Copy the Secure string to unmanaged memory (and decrypt it).
unmanagedRef = Marshal.SecureStringToCoTaskMemAnsi(passWord);
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
finally
{
if (unmanagedRef != IntPtr.Zero)
{
Console.WriteLine("Zeroing out unmanaged memory...");
Marshal.ZeroFreeCoTaskMemAnsi(unmanagedRef);
}
}
Console.WriteLine("Done.");
Console.ReadLine();
}
public static SecureString GetPassword()
{
SecureString password = new SecureString();
// get the first character of the password
ConsoleKeyInfo nextKey = Console.ReadKey(true);
while (nextKey.Key != ConsoleKey.Enter)
{
if (nextKey.Key == ConsoleKey.Backspace)
{
if (password.Length > 0)
{
password.RemoveAt(password.Length - 1);
// erase the last * as well
Console.Write(nextKey.KeyChar);
Console.Write(" ");
Console.Write(nextKey.KeyChar);
}
}
else
{
password.AppendChar(nextKey.KeyChar);
Console.Write("*");
}
nextKey = Console.ReadKey(true);
}
Console.WriteLine();
// lock the password down
password.MakeReadOnly();
return password;
}
}
}
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5, 3.0, 2.0
Reference