From 008f6de8a97755c8c52c56f4798227d50e386037 Mon Sep 17 00:00:00 2001
From: Scott R Charlton <charlton@usgs.gov>
Date: Thu, 20 May 2010 19:09:51 +0000
Subject: [PATCH] Added VAR functions to chm file

git-svn-id: svn://136.177.114.72/svn_GW/IPhreeqc/trunk@4440 1feff8c3-07ed-0310-ac33-dd36852eb9cd
---
 doc/TOC.hhc   | 26 ++++++++++++++++++++++++++
 include/Var.h | 21 ++++++++++-----------
 2 files changed, 36 insertions(+), 11 deletions(-)

diff --git a/doc/TOC.hhc b/doc/TOC.hhc
index d2f9bd0e..8989c77c 100644
--- a/doc/TOC.hhc
+++ b/doc/TOC.hhc
@@ -196,5 +196,31 @@
 			<param name="Local" value="html\IPhreeqc_8h.html#ab972eca345175f5703918c05737e725a">
 			</OBJECT>
 	</UL>
+	<LI> <OBJECT type="text/sitemap">
+		<param name="Name" value="C/C++ VAR Reference">
+		<param name="Local" value="html\Var_8h.html">
+		</OBJECT>
+	<UL>
+		<LI> <OBJECT type="text/sitemap">
+			<param name="Name" value="VarAllocString">
+			<param name="Local" value="html\Var_8h.html#a4bc9504b10b2cce50efd0312703ac1f9">
+			</OBJECT>
+		<LI> <OBJECT type="text/sitemap">
+			<param name="Name" value="VarClear">
+			<param name="Local" value="html\Var_8h.html#a697bc568210799b851797b8232d6ddea">
+			</OBJECT>
+		<LI> <OBJECT type="text/sitemap">
+			<param name="Name" value="VarCopy">
+			<param name="Local" value="html\Var_8h.html#a87ebbf36638bfb913ab9ab9acf87bb45">
+			</OBJECT>
+		<LI> <OBJECT type="text/sitemap">
+			<param name="Name" value="VarFreeString">
+			<param name="Local" value="html\Var_8h.html#a323d0b3678b4187a3dbba35a5ded0f1f">
+			</OBJECT>
+		<LI> <OBJECT type="text/sitemap">
+			<param name="Name" value="VarInit">
+			<param name="Local" value="html\Var_8h.html#a54f8cc0deea8289bec3aceceb71c9ef3">
+			</OBJECT>
+	</UL>
 </UL>
 </BODY></HTML>
diff --git a/include/Var.h b/include/Var.h
index 57bc1c21..af3dad1a 100644
--- a/include/Var.h
+++ b/include/Var.h
@@ -50,10 +50,11 @@ typedef struct {
 extern "C" {
 #endif
 
-/** Initializes a VAR.
- *  @param pvar Pointer to the VAR that will be initialized.
+/** Allocates a new string for use in a VAR and copies the passed string into it.
+ *  @param pSrc Pointer to the VAR that will be initialized.
+ *  @return A pointer to the string on success NULL otherwise.
  */
-IPQ_DLL_EXPORT void VarInit(VAR* pvar);
+IPQ_DLL_EXPORT char*   VarAllocString(const char* pSrc);
 
 /** Clears a VAR.
  *  @param pvar Pointer to the VAR that will be freed and initialized.
@@ -72,17 +73,15 @@ IPQ_DLL_EXPORT VRESULT VarClear(VAR* pvar);
  */
 IPQ_DLL_EXPORT VRESULT VarCopy(VAR* pvarDest, const VAR* pvarSrc);
 
-
-/** Allocates a new string for use in a VAR and copies the passed string into it.
- *  @param pSrc Pointer to the VAR that will be initialized.
- *  @return A pointer to the string on success NULL otherwise.
- */
-IPQ_DLL_EXPORT char* VarAllocString(const char* pSrc);
-
 /** Frees a string allocated using VarAllocString.
  *  @param pSrc Pointer to the string to be freed.
  */
-IPQ_DLL_EXPORT void VarFreeString(char* pSrc);
+IPQ_DLL_EXPORT void    VarFreeString(char* pSrc);
+
+/** Initializes a VAR.
+ *  @param pvar Pointer to the VAR that will be initialized.
+ */
+IPQ_DLL_EXPORT void    VarInit(VAR* pvar);
 
 #if defined(__cplusplus)
 }