Php/docs/function.gzwrite
gzwrite
(PHP 4, PHP 5, PHP 7)
gzwrite — Binary-safe gz-file write
Description
gzwrite
( resource $stream
, string $data
[, int|null $length = NULL
] ) : int|false
gzwrite() writes the contents of
data to the given gz-file.
Parameters
streamThe gz-file pointer. It must be valid, and must point to a file successfully opened by gzopen().
dataThe string to write.
lengthThe number of uncompressed bytes to write. If supplied, writing will stop after
length(uncompressed) bytes have been written or the end ofdatais reached, whichever comes first.Note:
Note that if the
lengthargument is given, then the magic_quotes_runtime configuration option will be ignored and no slashes will be stripped fromdata.
Return Values
Returns the number of (uncompressed) bytes written to the given gz-file
stream, or FALSE on failure.
Changelog
| Version | Description |
|---|---|
| 8.0.0 | length is nullable now; previously, the default was
|
| 7.4.0 | This functions returns FALSE on failure now; previously 0 was returned.
|
Examples
Example #1 gzwrite() example
<?php$string = 'Some information to compress';$gz = gzopen('somefile.gz','w9');gzwrite($gz, $string);gzclose($gz);?>
