Changes between Version 13 and Version 14 of rappture_ccpp_api


Ignore:
Timestamp:
10/22/11 00:50:24 (3 years ago)
Author:
dkearney
Comment:

updating doc to show that rpFreeLibrary requires a pointer to a pointer to a Rappture Library object

Legend:

Unmodified
Added
Removed
Modified
  • rappture_ccpp_api

    v13 v14  
    88 
    99 
    10 '''RpLibrary''' Class 
     10'''!RpLibrary''' Class 
    1111 
    1212  This module provides an interface to Rappture I/O (!RpLibrary) library. 
     
    1515  __'''Constructor'''__ [[BR]] 
    1616 
    17   RpLibrary* ''lib'' = '''rpLibrary(''' ''path'' ''')'''; [[BR]] 
     17  !RpLibrary* ''lib'' = '''rpLibrary(''' ''path'' ''')'''; [[BR]] 
    1818 
    1919  __'''Destructor'''__ [[BR]] 
    2020 
    21   '''rpFreeLibrary(''' ''lib'' ''')'''; [[BR]] 
     21  '''rpFreeLibrary(''' ''&lib'' ''')'''; [[BR]] 
    2222 
    2323  __'''Methods'''__ [[BR]] 
     
    3535  int ''err'' = '''rpElementAsComp(''' ''lib'', ''path'', ''retCStr'' ''')'''; [[BR]] 
    3636  int ''err'' = '''rpElementAsId(''' ''lib'', ''path'', ''retCStr'' ''')'''; [[BR]] 
    37   RpLibrary* ''ele'' = '''rpElement(''' ''lib'', ''path'' ''')'''; [[BR]] 
    38   RpLibrary* ''ele'' = '''rpElementAsObject(''' ''lib'', ''path'' ''')'''; [[BR]] 
    39  
    40   RpLibrary* ''ele'' = '''rpChildren(''' ''lib'', ''path'', ''childEle'' ''')'''; [[BR]] 
    41   RpLibrary* ''ele'' = '''rpChildrenByType(''' ''lib'', ''path'', ''childEle'', ''type'' ''')'''; [[BR]] 
     37  !RpLibrary* ''ele'' = '''rpElement(''' ''lib'', ''path'' ''')'''; [[BR]] 
     38  !RpLibrary* ''ele'' = '''rpElementAsObject(''' ''lib'', ''path'' ''')'''; [[BR]] 
     39 
     40  !RpLibrary* ''ele'' = '''rpChildren(''' ''lib'', ''path'', ''childEle'' ''')'''; [[BR]] 
     41  !RpLibrary* ''ele'' = '''rpChildrenByType(''' ''lib'', ''path'', ''childEle'', ''type'' ''')'''; [[BR]] 
    4242   
    4343  const char* ''retCstr'' = '''rpXml(''' ''lib'' ''')'''; [[BR]] 
     
    6666 
    6767 
    68 '''RpUtils''' Module [[BR]] 
     68'''!RpUtils''' Module [[BR]] 
    6969 
    7070  This module provides an interface to the Rappture Utils Module 
     
    8080 
    8181 
    82 RpLibrary* '''rpLibrary''' (char* ''path'') 
    83  
    84   Purpose:[[BR]] 
    85 Retrieve an object reference to the file pointed to by ''path'' for accessing member functions of Rappture [[BR]] 
    86  
    87   Input Arguments: [[BR]] 
    88 1. char* ''path'' - non-null c style string providing the path to an xml file[[BR]] 
     82!RpLibrary* '''rpLibrary''' (char* ''path'') 
     83 
     84  Purpose:[[BR]] 
     85    Retrieve an object reference to the file pointed to by ''path'' for accessing member functions of Rappture. [[BR]] 
     86 
     87  Input Arguments: [[BR]] 
     88    1) char* ''path'' - non-null c style string providing the path to an xml file.[[BR]] 
    8989 
    9090  Return Value:[[BR]] 
    91 Pointer to a Rappture library (RpLibrary) object[[BR]] 
     91    1) Pointer to a Rappture library (!RpLibrary) object.[[BR]] 
    9292 
    9393  Notes: [[BR]] 
    94 1. On success the return value will be a non-null RpLibrary pointer [[BR]] 
    95 2. ''path'' must be a non-null c-style string [[BR]] 
     94    1) On success the return value will be a non-null !RpLibrary pointer. [[BR]] 
     95    2) ''path'' must be a non-null c-style string. [[BR]] 
     96 
     97int '''rpFreeLibrary''' (!RpLibrary** ''lib'') 
     98 
     99  Purpose:[[BR]] 
     100    Free the Rappture Library object.[[BR]] 
     101 
     102  Input Arguments: [[BR]] 
     103    1) !RpLibrary** ''lib'' - Pointer to a Rappture library (!RpLibrary) object.[[BR]] 
     104 
     105  Return Value:[[BR]] 
     106    1) Integer error flag, 0 on success, 1 on error.[[BR]] 
     107 
     108  Notes: [[BR]] 
     109    1) On success the !RpLibrary pointer will be deleted and set to NULL. [[BR]] 
    96110 
    97111{{{ 
     
    130144    printf ("lib = %x\n",(unsigned int)(lib)); 
    131145 
    132     rpFreeLibrary(lib); 
     146    rpFreeLibrary(&lib); 
    133147    return 0; 
    134148} 
     
    146160 
    147161 
    148 int '''rpGetString''' (RpLibrary* ''lib'', const char* ''path'', const char** ''retCStr'') [[BR]] 
     162int '''rpGetString''' (!RpLibrary* ''lib'', const char* ''path'', const char** ''retCStr'') [[BR]] 
    149163  Purpose:[[BR]] 
    150164    This function retrieves the data held at location ''path'' in the rappture object ''lib''. [[BR]] 
     
    153167    by the function. [[BR]] 
    154168    If path is an empty string, the root of the node is used. ''lib'' [[BR]] 
    155     is a pointer representing the instance of the RpLibrary object. [[BR]] 
    156  
    157   Input Arguments: [[BR]] 
    158 1. RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
    159 2. const char* ''path'' - xml DOM object path. [[BR]] 
    160 3. const char** ''retCStr'' - returned data. [[BR]] 
     169    is a pointer representing the instance of the !RpLibrary object. [[BR]] 
     170 
     171  Input Arguments: [[BR]] 
     172    1) !RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
     173    2) const char* ''path'' - xml DOM object path. [[BR]] 
     174    3) const char** ''retCStr'' - returned data. [[BR]] 
    161175 
    162176  Return Value: [[BR]] 
    163     1) 0 on success, all other values represent failure. 
     177    1) 0 on success, all other values represent failure. [[BR]] 
    164178 
    165179  Notes:  [[BR]] 
    166180    1) **''retCStr'' points to a temporary string containing the result.[[BR]] 
    167181    2) The returned string should not be changed or free'd.[[BR]] 
    168     3) The value stored at the returned address is only guaranteed until the next call to this function[[BR]] 
     182    3) The value stored at the returned address is only guaranteed until the next call to this function.[[BR]] 
    169183 
    170184{{{ 
     
    204218    } 
    205219 
    206     rpFreeLibrary(lib); 
     220    rpFreeLibrary(&lib); 
    207221    return 0; 
    208222} 
     
    221235 
    222236 
    223 int '''rpGetDouble''' (RpLibrary* ''lib'', const char* ''path'', double* ''retDVal'') [[BR]] 
    224   Purpose:[[BR]] 
    225     This function retrieves the data held at location ''path'' in the rappture object ''lib''. [[BR]] 
     237int '''rpGetDouble''' (!RpLibrary* ''lib'', const char* ''path'', double* ''retDVal'') [[BR]] 
     238  Purpose:[[BR]] 
     239    This function retrieves the data held at location ''path'' in the Rappture object ''lib''. [[BR]] 
    226240    After the function has been invoked, the contents of ''retDVal'' [[BR]] 
    227241    will point to the returned value and an integer will be returned [[BR]] 
    228242    by the function. [[BR]] 
    229243    If path is an empty string, the root of the node is used. ''lib'' [[BR]] 
    230     is a pointer representing the instance of the RpLibrary object. [[BR]] 
    231  
    232   Input Arguments: [[BR]] 
    233 1. RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
    234 2. const char* ''path'' - xml DOM object path. [[BR]] 
    235 3. double* ''retDVal'' - returned data. [[BR]] 
     244    is a pointer representing the instance of the !RpLibrary object. [[BR]] 
     245 
     246  Input Arguments: [[BR]] 
     247    1) !RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
     248    2) const char* ''path'' - xml DOM object path. [[BR]] 
     249    3) double* ''retDVal'' - returned data. [[BR]] 
    236250 
    237251  Return Value: [[BR]] 
    238     1) 0 on success, all other values represent failure. 
     252    1) 0 on success, all other values represent failure. [[BR]] 
    239253 
    240254  Notes:  [[BR]] 
     
    277291    } 
    278292 
    279     rpFreeLibrary(lib); 
     293    rpFreeLibrary(&lib); 
    280294    return 0; 
    281295} 
     
    293307 
    294308 
    295 int '''rpPutString''' (RpLibrary* ''lib'', const char* ''path'', const char* ''value'', int ''append'') [[BR]] 
     309int '''rpPutString''' (!RpLibrary* ''lib'', const char* ''path'', const char* ''value'', int ''append'') [[BR]] 
    296310  Purpose:[[BR]] 
    297311    This function places the data from ''value'' into the location ''path'' [[BR]] 
    298312    in the rappture object ''lib'' and returns an integer representing success. [[BR]] 
    299313    If path is an empty string, the root of the node is used. ''lib'' [[BR]] 
    300     is a pointer representing the instance of the RpLibrary object. If the [[BR]] 
     314    is a pointer representing the instance of the !RpLibrary object. If the [[BR]] 
    301315    ''append'' flag is set to 0, then any data existing at ''path'' will be overwritten. [[BR]] 
    302316    If the append flag, is set to 1, then data from ''value will be appended to existing [[BR]] 
     
    304318 
    305319  Input Arguments: [[BR]] 
    306 1. RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
    307 2. const char* ''path'' - xml DOM object path. [[BR]] 
    308 3. const char* ''value'' - returned data. [[BR]] 
    309 4. int ''append'' - tells if data in ''value'' should be appended to existing data at ''path'' [[BR]] 
     320    1) !RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
     321    2) const char* ''path'' - xml DOM object path. [[BR]] 
     322    3) const char* ''value'' - returned data. [[BR]] 
     323    4) int ''append'' - tells if data in ''value'' should be appended to existing data at ''path''. [[BR]] 
    310324 
    311325  Return Value: [[BR]] 
    312     1) 0 on success, all other values represent failure. 
     326    1) 0 on success, all other values represent failure. [[BR]] 
    313327 
    314328  Notes:  [[BR]] 
     
    354368    } 
    355369 
    356     rpFreeLibrary(lib); 
     370    rpFreeLibrary(&lib); 
    357371    return 0; 
    358372} 
     
    380394 
    381395 
    382 int '''rpPutDouble''' (RpLibrary* ''lib'', const char* ''path'', double ''value'', int append) [[BR]] 
     396int '''rpPutDouble''' (!RpLibrary* ''lib'', const char* ''path'', double ''value'', int append) [[BR]] 
    383397  Purpose:[[BR]] 
    384398    This function places the data from ''value'' into the location ''path'' [[BR]] 
    385     in the rappture object ''lib'' and returns an integer representing success. [[BR]] 
     399    in the Rappture object ''lib'' and returns an integer representing success. [[BR]] 
    386400    If path is an empty string, the root of the node is used. ''lib'' [[BR]] 
    387     is a pointer representing the instance of the RpLibrary object. If the [[BR]] 
     401    is a pointer representing the instance of the !RpLibrary object. If the [[BR]] 
    388402    ''append'' flag is set to 0, then any data existing at ''path'' will be overwritten. [[BR]] 
    389403    If the append flag, is set to 1, then data from ''value will be appended to existing [[BR]] 
     
    391405 
    392406  Input Arguments: [[BR]] 
    393 1. RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
    394 2. const char* ''path'' - xml DOM object path. [[BR]] 
    395 3. double ''value'' - data to place into xml node. [[BR]] 
     407    1) !RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
     408    2) const char* ''path'' - xml DOM object path. [[BR]] 
     409    3) double ''value'' - data to place into xml node. [[BR]] 
    396410 
    397411  Return Value: [[BR]] 
    398     1) 0 on success, all other values represent failure. 
     412    1) 0 on success, all other values represent failure. [[BR]] 
    399413 
    400414  Notes:  [[BR]] 
     
    441455    } 
    442456 
    443     rpFreeLibrary(lib); 
     457    rpFreeLibrary(&lib); 
    444458    return 0; 
    445459} 
     
    465479 
    466480 
    467 int '''rpResult''' (RpLibrary* ''lib'') [[BR]] 
    468   Purpose:[[BR]] 
    469     This function writes the xml of the rappture library ''lib'' [[BR]] 
     481int '''rpResult''' (!RpLibrary* ''lib'') [[BR]] 
     482  Purpose:[[BR]] 
     483    This function writes the xml of the Rappture library ''lib'' [[BR]] 
    470484    to a unique run.xml file on disk, and a signal is sent to the [[BR]] 
    471485    rappture graphical user interface. [[BR]] 
    472486 
    473487  Input Arguments: [[BR]] 
    474 1. RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
    475 2. const char** ''retCStr'' - xml DOM object path. [[BR]] 
     488    1) !RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
     489    2) const char** ''retCStr'' - xml DOM object path. [[BR]] 
    476490 
    477491  Return Value: [[BR]] 
     
    515529    } 
    516530 
    517     rpFreeLibrary(lib); 
     531    rpFreeLibrary(&lib); 
    518532    return 0; 
    519533} 
     
    534548 
    535549 
    536 int '''rpElementAsComp''' (RpLibrary* ''lib'', const char* ''path'', const char** ''retCStr'') [[BR]] 
     550int '''rpElementAsComp''' (!RpLibrary* ''lib'', const char* ''path'', const char** ''retCStr'') [[BR]] 
    537551  Purpose:[[BR]] 
    538552    This method searches the Rappture Library Object ''lib'' for the [[BR]] 
    539553    node at the location described by ''path'' and returns its [[BR]] 
    540     component name, a concatination of the type, id, and index. [[BR]] 
     554    component name, a concatenation of the type, id, and index. [[BR]] 
    541555    After the function has been invoked, the contents of ''retCStr'' [[BR]] 
    542556    will point to the returned value and an integer will be returned [[BR]] 
    543557    by the function. [[BR]] 
    544558    If path is an empty string, the root of the node is used. ''lib'' [[BR]] 
    545     is a pointer representing the instance of the RpLibrary object. [[BR]] 
    546  
    547   Input Arguments: [[BR]] 
    548 1. RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
    549 2. const char* ''path'' - xml DOM object path. [[BR]] 
    550 3. const char* ''retCStr'' - node component name. [[BR]] 
     559    is a pointer representing the instance of the !RpLibrary object. [[BR]] 
     560 
     561  Input Arguments: [[BR]] 
     562    1) !RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
     563    2) const char* ''path'' - xml DOM object path. [[BR]] 
     564    3) const char* ''retCStr'' - node component name. [[BR]] 
    551565 
    552566  Return Value: [[BR]] 
    553     1) 0 on success, all other values represent failure. 
     567    1) 0 on success, all other values represent failure. [[BR]] 
    554568 
    555569  Notes:  [[BR]] 
    556570    1) **''retCStr'' points to a temporary string containing the result.[[BR]] 
    557571    2) The returned string should not be changed or free'd.[[BR]] 
    558     3) The value stored at the returned address is only guaranteed until the next call to this function[[BR]] 
     572    3) The value stored at the returned address is only guaranteed until the next call to this function.[[BR]] 
    559573 
    560574{{{ 
     
    588602    printf("comp = %s\n",comp); 
    589603 
    590     rpFreeLibrary(lib); 
     604    rpFreeLibrary(&lib); 
    591605    return 0; 
    592606} 
     
    603617 
    604618 
    605 int '''rpElementAsType''' (RpLibrary* ''lib'', const char* ''path'', const char** ''retCStr'') [[BR]] 
     619int '''rpElementAsType''' (!RpLibrary* ''lib'', const char* ''path'', const char** ''retCStr'') [[BR]] 
    606620  Purpose:[[BR]] 
    607621    This method searches the Rappture Library Object ''lib'' for the [[BR]] 
     
    611625    by the function. [[BR]] 
    612626    If path is an empty string, the root of the node is used. ''lib'' [[BR]] 
    613     is a pointer representing the instance of the RpLibrary object. [[BR]] 
    614  
    615   Input Arguments: [[BR]] 
    616 1. RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
    617 2. const char* ''path'' - xml DOM object path. [[BR]] 
    618 3. const char* ''retCStr'' - node type. [[BR]] 
     627    is a pointer representing the instance of the !RpLibrary object. [[BR]] 
     628 
     629  Input Arguments: [[BR]] 
     630    1) !RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
     631    2) const char* ''path'' - xml DOM object path. [[BR]] 
     632    3) const char* ''retCStr'' - node type. [[BR]] 
    619633 
    620634  Return Value: [[BR]] 
     
    624638    1) **''retCStr'' points to a temporary string containing the result.[[BR]] 
    625639    2) The returned string should not be changed or free'd.[[BR]] 
    626     3) The value stored at the returned address is only guaranteed until the next call to this function[[BR]] 
     640    3) The value stored at the returned address is only guaranteed until the next call to this function.[[BR]] 
    627641 
    628642{{{ 
     
    657671    printf("type = %s\n",typeName); 
    658672 
    659     rpFreeLibrary(lib); 
     673    rpFreeLibrary(&lib); 
    660674    return 0; 
    661675} 
     
    672686 
    673687 
    674 int '''rpElementAsId''' (RpLibrary* ''lib'', const char* ''path'', const char** ''retCStr'') [[BR]] 
     688int '''rpElementAsId''' (!RpLibrary* ''lib'', const char* ''path'', const char** ''retCStr'') [[BR]] 
    675689  Purpose:[[BR]] 
    676690    This method searches the Rappture Library Object ''lib'' for the [[BR]] 
     
    680694    by the function. [[BR]] 
    681695    If path is an empty string, the root of the node is used. ''lib'' [[BR]] 
    682     is a pointer representing the instance of the RpLibrary object. [[BR]] 
    683  
    684   Input Arguments: [[BR]] 
    685 1. RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
    686 2. const char* ''path'' - xml DOM object path. [[BR]] 
    687 3. const char* ''retCStr'' - node id. [[BR]] 
     696    is a pointer representing the instance of the !RpLibrary object. [[BR]] 
     697 
     698  Input Arguments: [[BR]] 
     699    1) !RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
     700    2) const char* ''path'' - xml DOM object path. [[BR]] 
     701    3) const char* ''retCStr'' - node id. [[BR]] 
    688702 
    689703  Return Value: [[BR]] 
     
    693707    1) **''retCStr'' points to a temporary string containing the result.[[BR]] 
    694708    2) The returned string should not be changed or free'd.[[BR]] 
    695     3) The value stored at the returned address is only guaranteed until the next call to this function[[BR]] 
     709    3) The value stored at the returned address is only guaranteed until the next call to this function.[[BR]] 
    696710 
    697711{{{ 
     
    726740    printf("id = %s\n",id); 
    727741 
    728     rpFreeLibrary(lib); 
     742    rpFreeLibrary(&lib); 
    729743    return 0; 
    730744} 
     
    742756 
    743757 
    744 int '''rpXml''' (RpLibrary* ''lib'', const char** ''retCStr'') [[BR]] 
    745   Purpose:[[BR]] 
    746     This function returns the xml of the provided libraryi, ''lib'' [[BR]] 
    747     After a successfun function call, **''retCStr'' will point to the [[BR]] 
     758int '''rpXml''' (!RpLibrary* ''lib'', const char** ''retCStr'') [[BR]] 
     759  Purpose:[[BR]] 
     760    This function returns the xml of the provided library, ''lib'' [[BR]] 
     761    After a successful function call, **''retCStr'' will point to the [[BR]] 
    748762    returned data. [[BR]] 
    749763 
    750764  Input Arguments: [[BR]] 
    751 1. RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
    752 2. const char** ''retCStr'' - xml DOM object path. [[BR]] 
     765    1) !RpLibrary* ''lib'' - user reference to the Rappture library. [[BR]] 
     766    2) const char** ''retCStr'' - xml DOM object path. [[BR]] 
    753767 
    754768  Return Value: [[BR]] 
     
    792806    } 
    793807 
    794     rpFreeLibrary(lib); 
     808    rpFreeLibrary(&lib); 
    795809    return 0; 
    796810} 
     
    821835 
    822836  Purpose:[[BR]] 
    823 Convert the numeric value and units found in the string ''fromVal'' to the units named in ''toUnitsName''. A double precision value is returned. An error code is placed into ''result''. A value of 0 represents success, any other value is failure. [[BR]] 
    824  
    825   Input Arguments: [[BR]] 
    826 1. const char* ''fromVal'' - String representing the numeric value and units you want to convert from. [[BR]] 
    827 2. const char* ''toUnitsName'' - String representing the name of the units you want to convert to. [[BR]] 
    828 3. int* ''result'' - Error flag to tell if conversion was successful or not. [[BR]] 
     837    Convert the numeric value and units found in the string ''fromVal'' [[BR]] 
     838    to the units named in ''toUnitsName''. A double precision value is returned. [[BR]] 
     839    An error code is placed into ''result''. A value of 0 represents success, [[BR]] 
     840    any other value is failure. [[BR]] 
     841 
     842  Input Arguments: [[BR]] 
     843    1) const char* ''fromVal'' - String representing the numeric value and units you want to convert from. [[BR]] 
     844    2) const char* ''toUnitsName'' - String representing the name of the units you want to convert to. [[BR]] 
     845    3) int* ''result'' - Error flag to tell if conversion was successful or not. [[BR]] 
    829846 
    830847  Return Value: [[BR]] 
    831 The converted value is provided as the return value of the function. An error code is returned via the result variable. An error code of 0 represents success, any other value represents failure. [[BR]] 
     848    The converted value is provided as the return value of the function. [[BR]] 
     849    An error code is returned via the result variable. An error code of 0 represents [[BR]] 
     850    success, any other value represents failure. [[BR]] 
    832851 
    833852  Notes: [[BR]] 
    834 For this function, units are not displayed in the resultant converted value returned by the function. [[BR]] 
     853    For this function, units are not displayed in the resultant converted value returned by the function. [[BR]] 
    835854 
    836855{{{ 
     
    880899    } 
    881900 
    882     rpFreeLibrary(lib); 
     901    rpFreeLibrary(&lib); 
    883902    return 0; 
    884903} 
     
    903922 
    904923  Purpose:[[BR]] 
    905 Convert the numeric value and units found in the string ''fromVal'' to the units named in ''toUnitsName''. The ''showUnits'' flag tells whether to attach units onto the returned const char* value. An error code is placed into ''result''. A value of 0 represents success, any other value is failure. [[BR]] 
    906  
    907   Input Arguments: [[BR]] 
    908 1. const char* ''fromVal'' - String representing the numeric value and units you want ot convert from. [[BR]] 
    909 2. const char* ''toUnitsName'' - String representing the name of the units you want to convert to. [[BR]] 
    910 3. int ''showUnits'' - String representing the name of the units you want to convert to. [[BR]] 
    911 4. int* ''result'' - Error flag to tell if conversion was successful or not. [[BR]] 
     924    Convert the numeric value and units found in the string ''fromVal'' [[BR]] 
     925    to the units named in ''toUnitsName''. The ''showUnits'' flag tells [[BR]] 
     926    whether to attach units onto the returned const char* value. An error [[BR]] 
     927    code is placed into ''result''. A value of 0 represents success, any [[BR]] 
     928    other value is failure. [[BR]] 
     929 
     930  Input Arguments: [[BR]] 
     931    1) const char* ''fromVal'' - String representing the numeric value and units you want ot convert from. [[BR]] 
     932    2) const char* ''toUnitsName'' - String representing the name of the units you want to convert to. [[BR]] 
     933    3) int ''showUnits'' - String representing the name of the units you want to convert to. [[BR]] 
     934    4) int* ''result'' - Error flag to tell if conversion was successful or not. [[BR]] 
    912935 
    913936  Return Value: [[BR]] 
    914 A const char* pointer is returned on function exit. The pointer does not belong to the user, it is static and temporary. If the user wants to keep the string, they are responsible for copying the contents of the pointer to their allocated memory. The user should not modify or delete the contents of the returned pointer. [[BR]] 
     937    A const char* pointer is returned on function exit. The pointer does [[BR]] 
     938    not belong to the user, it is static and temporary. If the user wants [[BR]] 
     939    to keep the string, they are responsible for copying the contents of [[BR]] 
     940    the pointer to their allocated memory. The user should not modify or [[BR]] 
     941    delete the contents of the returned pointer. [[BR]] 
    915942 
    916943  Notes: [[BR]] 
    917 Units are always displayed in the return value ''retText''[[BR]] 
     944    Units are always displayed in the return value ''retText''.[[BR]] 
    918945 
    919946{{{ 
     
    963990    } 
    964991 
    965     rpFreeLibrary(lib); 
     992    rpFreeLibrary(&lib); 
    966993    return 0; 
    967994}