max/iphreeqc
1
0
Fork 0
mirror of https://git.gfz-potsdam.de/naaice/iphreeqc.git synced 2025-12-15 16:18:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

updating documentation for C/Fortran routines

Browse Source 
git-svn-id: svn://136.177.114.72/svn_GW/IPhreeqc/trunk@8177 1feff8c3-07ed-0310-ac33-dd36852eb9cd
This commit is contained in:
Scott R Charlton 2013-11-06 04:05:02 +00:00
parent e5dcf9b9b0
commit 5cf5076dd1
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/IPhreeqc.h
View File

@ -243,9 +243,11 @@ extern "C" {
IPQ_DLL_EXPORT int GetComponentCount(int id);
/**
* Retrieves the currently active <b>SELECTED_OUTPUT</b> user number for use in subsequent calls to GetSelectedOutputXXX routines.
* The initial setting after calling @ref CreateIPhreeqc is @ref IPQ_INVALIDARG. After the first RunXXX method call, the initial setting
* is the lowest defined user number.
* Retrieves the currently active <b>SELECTED_OUTPUT</b> user number for use in subsequent calls to (@ref GetSelectedOutputColumnCount/@ref
* GetSelectedOutputFileName/@ref GetSelectedOutputRowCount/@ref GetSelectedOutputString/@ref GetSelectedOutputStringLine/@ref
* GetSelectedOutputStringLineCount/@ref GetSelectedOutputValue/@ref GetSelectedOutputValue2) routines.
* The initial setting after calling @ref CreateIPhreeqc is @ref IPQ_INVALIDARG. After the first (@ref RunAccumulated/@ref
* RunFile/@ref RunString) method call, the initial setting is the lowest defined user number.
* @param id The instance id returned from @ref CreateIPhreeqc.
* @return The current active <b>SELECTED_OUTPUT</b> user number.
* @see GetNthSelectedOutputUserNumber, GetSelectedOutputCount, SetCurrentSelectedOutputUserNumber
@ -991,7 +993,7 @@ extern "C" {
* @retval IPQ_INVALIDCOL The given column is out of range.
* @retval IPQ_OUTOFMEMORY Memory could not be allocated.
* @retval IPQ_BADINSTANCE The given id is invalid.
* @see GetSelectedOutputFileOn, GetSelectedOutputColumnCount, GetSelectedOutputRowCount, GetSelectedOutputValue2, SetSelectedOutputFileOn
* @see GetCurrentSelectedOutputUserNumber, GetSelectedOutputFileOn, GetSelectedOutputColumnCount, GetSelectedOutputRowCount, GetSelectedOutputValue2, SetCurrentSelectedOutputUserNumber, SetSelectedOutputFileOn
* @remarks
* Row 0 contains the column headings to the selected_ouput.
* @par Examples:
@ -1181,7 +1183,7 @@ Headings
* @retval IPQ_INVALIDCOL The given column is out of range.
* @retval IPQ_OUTOFMEMORY Memory could not be allocated.
* @retval IPQ_BADINSTANCE The given id is invalid.
* @see GetSelectedOutputFileOn, GetSelectedOutputColumnCount, GetSelectedOutputRowCount, GetSelectedOutputValue, SetSelectedOutputFileOn
* @see GetCurrentSelectedOutputUserNumber, GetSelectedOutputFileOn, GetSelectedOutputColumnCount, GetSelectedOutputRowCount, GetSelectedOutputValue, SetCurrentSelectedOutputUserNumber, SetSelectedOutputFileOn
* @remarks
* Row 0 contains the column headings to the selected_ouput.
* @par Examples:
@ -1659,7 +1661,9 @@ Headings
/**
* Sets the currently active SELECTED_OUTPUT user number for use in subsequent calls to (GetSelectedOutputColumnCount/GetSelectedOutputFileName/) routines.
* Sets the currently active SELECTED_OUTPUT user number for use in subsequent calls to (@ref GetSelectedOutputColumnCount/@ref
* GetSelectedOutputFileName/@ref GetSelectedOutputRowCount/@ref GetSelectedOutputString/@ref GetSelectedOutputStringLine/@ref
* GetSelectedOutputStringLineCount/@ref GetSelectedOutputValue/@ref GetSelectedOutputValue2) routines.
* The initial setting after calling @ref CreateIPhreeqc is IPQ_INVALIDARG. After the first (@ref RunAccumulated/@ref
* RunFile/@ref RunString) method call, the initial setting is the lowest defined user number.
* @param id The instance id returned from @ref CreateIPhreeqc.