From 4406329100a7a2293186c69cbb86c4620a7a40bc Mon Sep 17 00:00:00 2001 From: MinRK Date: Mon, 28 Jul 2014 13:23:56 -0700 Subject: [PATCH] define encoding for message metadata to be UTF8 clarifies that these are text fields, and removes ambiguity about how to create proper text object from stored bytes. --- doc/zmq_msg_gets.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/zmq_msg_gets.txt b/doc/zmq_msg_gets.txt index 73210d51..f69c386b 100644 --- a/doc/zmq_msg_gets.txt +++ b/doc/zmq_msg_gets.txt @@ -16,9 +16,10 @@ DESCRIPTION ----------- The _zmq_msg_gets()_ function shall return the string value for the metadata property specified by the 'property' argument for the message pointed to by -the 'message' argument. +the 'message' argument. Both the 'property' argument and the 'value' +shall be NULL-terminated UTF8-encoded strings. -The following properties can be retrieved with the _zmq_msg_get()_ function: +The following properties can be retrieved with the _zmq_msg_gets()_ function: RETURN VALUE @@ -26,7 +27,8 @@ RETURN VALUE The _zmq_msg_gets()_ function shall return the string value for the property if successful. Otherwise it shall return NULL and set 'errno' to one of the values defined below. The caller shall not modify or free the returned value, -which shall be owned by the message. +which shall be owned by the message. The encoding of the property and value +shall be UTF8. ERRORS