Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 575 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

ArchiveExtractor

Edit on GitHub
Namespace OfficeIMO.Archives
Assembly OfficeIMO.Archives
Source revision a0f47aa4f111 with working tree changes
Source ArchiveExtractor.cs:20
Modifiers static

Extracts one managed archive container into a fresh directory without executing its contents.

Inheritance

  • Object
  • ArchiveExtractor

Methods

public static ArchiveExtractionResult Extract(String packagePath, String destinationDirectory, ArchiveExtractionOptions? options = null, CancellationToken cancellationToken = default) #
ArchiveExtractor.cs:20
Returns: ArchiveExtractionResult

Verifies and extracts selected files from a ZIP, CAB or ordinary MSI package. The destination must be absent or empty. A completed staging directory is published by a same-volume move.

Parameters

packagePath System.String requiredposition: 0
destinationDirectory System.String requiredposition: 1
options OfficeIMO.Archives.ArchiveExtractionOptions? = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3

Exceptions

  • OfficeInspectionResourceLimitException – A configured or fixed managed admission ceiling is exhausted.
  • InvalidDataException – The input is corrupt, unsafe or conflicting.
  • NotSupportedException – The input uses an unsupported format or extraction feature.
  • IOException – The destination is occupied, contains links, or cannot be published.