Var.h File Reference

IPhreeqc VARIANT Documentation More...

#include "PHRQ_exports.h"

Go to the source code of this file.

Data Structures
struct	VAR
	Datatype used to store SELECTED_OUTPUT values. More...

Enumerations
enum	VAR_TYPE {   TT_EMPTY = 0, TT_ERROR = 1, TT_LONG = 2, TT_DOUBLE = 3,   TT_STRING = 4 }
	Enumeration used to determine the type of data stored in a VAR. More...
enum	VRESULT {   VR_OK = 0, VR_OUTOFMEMORY = -1, VR_BADVARTYPE = -2, VR_INVALIDARG = -3,   VR_INVALIDROW = -4, VR_INVALIDCOL = -5 }
	Enumeration used to return error codes. More...

Functions
IPQ_DLL_EXPORT char *	VarAllocString (const char *pSrc)
IPQ_DLL_EXPORT VRESULT	VarClear (VAR *pvar)
IPQ_DLL_EXPORT VRESULT	VarCopy (VAR *pvarDest, const VAR *pvarSrc)
IPQ_DLL_EXPORT void	VarFreeString (char *pSrc)
IPQ_DLL_EXPORT void	VarInit (VAR *pvar)

Detailed Description

IPhreeqc VARIANT Documentation

Enumeration Type Documentation

enum VAR_TYPE

Enumeration used to determine the type of data stored in a VAR.

Enumerator
TT_EMPTY	VAR contains no data
TT_ERROR	vresult is valid
TT_LONG	lVal is valid
TT_DOUBLE	dVal is valid
TT_STRING	sVal is valid

enum VRESULT

Enumeration used to return error codes.

Enumerator
VR_OK	Success
VR_OUTOFMEMORY	Failure, Out of memory
VR_BADVARTYPE	Failure, Invalid VAR type
VR_INVALIDARG	Failure, Invalid argument
VR_INVALIDROW	Failure, Invalid row
VR_INVALIDCOL	Failure, Invalid column

Function Documentation

IPQ_DLL_EXPORT char* VarAllocString

(

const char *

pSrc

)

Allocates a new string for use in a VAR and copies the passed string into it.

Parameters

pSrc	Pointer to the VAR that will be initialized.

Returns

A pointer to the string on success NULL otherwise.

IPQ_DLL_EXPORT VRESULT VarClear

(

VAR *

pvar

)

Clears a VAR.

Parameters

pvar	Pointer to the VAR that will be freed and initialized.

Return values

VR_OK	Success.
VR_BADVARTYPE	The VAR was invalid (probably uninitialized).

IPQ_DLL_EXPORT VRESULT VarCopy	(	VAR *	pvarDest,
		const VAR *	pvarSrc
	)

Frees the destination VAR and makes a copy of the source VAR.

Parameters

pvarDest	Pointer to the VAR to receive the copy.
pvarSrc	Pointer to the VAR to be copied.

Return values

VR_OK	Success.
VR_BADVARTYPE	The source and/or the destination are invalid (usually uninitialized).
VR_OUTOFMEMORY	Memory could not be allocated for the copy.

Returns

The return value is one of the following.

IPQ_DLL_EXPORT void VarFreeString

(

char *

pSrc

)

Frees a string allocated using VarAllocString.

Parameters

pSrc	Pointer to the string to be freed.

IPQ_DLL_EXPORT void VarInit

(

VAR *

pvar

)

Initializes a VAR.

Parameters

pvar	Pointer to the VAR that will be initialized.