Get-VaultFiles
Returns an array of file objects that match your parameters.
Syntax
Get-VaultFiles [-FileName <String>] [-Folder <String>] [-Properties <Hashtable>] [<CommonParameters>]
Parameters
Type |
Name |
Description |
Optional |
---|---|---|---|
String |
FileName |
Name of a file in Vault |
yes |
String |
Folder |
Absolute path to a Vault folder |
yes |
Hashtable |
Properties |
Search for files with matching properties |
yes |
Return type
File[] ← on success
empty ← on failure
Remarks
If you want a single specific file use Get-Vaultfile.
In order to search files by properties the -Properties argument allows to search the values of user defined properties and system properties which can be passed using their:
display names (e.g.
@{'Title' = ...}
can be used with English Vault or@{'Titel' = ...}
can be used with german Vault environments).
Examples
Get all files from the specified Vault folder
$files = Get-VaultFiles -Folder '$/Designs/2014/03/0'
$files = Get-VaultFiles
foreach($file in $files){
$file.'File Name'
}