IOpcPart::GetCompressionOptions method

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

Syntax


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

Parameters

compressionOptions [out, retval]

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 codeDescription
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

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Msopc.h

IDL

Opcobjectmodel.idl

See also

IOpcPart
Overviews
Getting Started with the Packaging API
Open Packaging Conventions Fundamentals
Parts Overview
Reference
OPC_COMPRESSION_OPTIONS
Packaging Errors
Packaging API Reference
Packaging API Samples
External Resources
ECMA-376 OpenXML

 

 

Community Additions

ADD
Show: