Updated Markdown and Resx files

PSTrueCrypt.psm1

@@ -329,19 +329,19 @@ function Edit-PSTrueCryptContainer
                                     -Product $ProposedParameterValues.Product `
                                     -Timestamp $ProposedParameterValues.Timestamp
 
-                    #Out-Information 'NewContainerOperationSucceeded' -Format $Name
+                    Out-Information 'EditContainerOperationSucceeded' -Format $ProposedParameterValues.Name
                 }
                 else
                 {
-                    #Out-Warning 'NewContainerOperationCancelled'
+                    Out-Warning 'EditContainerOperationCancelled'
                 }
             }
             catch [System.UnauthorizedAccessException]
             {
                 Out-Error 'UnauthorizedAccessException'
             }
         } else {
-            Out-Error 'NoPSTrueCryptContainerFound' -Action Stop
+            Out-Error 'NoPSTrueCryptContainerFound'
         }
     }
 

README.md

@@ -92,6 +92,23 @@ Please add any feedback, concerns, requests and/or bugs in the 'Issues' section
 	E:\>
 	```
 
+	### Edit-PSTrueCryptContainer
+
+	Use this function to edit an existing container that has been created with New-PSTrueCryptContainer.
+	```powershell
+	E:\> Edit-PSTrueCryptContainer Bobby -NewName Bob
+
+	Name Location                            MountLetter Product   Timestamp
+	---- --------                            ----------- -------   ---------
+	Bob  D:\Google Drive\Documents\truecrypt T           TrueCrypt     False
+
+	Edit-PSTrueCryptContainer will set Bobby with the above values.
+	Do you want to proceed?
+	[Y] Yes  [N] No  [?] Help (default is "N"): Y
+	'Bob' PSTrueCrypt container has been updated!
+	E:\>
+	```
+
 	### Remove-PSTrueCryptContainer
 
 	```powershell

docs/Dismount-TrueCrypt.md

@@ -12,7 +12,7 @@ Dismounts a TrueCrypt container.
 ## SYNTAX
 
 ```
-Dismount-TrueCrypt [-Name] <String>
+Dismount-TrueCrypt [-Name] <String> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -25,7 +25,7 @@ The default Alias name is: dmt
 
 ### -------------------------- EXAMPLE 1 --------------------------
 ```
-PS C:\\\>Dismount-TrueCrypt -Name Kryptos
+C:\> Dismount-TrueCrypt -Name Kryptos
 ```
 
 ## PARAMETERS
