Register-PSFTypeSerializationData

NAME Register-PSFTypeSerializationData



SYNOPSIS

Registers serialization xml Typedata.





SYNTAX

Register-PSFTypeSerializationData [-TypeData] <String[]> [[-Path] <String>] [<CommonParameters>]





DESCRIPTION

Registers serialization xml Typedata.

Use Get-PSFTypeSerializationData to generate such a string.

When building a module, consider shipping that xml type extension in a dedicated file as part of the module and

import it as part of the manifest's 'TypesToProcess' node.





PARAMETERS

-TypeData <String[]>

The data to register.

Generate with Get-PSFTypeSerializationData.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Path <String>

Where the file should be stored before appending.

While type extensions can be added at runtime directly from memory, from file is more reliable.

By default, a PSFramework path is chosen.

The default path can be configured under the 'PSFramework.Serialization.WorkingDirectory' confguration setting.



Required? false

Position? 2

Default value (Get-PSFConfigValue -FullName 'PSFramework.Serialization.WorkingDirectory'

-Fallback $script:path_typedata)

Accept pipeline input? false

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



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-PSFTypeSerializationData -InputObject 'My.Custom.Type' | Register-PSFTypeSerializationData



Generates a custom type serialization xml and registers it.











RELATED LINKS