From 84b48121bbdc92a88a54fce6d59c8ca37c412031 Mon Sep 17 00:00:00 2001 From: Max Bruckner Date: Tue, 6 Dec 2016 08:46:48 +0700 Subject: [PATCH] header: explain PrintPreallocated return value --- cJSON.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cJSON.h b/cJSON.h index ca79ae9..2b45b5a 100644 --- a/cJSON.h +++ b/cJSON.h @@ -83,7 +83,7 @@ extern char *cJSON_Print(const cJSON *item); extern char *cJSON_PrintUnformatted(const cJSON *item); /* Render a cJSON entity to text using a buffered strategy. prebuffer is a guess at the final size. guessing well reduces reallocation. fmt=0 gives unformatted, =1 gives formatted */ extern char *cJSON_PrintBuffered(const cJSON *item, int prebuffer, int fmt); -/* Render a cJSON entity to text using a buffer already allocated in memory with length buf_len */ +/* Render a cJSON entity to text using a buffer already allocated in memory with length buf_len. Returns 1 on success and 0 on failure. */ extern int cJSON_PrintPreallocated(cJSON *item, char *buf, const int len, const int fmt); /* Delete a cJSON entity and all subentities. */ extern void cJSON_Delete(cJSON *c);