From b30e281627d86f3c0d0f4d5008bbbf7e77c09350 Mon Sep 17 00:00:00 2001 From: Carl Worth Date: Wed, 12 Apr 2006 13:55:24 -0700 Subject: [PATCH] Add documentation for _cairo_output_stream_create_for_file. --- src/cairoint.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/cairoint.h b/src/cairoint.h index 4cfa94840..13880cb85 100644 --- a/src/cairoint.h +++ b/src/cairoint.h @@ -2192,6 +2192,13 @@ _cairo_output_stream_get_status (cairo_output_stream_t *stream); cairo_private cairo_output_stream_t * _cairo_output_stream_create_for_filename (const char *filename); +/* This function never returns NULL. If an error occurs (NO_MEMORY or + * WRITE_ERROR) while trying to create the output stream this function + * returns a valid pointer to a nil output stream. + * + * The caller still "owns" file and is responsible for calling fclose + * on it when finished. The stream will not do this itself. + */ cairo_private cairo_output_stream_t * _cairo_output_stream_create_for_file (FILE *file);