LZ4_initStream

[LZ4_initStream()](API\Runtime\Core\Compression\LZ4_initStream) : v1.9.0+ An LZ4_stream_t structure must be initialized at least once.

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Compression/lz4.h

Include

#include "Compression/lz4.h"

Source

/Engine/Source/Runtime/Core/Private/Compression/lz4.cpp

Syntax

LZ4LZ4_stream_t * LZ4_initStream
(
    void * buffer,
    size_t size
)

Remarks

LZ4_initStream() : v1.9.0+ An LZ4_stream_t structure must be initialized at least once. This is automatically done when invoking LZ4_createStream(), but it's not when the structure is simply declared on stack (for example).

Use LZ4_initStream() to properly initialize a newly declared LZ4_stream_t. It can also initialize any arbitrary buffer of sufficient size, and will

: initialization fails if size and alignment conditions are not respected. In which case, the function will

Returns

  1. Note2: An LZ4_stream_t structure guarantees correct alignment and size. Note3: Before v1.9.0, use LZ4_resetStream() instead