A newer version of this website is available.
Show / Hide Table of Contents

New-RoyalStore

SYNOPSIS

Creates a new RoyalStore container to open one or more Royal TS/X documents.

SYNTAX

New-RoyalStore -UserName1 <String> [-AppDocPath <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet creates a new RoyalStore in memory.

EXAMPLES

EXAMPLE 1

$store = New-RoyalStore -UserName "username"
$doc = New-RoyalDocument -Store $store -FileName doc.rtsz -Name "documentname"
Write-Host ($row[0] + " - " + $row[1])

The variable $store is used for New-RoyalDocument cmdlet.

EXAMPLE 2

# Pipe the RoyalStore to the New-RoyalDocument cmdlet
$doc = New-RoyalStore -UserName "username" | New-RoyalDocument -FileName doc.rtsz -Name "documentname"

PARAMETERS

-AppDocPath

{{ Fill AppDocPath Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-UserName1

{{ Fill UserName1 Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: True
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

NOTES

The RoyalStore is the basic container that is needed when working with Royal TS/X documents (.rtsz files).

RELATED LINKS

New-RoyalDocument

Open-RoyalDocument

Close-RoyalDocument

Out-RoyalDocument

  • Improve this Doc
In This Article
Back to top   Copyright © Royal Apps