Get-RoyalObject

Get-RoyalObject

Scripting > Reference > PowerShell Commandlets >

NAME

Get-RoyalObject
 
 

 

SYNOPSIS

Get RoyalObject by various search parameters.
 
 
 

 

SYNTAX

Get-RoyalObject [[-Folder] <RoyalFolder>] [[-Type] <RoyalObjectType>] [[-Name] <string>] [[-Store] <RoyalStore>]
[[-IncludeTrashcan] <SwitchParameter>] [<CommonParameters>]
 
Get-RoyalObject [[-Folder] <RoyalFolder>] [[-Store] <RoyalStore>] [[-IncludeTrashcan] <SwitchParameter>] [[-Id]
<string>] [<CommonParameters>]
 
 
 

 

DESCRIPTION

This cmdlet retrievs from a given RoyalDocument a RoyalObject by its ID.
 
 

 

PARAMETERS

-Folder <RoyalFolder>
The RoyalObject or RoyalFolder thas is going to be searched. Cannot be used in conjunction with the parameter
Store.
 
Required? false
Position? 0
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-Type <RoyalObjectType>
The type of RoyalObjects that should bet returned.
 
Required? false
Position? 1
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-Name <string>
The name of RoyalObjects that should bet returned (Wildcard * is allowed).
 
Required? false
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-Store <RoyalStore>
The RoyalStore that should be searched. Cannot be used in conjunction with the parameter Folder.
 
Required? false
Position? 3
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-IncludeTrashcan <SwitchParameter>
If Trashcan (deleted) RoyalObjects should be returned as well.
 
Required? false
Position? 4
Default value False
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-Id <string>
The Id fo the RoyalObject (Guid).
 
Required? false
Position? 5
Default value
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.RoyalFolder
The RoyalObject or RoyalFolder thas is going to be searched. Cannot be used in conjunction with the parameter
Store.
 
RoyalDocument.PowerShell.RoyalObjectType
The type of RoyalObjects that should bet returned.
 
System.String
The name of RoyalObjects that should bet returned (Wildcard * is allowed).
 
RoyalDocumentLibrary.RoyalStore
The RoyalStore that should be searched. Cannot be used in conjunction with the parameter Folder.
 
System.Management.Automation.SwitchParameter
If Trashcan (deleted) RoyalObjects should be returned as well.
 
 
 

 

OUTPUTS

 
---------- EXAMPLE 1 ----------
 
Get-RoyalObjects -Folder $doc -Type RoyalFolder -Name "Fold*" | Select-Object Name
 
This cmdlet returns all Folders from $doc that start with "Fold" in its Name property.
 
 

 

RELATED LINKS

New-RoyalObject

Move-RoyalObject

Copy-RoyalObject

Set-RoyalObjectValue

Get-RoyalObjectValue

Get-RoyalObject