< Back

Get-CTypeFormatPS1XML

Mon Jan 13, 2020 8:19 am

NAME Get-CTypeFormatPS1XML



SYNOPSIS

Returns the text of a PS1XML which defines output formatting for a type.





SYNTAX

Get-CTypeFormatPS1XML [-TypeName] <String> [-PropertyName <String>] [-PropertyType <String>] [-PropertyTableWidth

<String>] [-PropertyKeywords <String[]>] [<CommonParameters>]





DESCRIPTION

Returns the text of a PS1XML which defines output formatting for a type.

Pass this to Update-CTypeFormatData to apply this formatting to the current session.

You can also save this into a PS1XML file associated with your module.





PARAMETERS

-TypeName <String>

Name for the type



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PropertyName <String>

Name of a property of the type being defined



Required? false

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-PropertyType <String>

Type of a property of the type being defined



Required? false

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-PropertyTableWidth <String>

Table width of a property of the type being defined, per Add-CType.



Required? false

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-PropertyKeywords <String[]>

Other keywords per Add-CType.



Required? false

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

System.String







RELATED LINKS

Add-CType

Update-CTypeFormatData