|
<< Click to Display Table of Contents >> RayPack > 8.0 > User Guide > Command Line Tools > PowerShell Automation Basic Operations |
Opens a project in MSI or RPP format.
Name |
Type |
Mandatory |
Description |
File |
FileInfo |
Yes |
The file to open. |
Returns an instance of RayPackFile type. You should keep the reference to the returned object in a variable, so that you can execute operations on it, export it or close it.
Closes an open project to release resources and clean up temporary files.
Name |
Type |
Mandatory |
Description |
Project |
RayPackFile |
Yes |
The file to open. |
Commit |
Switch |
No |
If set, all changes executed on a project will be saved. If you do not use this switch, the project is closed without saving your changes. |
All |
Switch |
No |
Instead of specifying a project (via -Project parameter), you can instead use this switch to close all projects in the current session. |
This command let does not return any value.
Retrieves the full summary information of the specified project or a specific property (e.g., Author). Returns an object with all relevant summary data or the requested property.
Name |
Type |
Mandatory |
Description |
Project |
RayPackFile |
Yes |
The file to open. |
Property |
SummaryInfoProperties |
No |
Represents the name or type of a specific summary information property defined for the project. |
Returns the full summary information object or a specific property value.
Updates the entire summary information object or a specific property for the project. Returns either the complete summary object or the updated property, depending on the parameters used.
1. Option
Name |
Type |
Mandatory |
Description |
Project |
RayPackFile |
Yes |
The file to open. |
SummaryInfo |
SummaryInfoData |
Yes |
The data or content associated with a specific property in the summary information. |
2. Option
Name |
Type |
Mandatory |
Description |
Project |
RayPackFile |
Yes |
The file to open. |
Property |
EditableSummaryInfoProperties |
Yes |
Represents the name or type of a specific summary information property defined for the project. |
Value |
String |
No |
Defines the data or content to be set for the specified property in the summary information. |
Returns the updated summary information object or property.
Creates a new summary information object based on an MSI template or copies it from an existing object. Returns the new summary information object.
Name |
Type |
Mandatory |
Description |
CloneFrom |
SummaryInfoData |
No |
Specifies an existing summary information object to copy for creating a new one. |
Returns a new summary information object.