From e04d06e1af142dfc829f2cef5de0ee8c5c65de3c Mon Sep 17 00:00:00 2001 From: Scott R Charlton Date: Sat, 30 Jan 2016 06:02:29 +0000 Subject: [PATCH] documented new optional slength argument to GetSelectedOutputValue git-svn-id: svn://136.177.114.72/svn_GW/IPhreeqc/trunk@10770 1feff8c3-07ed-0310-ac33-dd36852eb9cd --- IPhreeqc.h | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/IPhreeqc.h b/IPhreeqc.h index d3264073..cf60f878 100644 --- a/IPhreeqc.h +++ b/IPhreeqc.h @@ -1146,14 +1146,15 @@ Headings * @htmlonly * *
- *  FUNCTION GetSelectedOutputValue(ID,ROW,COL,VTYPE,DVALUE,SVALUE)
- *    INTEGER(KIND=4),   INTENT(IN)   :: ID
- *    INTEGER(KIND=4),   INTENT(IN)   :: ROW
- *    INTEGER(KIND=4),   INTENT(IN)   :: COL
- *    INTEGER(KIND=4),   INTENT(OUT)  :: VTYPE
- *    REAL(KIND=8),      INTENT(OUT)  :: DVALUE
- *    CHARACTER(LEN=*),  INTENT(OUT)  :: SVALUE
- *    INTEGER(KIND=4)                 :: GetSelectedOutputValue
+ *  FUNCTION GetSelectedOutputValue(ID,ROW,COL,VTYPE,DVALUE,SVALUE,SLENGTH)
+ *    INTEGER(KIND=4),   INTENT(IN)            :: ID
+ *    INTEGER(KIND=4),   INTENT(IN)            :: ROW
+ *    INTEGER(KIND=4),   INTENT(IN)            :: COL
+ *    INTEGER(KIND=4),   INTENT(OUT)           :: VTYPE
+ *    REAL(KIND=8),      INTENT(OUT)           :: DVALUE
+ *    CHARACTER(LEN=*),  INTENT(OUT)           :: SVALUE
+ *    INTEGER(KIND=4),   INTENT(OUT), OPTIONAL :: SLENGTH
+ *    INTEGER(KIND=4)                          :: GetSelectedOutputValue
  *  END FUNCTION GetSelectedOutputValue
  *  
*
@@ -1164,6 +1165,7 @@ Headings * @param VTYPE Returns the variable type. See @ref VAR_TYPE. * @param DVALUE Returns the numeric value when (VTYPE=@ref TT_DOUBLE) or (VTYPE=@ref TT_LONG). * @param SVALUE Returns the string variable when (VTYPE=@ref TT_STRING). When (VTYPE=@ref TT_DOUBLE) or (VTYPE=@ref TT_LONG) this variable is filled with a string equivalent of DVALUE. + * @param SLENGTH Optional, if the length of SVALUE isn't sufficient to hold the entire string value, returns the required length, otherwise returns 0 (zero). * @anchor GetSelectedOutputValue_c * @par C Example: * @include GetSelectedOutputValue.c