FreeTDS API
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Functions
Money functions
The db-lib API

Functions to manipulate the MONEY datatype. More...

Functions

RETCODE dbmny4add (DBPROCESS *dbproc, DBMONEY4 *m1, DBMONEY4 *m2, DBMONEY4 *sum)
 Add two DBMONEY4 values.
 
int dbmny4cmp (DBPROCESS *dbproc, DBMONEY4 *m1, DBMONEY4 *m2)
 Compare two DBMONEY4 values.
 
RETCODE dbmny4copy (DBPROCESS *dbproc, DBMONEY4 *src, DBMONEY4 *dest)
 Copy a DBMONEY4 value.
 
RETCODE dbmny4minus (DBPROCESS *dbproc, DBMONEY4 *src, DBMONEY4 *dest)
 Negate a DBMONEY4 value.
 
RETCODE dbmny4sub (DBPROCESS *dbproc, DBMONEY4 *m1, DBMONEY4 *m2, DBMONEY4 *diff)
 Subtract two DBMONEY4 values.
 
RETCODE dbmny4zero (DBPROCESS *dbproc, DBMONEY4 *dest)
 Zero a DBMONEY4 value.
 
int dbmnycmp (DBPROCESS *dbproc, DBMONEY *m1, DBMONEY *m2)
 Compare two DBMONEY values.
 
RETCODE dbmnycopy (DBPROCESS *dbproc, DBMONEY *src, DBMONEY *dest)
 Copy a DBMONEY value.
 
RETCODE dbmnydec (DBPROCESS *dbproc, DBMONEY *amount)
 Subtract $0.0001 from a DBMONEY value.
 
RETCODE dbmnyinc (DBPROCESS *dbproc, DBMONEY *amount)
 Add $0.0001 to a DBMONEY value.
 
RETCODE dbmnymaxneg (DBPROCESS *dbproc, DBMONEY *amount)
 Get maximum negative DBMONEY value supported.
 
RETCODE dbmnymaxpos (DBPROCESS *dbproc, DBMONEY *amount)
 Get maximum positive DBMONEY value supported.
 
RETCODE dbmnyminus (DBPROCESS *dbproc, DBMONEY *src, DBMONEY *dest)
 Negate a DBMONEY value.
 
RETCODE dbmnyzero (DBPROCESS *dbproc, DBMONEY *dest)
 Set a DBMONEY value to zero.
 

Detailed Description

Functions to manipulate the MONEY datatype.

Function Documentation

RETCODE dbmny4add ( DBPROCESS dbproc,
DBMONEY4 m1,
DBMONEY4 m2,
DBMONEY4 sum 
)

Add two DBMONEY4 values.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
m1first operand.
m2other operand.
sumoutput: result of computation.
Return values
SUCCEEDusually.
FAILon overflow.
See Also
dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().
int dbmny4cmp ( DBPROCESS dbproc,
DBMONEY4 m1,
DBMONEY4 m2 
)

Compare two DBMONEY4 values.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
m1some money.
m2some other money.
Return values
0m1 == m2.
-1m1 < m2.
1m1 > m2.
See Also
dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().
RETCODE dbmny4copy ( DBPROCESS dbproc,
DBMONEY4 src,
DBMONEY4 dest 
)

Copy a DBMONEY4 value.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
srcaddress of a DBMONEY4 structure.
destoutput: new money.
Return values
SUCCEEDor FAIL if src/dest NULL.
See Also
dbmnycopy(), dbmnyminus(), dbmny4minus().
RETCODE dbmny4minus ( DBPROCESS dbproc,
DBMONEY4 src,
DBMONEY4 dest 
)

Negate a DBMONEY4 value.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
srcaddress of a DBMONEY4 structure.
destoutput: result of negation.
Return values
SUCCEEDusually.
FAILon overflow.
See Also
dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().
RETCODE dbmny4sub ( DBPROCESS dbproc,
DBMONEY4 m1,
DBMONEY4 m2,
DBMONEY4 diff 
)

Subtract two DBMONEY4 values.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
m1first operand.
m2other operand, subtracted from m1.
diffoutput: result of computation.
Return values
SUCCEEDusually.
FAILon overflow.
See Also
dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().
RETCODE dbmny4zero ( DBPROCESS dbproc,
DBMONEY4 dest 
)

Zero a DBMONEY4 value.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
destaddress of a DBMONEY structure.
Return values
SUCCEEDusually.
FAILdest is NULL.
See Also
dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().
int dbmnycmp ( DBPROCESS dbproc,
DBMONEY m1,
DBMONEY m2 
)

Compare two DBMONEY values.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
m1some money.
m2some other money.
Return values
0m1 == m2.
-1m1 < m2.
1m1 > m2.
See Also
dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().
RETCODE dbmnycopy ( DBPROCESS dbproc,
DBMONEY src,
DBMONEY dest 
)

Copy a DBMONEY value.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
srcaddress of a DBMONEY structure.
destoutput: new money.
Return values
SUCCEEDalways, unless src or dest is NULL.
See Also
RETCODE dbmnydec ( DBPROCESS dbproc,
DBMONEY amount 
)

Subtract $0.0001 from a DBMONEY value.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
amountaddress of a DBMONEY structure.
Return values
SUCCEEDor FAIL if overflow or amount NULL.
See Also
dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().
RETCODE dbmnyinc ( DBPROCESS dbproc,
DBMONEY amount 
)

Add $0.0001 to a DBMONEY value.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
amountaddress of a DBMONEY structure.
Return values
SUCCEEDor FAIL if overflow or amount NULL.
See Also
dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().
RETCODE dbmnymaxneg ( DBPROCESS dbproc,
DBMONEY amount 
)

Get maximum negative DBMONEY value supported.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
amountaddress of a DBMONEY structure.
Return values
SUCCEEDAlways.
See Also
dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().
RETCODE dbmnymaxpos ( DBPROCESS dbproc,
DBMONEY amount 
)

Get maximum positive DBMONEY value supported.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
amountaddress of a DBMONEY structure.
Return values
SUCCEEDAlways.
See Also
dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().
RETCODE dbmnyminus ( DBPROCESS dbproc,
DBMONEY src,
DBMONEY dest 
)

Negate a DBMONEY value.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
srcaddress of a DBMONEY structure.
destoutput: result of negation.
Return values
SUCCEEDor FAIL if overflow or src/dest NULL.
See Also
dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().
RETCODE dbmnyzero ( DBPROCESS dbproc,
DBMONEY dest 
)

Set a DBMONEY value to zero.

Parameters
dbproccontains all information needed by db-lib to manage communications with the server.
destaddress of a DBMONEY structure.
Return values
SUCCEEDunless amount is NULL.
See Also
dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().