[prev in list] [next in list] [prev in thread] [next in thread] 

List:       jakarta-commons-dev
Subject:    svn commit: r1098049 -
From:       mturk () apache ! org
Date:       2011-04-30 6:57:23
Message-ID: 20110430065723.642FC23889C5 () eris ! apache ! org
[Download RAW message or body]

Author: mturk
Date: Sat Apr 30 06:57:23 2011
New Revision: 1098049

URL: http://svn.apache.org/viewvc?rev=1098049&view=rev
Log:
API comments

Modified:
    commons/sandbox/runtime/trunk/src/main/native/include/acr/string.h

Modified: commons/sandbox/runtime/trunk/src/main/native/include/acr/string.h
URL: http://svn.apache.org/viewvc/commons/sandbox/runtime/trunk/src/main/native/include/acr/string.h?rev=1098049&r1=1098048&r2=1098049&view=diff
 ==============================================================================
--- commons/sandbox/runtime/trunk/src/main/native/include/acr/string.h (original)
+++ commons/sandbox/runtime/trunk/src/main/native/include/acr/string.h Sat Apr 30 \
06:57:23 2011 @@ -100,6 +100,9 @@ AcrGetNativeCodePage(const char *cs);
 /** Convert java string to wide char string
  * @param env Current JNI environment.
  * @param s String to convert.
+ * @paman b Optional stack buffer of ACR_MBUFF_SIZ size.
+ *          If provided and string is smaller then its size
+ *          it will be used instead allocating memory.
  * @remark When done use AcrFree to free the allocated memory.
  */
 wchar_t *
@@ -124,10 +127,15 @@ AcrGetJavaStringA(JNI_STDENV, jstring s,
 char *
 AcrGetJavaStringU(JNI_STDENV, jstring s, char *b);
 
-/** Convert java string to wide char string
+/** Convert java char array to wide char string
  * @param env Current JNI environment.
  * @param s String to convert.
+ * @paman b Optional stack buffer of ACR_MBUFF_SIZ size.
+ *          If provided and string is smaller then its size
+ *          it will be used instead allocating memory.
  * @remark When done use AcrFree to free the allocated memory.
+ *         The char array is presumed to be NUL terminated and
+ *         of exact size.
  */
 wchar_t *
 AcrGetJavaStringC(JNI_STDENV, jcharArray s, wchar_t *b);


[prev in list] [next in list] [prev in thread] [next in thread]