StormLib API Reference

SCompImplode

Description

int WINAPI SCompImplode(
  char * pbOutBuffer,               // Pointer to buffer where imploded data will be stored
  int * pcbOutBuffer,               // Pointer to size of output buffer
  char * pbInBuffer,                // Pointer to buffer with data to be imploded
  int cbInBuffer                    // Size of the input data
);

SCompImplode compresses a data buffer, using Pkware Data Compression library's IMPLODE method.

Parameters

pbOutBuffer

[out] Pointer to buffer where the compressed data will be stored.

pcbOutBuffer

[in, out] On call, pointer to the length of the buffer in pbOutBuffer. When finished, this variable receives length of the compressed data.

pbInBuffer

[in] Pointer to data that are to be imploded.

cbInBuffer

[in] Length of the data pointed by pbInBuffer.

Return Value

When the function succeeds, it returns nonzero. On an error, the function returns FALSE and GetLastError gives the error code.

Remarks

When the compression library was unable to compress the data, it will copy the input data to the output buffer. The caller can determine this by checking size of the output data against size of the input data. If cbOutData == cbInData, it means that the data haven't been compressed.

Availability in Storm.dll

Copyright (c) Ladislav Zezula 2003 - 2010