Skip to content

Write-PodeHtmlResponse

SYNOPSIS

Writes HTML data to the Response.

SYNTAX

Value (Default)

Write-PodeHtmlResponse [-Value] <Object> [-StatusCode <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

File

Write-PodeHtmlResponse -Path <String> [-StatusCode <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Writes HTML data to the Response, setting the content type accordingly.

EXAMPLES

EXAMPLE 1

Write-PodeHtmlResponse -Value "Raw HTML can be placed here"

EXAMPLE 2

Write-PodeHtmlResponse -Value @{ Message = 'Hello, all!' }

EXAMPLE 3

Write-PodeHtmlResponse -Path 'E:/Site/About.html'

PARAMETERS

-Path

The path to a HTML file.

Type: String
Parameter Sets: File
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
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

-StatusCode

The status code to set against the response.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Value

A String, PSObject, or HashTable value.

Type: Object
Parameter Sets: Value
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
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

NOTES