Close-RoyalDocument

Close-RoyalDocument

Scripting > Reference > PowerShell Commandlets >

NAME

Close-RoyalDocument
 
 

 

SYNOPSIS

Closes an opened RoyalDocument.
 
 
 

 

SYNTAX

Close-RoyalDocument [-Document] <RoyalDocument> [[-Force] <SwitchParameter>] [<CommonParameters>]
 
 
 

 

DESCRIPTION

This cmdlet closes an opened RoyalDocument and removes it from the RoyalStore.
 
 

 

PARAMETERS

-Document <RoyalDocument>
The RoyalDocument that will be closed.
 
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-Force <SwitchParameter>
Using Force closes the RoyalDocument even if it has changes. This parameter should always be used with caution.
 
Required? false
Position? 1
Default value False
Accept pipeline input? true (ByValue, ByPropertyName)
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

RoyalDocumentLibrary.RoyalDocument
The RoyalDocument that will be closed.
 
System.Management.Automation.SwitchParameter
Using Force closes the RoyalDocument even if it has changes. This parameter should always be used with caution.
 
 
 

 

OUTPUTS

 
---------- EXAMPLE 1 ----------
 
Close-RoyalDocument -Document $doc
 
When using -Force, the RoyalDocument is closed even if it has changes that have not been saved via
Out-RoyalDocument.
 
 

 

RELATED LINKS

New-RoyalObject

Out-RoyalDocument

Move-RoyalObject

Copy-RoyalObject

Set-RoyalObjectValue

Get-RoyalObjectValue

Get-RoyalObject