Open-RoyalDocument

Open-RoyalDocument

Scripting > Reference > PowerShell Commandlets >

NAME

Open-RoyalDocument
 
 

 

SYNOPSIS

Open an existing RoyalDocument from the filesystem.
 
 
 

 

SYNTAX

Open-RoyalDocument [-Store] <RoyalStore> [-FileName] <string> [[-Password] <SecureString>] [[-LockdownPassword]
<SecureString>] [[-Interactive] <SwitchParameter>] [<CommonParameters>]
 
 
 

 

DESCRIPTION

This cmdlet creates a new RoyalDocument in memory. For saving it to disk, use Out-RoyalDocument.
 
 

 

PARAMETERS

-Store <RoyalStore>
The RoyalStore to which the opened RoyalDocument will be assigned.
 
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-FileName <string>
The FileName that is used for opening the new RoyalDocument.
 
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-Password <SecureString>
The Password for the RoyalDocument (if required).
 
Required? false
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-LockdownPassword <SecureString>
The Lockdown Password for the RoyalDocument (if it is locked down).
 
Required? false
Position? 3
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-Interactive <SwitchParameter>
If specified, the Password is read interactively from user input. The Password property is ignored.
 
Required? false
Position? 4
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.RoyalStore
The RoyalStore to which the opened RoyalDocument will be assigned.
 
System.String
The FileName that is used for opening the new RoyalDocument.
 
System.Security.SecureString
The Password for the RoyalDocument (if required).
 
System.Management.Automation.SwitchParameter
If specified, the Password is read interactively from user input. The Password property is ignored.
 
 
 

 

OUTPUTS

 
---------- EXAMPLE 1 ----------
 
$doc = Open-RoyalDocument -Store $store -FileName "document.rtsz" -Password (Read-Host -AsSecureString "Password")
 
If the -Interactive switch is specified, the cmdlet is asking for the password.
---------- EXAMPLE 2 ----------
 
$pwd = ConvertTo-SecureString "super-secure-pwd" -AsPlainText -Force
$doc = Open-RoyalDocument -Store $store -FileName "document.rtsz" -Password $pwd
 
This is not a secure way to handle the password, but the password is stored in the script anyway... A secure way is
supported by the -Interactive switch: in this case the cmdlet is asking for the password.
 
 

 

RELATED LINKS

New-RoyalObject

Out-RoyalDocument

Move-RoyalObject

Copy-RoyalObject

Set-RoyalObjectValue

Get-RoyalObjectValue

Get-RoyalObject