Public/ConvertFrom-CompressedByteArrayToString.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
<#
    .SYNOPSIS
        Converts a string to a byte array object.
 
    .DESCRIPTION
        Converts a string to a byte array object.
 
    .PARAMETER String
        A string object for conversion.
 
    .EXAMPLE
        $bytes = ConvertFrom-CompressedByteArrayToString -String 'A string
        $bytes.GetType()
 
        IsPublic IsSerial Name BaseType
        -------- -------- ---- --------
        True True Object[] System.Array
 
        $bytes[0].GetType()
 
        IsPublic IsSerial Name BaseType
        -------- -------- ---- --------
        True True Byte System.ValueType
 
    .OUTPUTS
        [Byte[]]
 
    .LINK
        http://convert.readthedocs.io/en/latest/functions/ConvertFrom-CompressedByteArrayToString/
#>

function ConvertFrom-CompressedByteArrayToString
{
    [CmdletBinding(HelpUri = 'http://convert.readthedocs.io/en/latest/functions/ConvertFrom-CompressedByteArrayToString/')]
    param
    (
        [Parameter(
            Mandatory = $true,
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [Byte[]]
        $ByteArray,

        [ValidateSet('ASCII', 'BigEndianUnicode', 'Default', 'Unicode', 'UTF32', 'UTF7', 'UTF8')]
        [String]
        $Encoding = 'UTF8'
    )

    begin
    {
        $userErrorActionPreference = $ErrorActionPreference
    }

    process
    {
        try
        {
            $inputStream = [System.IO.MemoryStream]::new($ByteArray)
            $output = [System.IO.MemoryStream]::new()

            $gzipStream = [System.IO.Compression.GzipStream]::new($inputStream, ([IO.Compression.CompressionMode]::Decompress))
            $gzipStream.CopyTo($output)
            $gzipStream.Close()
            $inputStream.Close()

            [System.Text.Encoding]::$Encoding.GetString($output.ToArray())
        }
        catch
        {
            Write-Error -ErrorRecord $_ -ErrorAction $userErrorActionPreference
        }
    }
}