API Reference

Cmdlet

Get-OfficeExcelWriteReservation

Aliases: ExcelWriteReservation
Namespace PSWriteOffice
Aliases
ExcelWriteReservation
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Object

Gets workbook write-reservation metadata.

Remarks

Gets workbook write-reservation metadata.

Examples

Authored help example

Inspect whether a workbook recommends read-only opening.

PS>


Get-OfficeExcelWriteReservation -Path .\Report.xlsx |
                Format-List Exists, ReadOnlyRecommended, UserName, HasPasswordHash
        

Reports Excel file-sharing/write-reservation metadata separately from workbook protection and package encryption.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-OfficeExcelWriteReservation [<CommonParameters>]
#
Parameter set: Context

Outputs

System.Object

Get-OfficeExcelWriteReservation -Path <String> [<CommonParameters>]
#
Parameter set: Path

Parameters

Path String requiredposition: 0pipeline: Falsealiases: FilePath, FullName, InputPath
Workbook path to inspect.

Outputs

System.Object

Get-OfficeExcelWriteReservation -Document <ExcelDocument> [<CommonParameters>]
#
Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Open workbook document to inspect.

Outputs

System.Object