< Back
Get-PSFConfigValue
Post
NAME Get-PSFConfigValue
SYNOPSIS
Returns the configuration value stored under the specified name.
SYNTAX
Get-PSFConfigValue [-FullName] <String> [[-Fallback] <Object>] [-NotNull] [<CommonParameters>]
DESCRIPTION
Returns the configuration value stored under the specified name.
It requires the full name (<Module>.<Name>) and is usually only called by functions.
PARAMETERS
-FullName <String>
The full name (<Module>.<Name>) of the configured value to return.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Fallback <Object>
A fallback value to use, if no value was registered to a specific configuration element.
This basically is a default value that only applies on a "per call" basis, rather than a system-wide default.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NotNull [<SwitchParameter>]
By default, this function returns null if one tries to retrieve the value from either a Configuration that
does not exist or a Configuration whose value was set to null.
However, sometimes it may be important that some value was returned.
By specifying this parameter, the function will throw an error if no value was found at all.
Required? false
Position? named
Default value False
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-PSFConfigValue -FullName 'System.MailServer'
Returns the configured value that was assigned to the key 'System.MailServer'
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-PSFConfigValue -FullName 'Default.CoffeeMilk' -Fallback 0
Returns the configured value for 'Default.CoffeeMilk'. If no such value is configured, it returns '0' instead.
RELATED LINKS
SYNOPSIS
Returns the configuration value stored under the specified name.
SYNTAX
Get-PSFConfigValue [-FullName] <String> [[-Fallback] <Object>] [-NotNull] [<CommonParameters>]
DESCRIPTION
Returns the configuration value stored under the specified name.
It requires the full name (<Module>.<Name>) and is usually only called by functions.
PARAMETERS
-FullName <String>
The full name (<Module>.<Name>) of the configured value to return.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Fallback <Object>
A fallback value to use, if no value was registered to a specific configuration element.
This basically is a default value that only applies on a "per call" basis, rather than a system-wide default.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NotNull [<SwitchParameter>]
By default, this function returns null if one tries to retrieve the value from either a Configuration that
does not exist or a Configuration whose value was set to null.
However, sometimes it may be important that some value was returned.
By specifying this parameter, the function will throw an error if no value was found at all.
Required? false
Position? named
Default value False
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-PSFConfigValue -FullName 'System.MailServer'
Returns the configured value that was assigned to the key 'System.MailServer'
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-PSFConfigValue -FullName 'Default.CoffeeMilk' -Fallback 0
Returns the configured value for 'Default.CoffeeMilk'. If no such value is configured, it returns '0' instead.
RELATED LINKS