Expand Minimize

SetCompressorInformation function

Sets information in a compressor for a particular compression algorithm.

Syntax


BOOL SetCompressorInformation(
  _In_  COMPRESSOR_HANDLE CompressorHandle,
  _In_  COMPRESS_INFORMATION_CLASS CompressInformationClass,
  _In_  PVOID CompressInformation,
  _In_  SIZE_T CompressInformationSize
);

Parameters

CompressorHandle [in]

Handle to the compressor.

CompressInformationClass [in]

A value that identifies the type of information. of the enumeration that identifies the type of information.

CompressInformation [in]

The information being set read as bytes. The maximum size in bytes is given by CompressInformationSize.

CompressInformationSize [in]

Maximum size of the information in bytes.

Return value

If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If the compression algorithm fails for some internal reason, the error from GetLastError can be ERROR_FUNCTION_FAILED. If the system cannot locate the compression algorithm handle, the error can be ERROR_INVALID_HANDLE. If the compression algorithm does not allow changing the value of this information class, the error can be ERROR_NOT_SUPPORTED. If the compression algorithm does not allow the information class, the error can be ERROR_UNSUPPORTED_TYPE.

Windows Phone 8.1: This API is supported.

Requirements

Header

Compressapi.h on Windows 8 and Windows Server 2012

Library

Cabinet.lib

See also

Compression API Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft