###User Defined Function###
_WinAPI_DecompressBuffer

###Description###
Decompresses an entire compressed buffer.

###Syntax###
#include <WinAPISys.au3>
_WinAPI_DecompressBuffer ( $pUncompressedBuffer, $iUncompressedSize, $pCompressedBuffer, $iCompressedSize [, $iFormat = 0x0002] )


###Parameters###
@@ParamTable@@
$pUncompressedBuffer
	A pointer to a caller-allocated buffer that receives the decompressed data from compressed buffer.
$iUncompressedSize
	The size of the uncompressed buffer, in bytes.
$pCompressedBuffer
	A pointer to the buffer that contains the data to decompress.
$iCompressedSize
	The size of the compressed buffer, in bytes.
$iFormat
	[optional] The compression format of the data in compressed buffer. This parameter must be one of the following values:
		$COMPRESSION_FORMAT_LZNT1 (Default)
		$COMPRESSION_FORMAT_XPRESS
		$COMPRESSION_FORMAT_XPRESS_HUFF
@@End@@

###ReturnValue###
@@ReturnTable@@
Success 	The size of the decompressed data stored in uncompressed buffer, in bytes.
Failure 	0 and sets the @error flag to non-zero, @extended flag may contain the NTSTATUS error code.
@@End@@


###Remarks###
The <a href="_WinAPI_DecompressBuffer.htm">_WinAPI_DecompressBuffer()</a> function takes as input an entire compressed buffer and produces its decompressed equivalent provided that the uncompressed data fits within the specified destination buffer.

To compress an uncompressed buffer, use the <a href="_WinAPI_CompressBuffer.htm">_WinAPI_CompressBuffer()</a> function.


###Related###
_WinAPI_CompressBuffer


###See Also###
@@MsdnLink@@ RtlDecompressBuffer


###Example###
@@IncludeExample@@
