Remove-BluGenieFile

Remove-BluGenieFile

SYNOPSIS

Remove file

SYNTAX

Remove-BluGenieFile [[-Path] <String[]>] [-ClearGarbageCollecting] [-UseCache] [-CachePath <String>] [-RemoveCache] [-Walkthrough] [-ReturnObject] [-OutUnEscapedJSON] [-OutYaml] [-FormatView <String>] 
[<CommonParameters>]

DESCRIPTION

Remove File(s). Also get detailed information on the item locking the file if you can't remove it.

EXAMPLES

EXAMPLE 1

Command: Remove-BluGenieFile -path "C:\Temp\File1.txt","%SystemDrive%\Pagefile.sys"

Description:
Notes:

EXAMPLE 2

Command: Remove-BluGenieFile -path "C:\Temp\File1.txt,"%SystemDrive%\Pagefile.sys"

Description: Remove file(s) using a Single String Array with a comma separator
Notes:

EXAMPLE 3

Command: Remove-BluGenieFile -path "C:\Temp\File1.txt;"%SystemDrive%\Pagefile.sys"

Description: Remove file(s) using a Single String Array with a semicolon separator
Notes:

EXAMPLE 4

Command: Get-ChildItem -path $env:temp -File | Remove-BluGenieFile

Description: Remove file(s) using Named value from Pipeline
Notes:

EXAMPLE 5

Command: Get-ChildItem -path $env:temp -File | Select-Object -ExpandProperty Fullname | Remove-BluGenieFile

Description: Remove file(s) using value from Pipeline
Notes:

EXAMPLE 6

Command: Get-FileRemove -path "C:\Temp\File1.txt"

Description: Remove file(s) using the Function Alias
Notes:

EXAMPLE 7

Command: Remove-BluGenieFile -path "C:\Temp\File1.txt" -UseCache

Description: Cache found objects to disk to not over tax Memory resources
Notes: By default the Cache location is %SystemDrive%\Windows\Temp

EXAMPLE 8

Command: Remove-BluGenieFile -path "C:\Temp\File1.txt" -UseCache -RemoveCache

Description: Remove Cache data
Notes:

EXAMPLE 9

Command: Remove-BluGenieFile -path "C:\Temp\File1.txt" -UseCache -CachePath $Env:Temp

Description: Change the Cache path to the current users Temp directory
Notes: By default the Cache location is %SystemDrive%\Windows\Temp

EXAMPLE 10

Command: Get-ChildItem -path $env:temp -File | Remove-BluGenieFile -UseCache -ClearGarbageCollecting

Description: Scan large directories and limit the memory used to track data
Notes:

EXAMPLE 11

Command: Remove-BluGenieFile -Help

Description: Call Help Information
Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal 
Get-Help will be called with the -Full parameter

EXAMPLE 12

Command: Remove-BluGenieFile -WalkThrough

Description: Call Help Information [2]
Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal 
Get-Help will be called with the -Full parameter

EXAMPLE 13

Command: Remove-BluGenieFile -path "C:\Temp\File1.txt" -OutUnEscapedJSON

Description: Return a detailed function report in an UnEscaped JSON format
Notes:  The OutUnEscapedJSON is used to Beautify the JSON return and not Escape any Characters.  Normal return data is a Hash Table.

EXAMPLE 14

Command: Remove-BluGenieFile -path "C:\Temp\File1.txt" -OutYaml

Description: Return a detailed function report in YAML format
Notes:  The OutUnEscapedJSON is used to Beautify the JSON return and not Escape any Characters.  Normal return data is a Hash Table.

EXAMPLE 15

Command: Remove-BluGenieFile -path "C:\Temp\File1.txt" -ReturnObject

Description: Return Output as a Object
Notes:  The ReturnObject is used to return a PowerShell Object.  Normal return data is a Hash Table.
          This parameter is also used with the ForMat

EXAMPLE 16

Command: Remove-BluGenieFile -path "C:\Temp\File1.txt" -ReturnObject -FormatView Yaml

Description: Output PSObject information in Yaml format
Notes:  Current formats supported by default are ('Table','Custom','CustomModified','None','JSON','OutUnEscapedJSON','CSV', 'Yaml', 'XML')
          Default is set to (None) and normal PSObject.

PARAMETERS

Path

-Path <String[]>
   Description: File Path
   Notes:  
   Alias: 'Fullname'
   ValidateSet:
   
   Required?                    false
   Position?                    1
   Default value                
   Accept pipeline input?       true (ByValue, ByPropertyName)
   Accept wildcard characters?  false

ClearGarbageCollecting

-ClearGarbageCollecting [<SwitchParameter>]
   Description: Garbage Collection in Powershell to Speed up Scripts and help lower memory consumption
   Notes: This is enabled by default.  To disable use -ClearGarbageCollecting:$False
   Alias: 
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                True
   Accept pipeline input?       false
   Accept wildcard characters?  false

UseCache

-UseCache [<SwitchParameter>]
   Description: Cache found objects to disk.  This is to not over tax Memory resources with found artifacts
   Notes: By default the Cache location is %SystemDrive%\Windows\Temp
   Alias: 
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false

CachePath

-CachePath <String>
   Description: Path to store the Cache information
   Notes: By default the Cache location is %SystemDrive%\Windows\Temp
   Alias: 
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                $('{0}\Windows\Temp\{1}.log' -f $env:SystemDrive, $(New-BluGenieUID))
   Accept pipeline input?       false
   Accept wildcard characters?  false

RemoveCache

-RemoveCache [<SwitchParameter>]
   Description: Remove Cache data on completion
   Notes: Cache information is removed right before the data is returned to the calling process
   Alias: 
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false

Walkthrough

-Walkthrough [<SwitchParameter>]
   Description:  Start the dynamic help menu system to help walk through the current command and all of the parameters
   Notes:  
   Alias: Help
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false

ReturnObject

-ReturnObject [<SwitchParameter>]
   Description: Return information as an Object
   Notes: By default the data is returned as a Hash Table
   Alias: 
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false

OutUnEscapedJSON

-OutUnEscapedJSON [<SwitchParameter>]
   Description: Remove UnEsacped Char from the JSON information.
   Notes: This will beautify json and clean up the formatting.
   Alias: 
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false

OutYaml

-OutYaml [<SwitchParameter>]
   Description: Return detailed information in Yaml Format
   Notes: Only supported in Posh 3.0 and above
   Alias: 
   ValidateSet:
   
   Required?                    false
   Position?                    named
   Default value                False
   Accept pipeline input?       false
   Accept wildcard characters?  false

FormatView

-FormatView <String>
   Description: Automatically format the Return Object 
   Notes: Yaml is only supported in Posh 3.0 and above
   Alias: 
   ValidateSet: 'Table','Custom','CustomModified','None','JSON','OutUnEscapedJSON','CSV', 'Yaml'
   
   Required?                    false
   Position?                    named
   Default value                None
   Accept pipeline input?       false
   Accept wildcard characters?  false

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.