Skip to content

ConvertTo-PodeString

SYNOPSIS

Converts an input object to a string representation.

SYNTAX

ConvertTo-PodeString [[-InputObject] <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This function takes an input object and converts it to a string representation. It handles various types of input, including null values, strings, value types, and other objects. The resulting string is trimmed of any trailing newlines in the case of complex objects.

EXAMPLES

EXAMPLE 1

$stringValue = ConvertTo-PodeString -InputObject $someObject

EXAMPLE 2

$stringValue = $someObject | ConvertTo-PodeString

PARAMETERS

-InputObject

The object to be converted to a string.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

CommonParameters

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

INPUTS

OUTPUTS

System.String

NOTES