< Back

Get-PSFLocalizedString

Sun Jan 19, 2020 6:40 pm

NAME Get-PSFLocalizedString



SYNOPSIS

Returns the localized strings of a module.





SYNTAX

Get-PSFLocalizedString -Module <String> [<CommonParameters>]



Get-PSFLocalizedString -Module <String> -Name <String> [<CommonParameters>]





DESCRIPTION

Returns the localized strings of a module.

By default, it creates a variable that has access to each localized string in the module (with string name as

propertyname).

Alternatively, by specifying a specific string, that string can instead be returned.





PARAMETERS

-Module <String>

The name of the module to map.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

The name of the string to return



Required? true

Position? named

Default value

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

PSFramework.Localization.LocalStrings



System.String





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



PS C:\\>Get-PSFLocalizedString -Module 'MyModule'



Returns an object that can be used to access any localized string.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-PSFLocalizedString -Module 'MyModule' -Name 'ErrorValidation'



Returns the string for the module 'MyModule' that is stored under the 'ErrorValidation' name.











RELATED LINKS