Disable-XRefPersistence.md

external help file	StreamXRef-help.xml
Module Name	StreamXRef
online version	https://github.com/awsr/PS-StreamXRef/blob/master/docs/Disable-XRefPersistence.md
schema	2.0.0

Disable-XRefPersistence

SYNOPSIS

Disables the built-in data persistence option for the StreamXRef module.

SYNTAX

Disable-XRefPersistence [-Quiet] [-Remove] [<CommonParameters>]

DESCRIPTION

The Disable-XRefPersistence cmdlet disables the built-in data persistence option by renaming the file and unregistering the event subscriber. The Remove parameter can be specified to delete all persistent data files.

EXAMPLES

Example 1

PS > Disable-XRefPersistence

Disable the built-in data persistence.

PARAMETERS

-Quiet

Suppress writing information messages to host.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Remove

Delete the data file instead of renaming it when disabling persistence (or delete the renamed file if persistence is already disabled).

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

None

OUTPUTS

None

NOTES

RELATED LINKS