Added example for CmiAlloc
authorFilippo Gioachin <gioachin@illinois.edu>
Sat, 24 Jan 2004 00:47:10 +0000 (00:47 +0000)
committerFilippo Gioachin <gioachin@illinois.edu>
Sat, 24 Jan 2004 00:47:10 +0000 (00:47 +0000)
doc/converse/cmi.tex

index 0b8d504cbaee7b59999d4dc702e259aa721936dc..2e28c1ba623a5ab9e24e25d84d8ddc72d87d89c4 100644 (file)
@@ -129,7 +129,9 @@ should be a pointer that was previously returned by \kw{CmiAlloc}.}
 \index{CmiMsgHeaderSizeBytes}
 \desc{This constant contains the size of the message header.  When one
 allocates a message buffer, one must set aside enough space for the header
-and the data.  This macro helps you to do so.}
+and the data.  This macro helps you to do so. For example, if one want to
+allocate an array of 100 int, he should call the function this way:
+\tt{``char *myMsg = CmiAlloc(100*sizeof(int) + CmiMsgHeaderSizeBytes)''}}
 
 \function {void CmiSetHandler(int *MessageBuffer, int HandlerId)}
 \index{CmiSetHandler}