SOL-115460: Added comments to address usage of SOLCLIENTGO_HAS_REPLY_…

…CORRELATION_ID_PREFIX Signed-off-by: Chris Morgan <[email protected]>
SolaceDev · Apr 2, 2024 · ac5e423 · ac5e423
1 parent fe3b170
commit ac5e423
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/internal/ccsmp/ccsmp_helper.h b/internal/ccsmp/ccsmp_helper.h
@@ -56,6 +56,9 @@ uintptr_to_void_p(solClient_uint64_t ptr);
 
 /**
  * Macro for determining if a message correlation has the solclientgo correlation prefix
+ * corrId_p correlation id pointer/expression, must not be NULL.
+ *          Should be a utf8 null terminal string, any string that is not null terminal must
+ *          have a buffer size greater then 4.
  */
 #define SOLCLIENTGO_HAS_REPLY_CORRELATION_ID_PREFIX(corrId_p) (   \
     (corrId_p)[0] == (SOLCLIENTGO_REPLY_CORRELATION_PREFIX)[0] && \