IOpcPart::GetCompressionOptions method (msopc.h)

Article
02/22/2024

Gets a value that describes the way part content is compressed.

Syntax

HRESULT GetCompressionOptions(
  [out, retval] OPC_COMPRESSION_OPTIONS *compressionOptions
);

Parameters

[out, retval] compressionOptions

A value that describes the way part content is compressed.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
E_POINTER	The compressionOptions parameter is NULL.

Remarks

For more information about parts, see the Open Packaging Conventions Fundamentals and the ECMA-376 OpenXML, 1st Edition, Part 2: Open Packaging Conventions (OPC).

Thread Safety

Packaging objects are not thread-safe.

For more information, see the Getting Started with the Packaging API.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	msopc.h