summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPieter Noordhuis <pcnoordhuis@gmail.com>2010-11-01 13:01:42 +0100
committerPieter Noordhuis <pcnoordhuis@gmail.com>2010-11-01 13:01:42 +0100
commit4b530833c6fc872aa33f7113637b85381d11d446 (patch)
treee9a3b760f532dae8dda374255154d86ed8cf91b6
parent728de4a695a9f5f76dceb7c73ea8a20487cfd331 (diff)
Add comment on return value of redisGetReply
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 559f360..e2ed876 100644
--- a/README.md
+++ b/README.md
@@ -148,7 +148,12 @@ to the `redisCommand` family, apart from not returning a reply:
void redisAppendCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen);
After calling either function one or more times, `redisGetReply` can be used to receive the
-subsequent replies:
+subsequent replies. The return value for this function is either `REDIS_OK` or `REDIS_ERR`, where
+the latter means an error occurred while reading a reply. Just as with the other commands,
+the `error` field in the context can be used to find out what the cause of this error is.
+
+The following examples shows a simple pipeline (resulting in only a single call to `write(2)` and
+a single call to `write(2)`):
redisReply *reply;
redisAppendCommand(context,"SET foo bar");