Skip to content

Latest commit

 

History

History
135 lines (94 loc) · 2.93 KB

Get-PSWorkItemCategory.md

File metadata and controls

135 lines (94 loc) · 2.93 KB
external help file Module Name online version schema
PSWorkItem-help.xml
PSWorkItem
2.0.0

Get-PSWorkItemCategory

SYNOPSIS

Get defined PSWorkItem categories.

SYNTAX

Get-PSWorkItemCategory [[-Category] <String>] [-Path <String>] [<CommonParameters>]

DESCRIPTION

When you create a PSWorkItem, you need to tag it with a category. The category must be defined before you can use it. Get-PSWorkItemCategory will display information about your categories.

EXAMPLES

Example 1

PS C:\> Get-PSWorkItemCategory

Category    Description
--------    -----------
Work        Anything client-oriented
Customer    Anything client-oriented
Other       Miscellaneous catch-all
Personal    Personal or family tasks
Project     Module or assigned work
Business    Corporate-related tasks
Event       Conference, webinar, or other event
Testing     Sample category for testing
Training    Anything related to a training event

Get all defined categories.

Example 2

PS C:\> Get-PSWorkItemCategory blog

Category Description
-------- -----------
Blog     Blog management or content

Get information about a single category.

Example 3

PS C:\> Get-PSWorkItemCategory | Select-Object Category,ANSIString

Category    ANSIString
--------    ----------
Work        `e[36m
Customer
Other       `e[38;5;204m
Personal    `e[32m
Project     `e[38;5;215m
Business
Event       `e[38;5;153m
Testing
Training    `e[94m

Display categories with their ANSI escape sequences.

PARAMETERS

-Category

Specify the category name. There should be tab completion for this parameter. If you will be specifying an alternate database path, specify the path before using this parameter so that correct categories will be detected.

Type: String[]
Parameter Sets: (All)
Aliases: Name

Required: False
Position: 0
Default value: *
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Path

The path to the PSWorkItem SQLite database file. It should end in .db

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $PSWorkItemPath
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

System.String[]

OUTPUTS

PSWorkItemCategory

NOTES

Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/

RELATED LINKS

Add-PSWorkItemCategory

Remove-PSWorkItemCategory

Update-PSWorkItemPreferences