@@ -45,6 +45,9 @@ 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 (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ### None

docs/Dismount-TrueCryptForceAll.md

@@ -12,7 +12,7 @@ Dismounts all TrueCrypt and VeraCrypt containers.
 ## SYNTAX
 
 ```
-Dismount-TrueCryptForceAll
+Dismount-TrueCryptForceAll [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -24,16 +24,19 @@ The default Alias name is: dmt*
 
 ### -------------------------- EXAMPLE 1 --------------------------
 ```
-PS C:\\\>Dismount-TrueCryptForceAll
+C:\> Dismount-TrueCryptForceAll
 ```
 
 ### -------------------------- EXAMPLE 2 --------------------------
 ```
-PS C:\\\>dmt*
+C:\> dmt*
 ```
 
 ## PARAMETERS
 
+### 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 (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ### None

docs/Edit-PSTrueCryptContainer.md

@@ -0,0 +1,126 @@
+---
+external help file: PSTrueCrypt-help.xml
+online version: https://github.com/marckassay/PSTrueCrypt
+schema: 2.0.0
+---
+
+# Edit-PSTrueCryptContainer
+
+## SYNOPSIS
+Edits a PSTrueCryptContainer in the registry with any of the following values: Name, Location, MountLetter, Product and Timestamp
+
+## SYNTAX
+
+```
+Edits-PSTrueCryptContainer [-Name] <String> [-Location] <String> [-MountLetter] <String> [-Product] <String>
+ [-Timestamp] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Edits a PSTrueCryptContainer in the registry with any of the following values: Name, Location, MountLetter, Product and Timestamp
+
+## EXAMPLES
+
+### -------------------------- EXAMPLE 1 --------------------------
+```
+C:\> Edit-PSTrueCryptContainer Kriptos -Name Kryptos
+```
+
+### -------------------------- EXAMPLE 2 --------------------------
+```
+C:\> Edit-PSTrueCryptContainer Kryptos -Location D:\Kryptos -MountLetter F -Timestamp
+```
+
+## PARAMETERS
+
+### -Name
+The existing name to reference this setting. If you want to 
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: 
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Location
+The TrueCrypt container's location.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: 
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -MountLetter
+A preferred mount drive letter for this container.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: 
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Product
+Specifies if the container has been created with TrueCrypt or VeraCrypt.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: 
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Timestamp
+This switch will update the container's last write time. 
+This is particularly useful when the container resides in  a cloud storage service such as: 'Dropbox', 'Google Drive' or 'OneDrive'.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: 
+
+Required: False
+Position: Named
+Default value: False
+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 (http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### None
+
+## NOTES
+
+## RELATED LINKS
+

docs/Mount-TrueCrypt.md

@@ -12,7 +12,7 @@ Mounts a TrueCrypt container.
 ## SYNTAX
 
 ```
-Mount-TrueCrypt [-KeyfilePath <Array>] [-Password <SecureString>] [-Name] <String>
+Mount-TrueCrypt [-KeyfilePath <Array>] [-Password <SecureString>] [-Name] <String> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -25,18 +25,18 @@ The default Alias name is: mt
 
 ### -------------------------- EXAMPLE 1 --------------------------
 ```
-PS C:\\\>Mount-TrueCrypt -Name Kryptos
+C:\> Mount-TrueCrypt -Name Kryptos
 ```
 
 ### -------------------------- EXAMPLE 2 --------------------------
 ```
-PS C:\\\>Mount-TrueCrypt -Name Kryptos -KeyfilePath C:/Music/Courage.mp3
+C:\> Mount-TrueCrypt -Name Kryptos -KeyfilePath C:/Music/Courage.mp3
 ```
 
 ### -------------------------- EXAMPLE 3 --------------------------
 ```
-PS C:\\\>$SecurePassword = "123abc" | ConvertTo-SecureString -AsPlainText -Force
-PS C:\\\>Mount-TrueCrypt -Name Kryptos -KeyfilePath C:/Music/Courage.mp3 -Password $SecurePassword
+C:\> $SecurePassword = "123abc" | ConvertTo-SecureString -AsPlainText -Force
+C:\> Mount-TrueCrypt -Name Kryptos -KeyfilePath C:/Music/Courage.mp3 -Password $SecurePassword
 ```
 
 ## PARAMETERS
@@ -88,6 +88,9 @@ 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 (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ### None

docs/New-PSTrueCryptContainer.md

@@ -7,13 +7,13 @@ schema: 2.0.0
 # New-PSTrueCryptContainer
 
 ## SYNOPSIS
-Sets in the registry the TrueCrypt container's location, preferred mount drive letter, and name.
+Adds a new PSTrueCryptContainer in the registry with the following values: Name, Location, MountLetter, Product and Timestamp
 
 ## SYNTAX
 
 ```
 New-PSTrueCryptContainer [-Name] <String> [-Location] <String> [-MountLetter] <String> [-Product] <String>
- [-Timestamp]
+ [-Timestamp] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -24,7 +24,7 @@ If call for first time, PSTrueCrypt registry key will be created.
 
 ### -------------------------- EXAMPLE 1 --------------------------
 ```
-PS C:\\\>New-PSTrueCryptContainer -Name Kryptos -Location D:\Kryptos -MountLetter F -Product TrueCrypt
+C:\> New-PSTrueCryptContainer -Name Kryptos -Location D:\Kryptos -MountLetter F -Product TrueCrypt
 ```
 
 ## PARAMETERS
@@ -105,6 +105,9 @@ 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 (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ### None

docs/Remove-PSTrueCryptContainer.md

@@ -12,7 +12,7 @@ Remove settings that were added by the New-PSTrueCryptContainer function.
 ## SYNTAX
 
 ```
-Remove-PSTrueCryptContainer [-Name] <String>
+Remove-PSTrueCryptContainer [-Name] <String> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -22,7 +22,7 @@ Remove the subkey in the HKCU:\Software\PSTrueCrypt registry, that contains the
 
 ### -------------------------- EXAMPLE 1 --------------------------
 ```
-Remove-PSTrueCryptContainer -Name Kryptos
+C:\> Remove-PSTrueCryptContainer -Name Kryptos
 ```
 
 ## PARAMETERS
@@ -42,6 +42,9 @@ 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 (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ### None

docs/Set-EnvironmentPathVariable.md

@@ -4,48 +4,47 @@ online version: https://github.com/marckassay/PSTrueCrypt
 schema: 2.0.0
 ---
 
-# Set-CryptEnvironmentVariable 
+# Remove-PSTrueCryptContainer
 
 ## SYNOPSIS
-Sets the TrueCrypt directory in the environment variable field.
+Remove settings that were added by the New-PSTrueCryptContainer function.
 
 ## SYNTAX
 
 ```
-Set-CryptEnvironmentVariable [-PathVar] <String>
+Remove-PSTrueCryptContainer [-Name] <String> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-Will accept TrueCrypt or VeraCrypt directory paths to be used to set the operating system's environment variable.
-This is needed when Mount-TrueCrypt or Dismount-TrueCrypt functions are called. 
-It will check ParVar parameter to make sure its valid before setting it as an environment variable.
+Remove the subkey in the HKCU:\Software\PSTrueCrypt registry, that contains the value of Name parameter.
 
 ## EXAMPLES
 
 ### -------------------------- EXAMPLE 1 --------------------------
-Setting TrueCrypt directory.
 ```
-PS C:\\\>Set-CryptEnvironmentVariable 'C:\Program Files\TrueCrypt'
+C:\> Remove-PSTrueCryptContainer -Name Kryptos
 ```
 
-
 ## PARAMETERS
 
-### -PathVar
-The directory path where TrueCrypt or VeraCrypt executable resides.
+### -Name
+The name that is used to reference this setting for Mount-TrueCrypt or Dismount-TrueCrypt functions.
 
 ```yaml
 Type: String
 Parameter Sets: (All)
 Aliases: 
 
 Required: True
-Position: 1
+Position: 2
 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 (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ### None