Export (0) Print
Expand All

Marshal.SecureStringToGlobalAllocAnsi Method

Copies the contents of a managed SecureString into unmanaged memory, converting into ANSI format as it copies.

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

'Declaration
Public Shared Function SecureStringToGlobalAllocAnsi ( _
	s As SecureString _
) As IntPtr

Parameters

s
Type: System.Security.SecureString

The managed object to copy.

Return Value

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

ExceptionCondition
ArgumentNullException

The s parameter is Nothing.

NotSupportedException

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

OutOfMemoryException

There is insufficient memory available.

The SecureStringToGlobalAllocAnsi 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 the ZeroFreeGlobalAllocAnsi method.

Notes to Callers

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

The following example uses the SecureStringToGlobalAllocAnsi method to marshal and decrypt the contents of a SecureString object to a block of unmanaged memory. It then uses the ZeroFreeGlobalAllocAnsi 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.SecureStringToGlobalAllocAnsi(passWord)


        Catch e As Exception
            Console.WriteLine(e.Message)
        Finally 
            If unmanagedRef <> IntPtr.Zero Then

                Console.WriteLine("Zeroing out unmanaged memory...")

                Marshal.ZeroFreeGlobalAllocAnsi(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

.NET Framework

Supported in: 4.5.2, 4.5.1, 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.

Show:
© 2014 Microsoft