Set-MyTaskHome
October 14, 2020 ยท View on GitHub
SYNOPSIS
Update the myTask variables.
SYNTAX
Set-MyTaskHome [-Path] <String> [-Passthru] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The MyTasks module relies on global variables to know where your task-related files are stored. The default on Windows systems is your Documents folder. In Linux, it is your home folder. Use this command to modify the path stored in the global variable. It will then update all of the related variables. If you specify an alternate path that relies on a PSDrive, the values will be converted to full file system paths.
It is recommended that you modify your PowerShell profile to import this module and then run this command to reflect the correct location.
EXAMPLES
Example 1
PS C:\> Set-MyTaskHome -path c:\users\pat\dropbox\tasks
This will put all of the task files in the Dropbox folder and update the corresponding variables.
PARAMETERS
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
Enter the path to your new myTaskHome directory.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs.The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Passthru
Display the new task variable values.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
None
NOTES
Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/