Expand Minimize

ResetCompressor function

Prepares the compressor for the compression of a new stream. The compressor object retains properties set with SetCompressorInformation. The sequence of blocks generated is independent of previous blocks.

Syntax


BOOL ResetCompressor(
  _In_  COMPRESSOR_HANDLE CompressorHandle
);

Parameters

CompressorHandle [in]

Handle to the compressor returned by CreateCompressor.

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.

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. All rights reserved.