psPAS

6.4.85

Private/ConvertTo-InsecureString.ps1

Function ConvertTo-InsecureString {
    <#
    .SYNOPSIS
    Returns string value from SecureString input

    .DESCRIPTION
    Gets the decoded string value of an encoded SecureString

    .PARAMETER SecureString
    The SecureString to decode

    .EXAMPLE
    ConvertTo-InsecureString $SecureStringValue
    #>
    [CmdLetBinding()]
    [OutputType('System.String')]
    Param (

        [Parameter(
            Mandatory = $True,
            ValueFromPipeline = $True
        )]
        [System.Security.SecureString]$SecureString
    )

    Process {
        Try {

            $ptr = [System.Runtime.InteropServices.Marshal]::SecureStringToGlobalAllocUnicode($SecureString)
            [System.Runtime.InteropServices.Marshal]::PtrToStringUni($ptr)

        }

        Finally {

            [System.Runtime.InteropServices.Marshal]::ZeroFreeGlobalAllocUnicode($ptr)

        }
    }
}