Money functions

Functions to manipulate the MONEY datatype. More...

Functions
RETCODE	dbmny4add (DBPROCESS *dbproc, DBMONEY4 *m1, DBMONEY4 *m2, DBMONEY4 *sum)
	Add two DBMONEY4 values. More...
int	dbmny4cmp (DBPROCESS *dbproc, DBMONEY4 *m1, DBMONEY4 *m2)
	Compare two DBMONEY4 values. More...
RETCODE	dbmny4copy (DBPROCESS *dbproc, DBMONEY4 *src, DBMONEY4 *dest)
	Copy a DBMONEY4 value. More...
RETCODE	dbmny4divide (DBPROCESS *dbproc, DBMONEY4 *m1, DBMONEY4 *m2, DBMONEY4 *quotient)
	Divide two DBMONEY4 values. More...
RETCODE	dbmny4minus (DBPROCESS *dbproc, DBMONEY4 *src, DBMONEY4 *dest)
	Negate a DBMONEY4 value. More...
RETCODE	dbmny4mul (DBPROCESS *dbproc, DBMONEY4 *m1, DBMONEY4 *m2, DBMONEY4 *prod)
	Multiply two DBMONEY4 values. More...
RETCODE	dbmny4sub (DBPROCESS *dbproc, DBMONEY4 *m1, DBMONEY4 *m2, DBMONEY4 *diff)
	Subtract two DBMONEY4 values. More...
RETCODE	dbmny4zero (DBPROCESS *dbproc, DBMONEY4 *dest)
	Zero a DBMONEY4 value. More...
RETCODE	dbmnyadd (DBPROCESS *dbproc, DBMONEY *m1, DBMONEY *m2, DBMONEY *sum)
	Add two DBMONEY values. More...
int	dbmnycmp (DBPROCESS *dbproc, DBMONEY *m1, DBMONEY *m2)
	Compare two DBMONEY values. More...
RETCODE	dbmnycopy (DBPROCESS *dbproc, DBMONEY *src, DBMONEY *dest)
	Copy a DBMONEY value. More...
RETCODE	dbmnydec (DBPROCESS *dbproc, DBMONEY *amount)
	Subtract $0.0001 from a DBMONEY value. More...
RETCODE	dbmnydivide (DBPROCESS *dbproc, DBMONEY *m1, DBMONEY *m2, DBMONEY *quotient)
	Divide two DBMONEY values. More...
RETCODE	dbmnydown (DBPROCESS *dbproc, DBMONEY *amount, int divisor, int *remainder)
	Divide a DBMONEY value by a positive integer. More...
RETCODE	dbmnyinc (DBPROCESS *dbproc, DBMONEY *amount)
	Add $0.0001 to a DBMONEY value. More...
RETCODE	dbmnyinit (DBPROCESS *dbproc, DBMONEY *amount, int trim, DBBOOL *negative)
	Prepare a DBMONEY value for use with dbmnyndigit(). More...
RETCODE	dbmnymaxneg (DBPROCESS *dbproc, DBMONEY *amount)
	Get maximum negative DBMONEY value supported. More...
RETCODE	dbmnymaxpos (DBPROCESS *dbproc, DBMONEY *amount)
	Get maximum positive DBMONEY value supported. More...
RETCODE	dbmnyminus (DBPROCESS *dbproc, DBMONEY *src, DBMONEY *dest)
	Negate a DBMONEY value. More...
RETCODE	dbmnymul (DBPROCESS *dbproc, DBMONEY *m1, DBMONEY *m2, DBMONEY *prod)
	Multiply two DBMONEY values. More...
RETCODE	dbmnyndigit (DBPROCESS *dbproc, DBMONEY *mnyptr, DBCHAR *digit, DBBOOL *zero)
	Get the least significant digit of a DBMONEY value, represented as a character. More...
RETCODE	dbmnyscale (DBPROCESS *dbproc, DBMONEY *amount, int multiplier, int addend)
	Multiply a DBMONEY value by a positive integer, and add an amount. More...
RETCODE	dbmnysub (DBPROCESS *dbproc, DBMONEY *m1, DBMONEY *m2, DBMONEY *difference)
	Subtract two DBMONEY values. More...
RETCODE	dbmnyzero (DBPROCESS *dbproc, DBMONEY *dest)
	Set a DBMONEY value to zero. More...

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

dbproc	contains all information needed by db-lib to manage communications with the server.
m1	first operand.
m2	other operand.
sum	output: result of computation.

Return values

SUCCEED	usually.
FAIL	on 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

dbproc	contains all information needed by db-lib to manage communications with the server.
m1	some money.
m2	some other money.

Return values

0	m1 == m2.
-1	m1 < m2.
1	m1 > 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

dbproc	contains all information needed by db-lib to manage communications with the server.
src	address of a DBMONEY4 structure.
dest	output: new money.

Return values

SUCCEED

or FAIL if src/dest NULL.

See Also

dbmnycopy(), dbmnyminus(), dbmny4minus().

RETCODE dbmny4divide	(	DBPROCESS *	dbproc,
		DBMONEY4 *	m1,
		DBMONEY4 *	m2,
		DBMONEY4 *	quotient
	)

Divide two DBMONEY4 values.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
m1	dividend.
m2	divisor.
quotient	output: result of computation.

Return values

SUCCEED	usually.
FAIL	a parameter is NULL.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

Todo:

Unimplemented.

RETCODE dbmny4minus	(	DBPROCESS *	dbproc,
		DBMONEY4 *	src,
		DBMONEY4 *	dest
	)

Negate a DBMONEY4 value.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
src	address of a DBMONEY4 structure.
dest	output: result of negation.

Return values

SUCCEED	usually.
FAIL	on overflow.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

RETCODE dbmny4mul	(	DBPROCESS *	dbproc,
		DBMONEY4 *	m1,
		DBMONEY4 *	m2,
		DBMONEY4 *	prod
	)

Multiply two DBMONEY4 values.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
m1	first operand.
m2	other operand.
prod	output: result of computation.

Return values

SUCCEED	usually.
FAIL	a parameter is NULL.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

Todo:

Unimplemented.

RETCODE dbmny4sub	(	DBPROCESS *	dbproc,
		DBMONEY4 *	m1,
		DBMONEY4 *	m2,
		DBMONEY4 *	diff
	)

Subtract two DBMONEY4 values.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
m1	first operand.
m2	other operand, subtracted from m1.
diff	output: result of computation.

Return values

SUCCEED	usually.
FAIL	on overflow.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

RETCODE dbmny4zero	(	DBPROCESS *	dbproc,
		DBMONEY4 *	dest
	)

Zero a DBMONEY4 value.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
dest	address of a DBMONEY structure.

Return values

SUCCEED	usually.
FAIL	dest is NULL.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

RETCODE dbmnyadd	(	DBPROCESS *	dbproc,
		DBMONEY *	m1,
		DBMONEY *	m2,
		DBMONEY *	sum
	)

Add two DBMONEY values.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
m1	first operand.
m2	other operand.
sum	output: result of computation.

Return values

SUCCEED

Always.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

Todo:

Unimplemented.

int dbmnycmp	(	DBPROCESS *	dbproc,
		DBMONEY *	m1,
		DBMONEY *	m2
	)

Compare two DBMONEY values.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
m1	some money.
m2	some other money.

Return values

0	m1 == m2.
-1	m1 < m2.
1	m1 > 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

dbproc	contains all information needed by db-lib to manage communications with the server.
src	address of a DBMONEY structure.
dest	output: new money.

Return values

SUCCEED

always, unless src or dest is NULL.

See Also

RETCODE dbmnydec	(	DBPROCESS *	dbproc,
		DBMONEY *	amount
	)

Subtract $0.0001 from a DBMONEY value.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
amount	address of a DBMONEY structure.

Return values

SUCCEED

or FAIL if overflow or amount NULL.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

RETCODE dbmnydivide	(	DBPROCESS *	dbproc,
		DBMONEY *	m1,
		DBMONEY *	m2,
		DBMONEY *	quotient
	)

Divide two DBMONEY values.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
m1	dividend.
m2	divisor.
quotient	output: result of computation.

Return values

SUCCEED

Always.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

Todo:

Unimplemented.

RETCODE dbmnydown	(	DBPROCESS *	dbproc,
		DBMONEY *	amount,
		int	divisor,
		int *	remainder
	)

Divide a DBMONEY value by a positive integer.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
amount	address of a DBMONEY structure.
divisor	of amount.
remainder	output: modulo of integer division.

Return values

SUCCEED

Always.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

Todo:

Unimplemented.

RETCODE dbmnyinc	(	DBPROCESS *	dbproc,
		DBMONEY *	amount
	)

Add $0.0001 to a DBMONEY value.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
amount	address of a DBMONEY structure.

Return values

SUCCEED

or FAIL if overflow or amount NULL.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

RETCODE dbmnyinit	(	DBPROCESS *	dbproc,
		DBMONEY *	amount,
		int	trim,
		DBBOOL *	negative
	)

Prepare a DBMONEY value for use with dbmnyndigit().

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
amount	address of a DBMONEY structure.
trim	number of digits to trim from amount.
negative	output: TRUE if amount < 0.

Return values

SUCCEED

Always.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

Todo:

Unimplemented.

RETCODE dbmnymaxneg	(	DBPROCESS *	dbproc,
		DBMONEY *	amount
	)

Get maximum negative DBMONEY value supported.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
amount	address of a DBMONEY structure.

Return values

SUCCEED

Always.

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

dbproc	contains all information needed by db-lib to manage communications with the server.
amount	address of a DBMONEY structure.

Return values

SUCCEED

Always.

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

dbproc	contains all information needed by db-lib to manage communications with the server.
src	address of a DBMONEY structure.
dest	output: result of negation.

Return values

SUCCEED

or FAIL if overflow or src/dest NULL.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

RETCODE dbmnymul	(	DBPROCESS *	dbproc,
		DBMONEY *	m1,
		DBMONEY *	m2,
		DBMONEY *	prod
	)

Multiply two DBMONEY values.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
m1	first operand.
m2	other operand.
prod	output: result of computation.

Return values

SUCCEED

Always.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

Todo:

Unimplemented.

RETCODE dbmnyndigit	(	DBPROCESS *	dbproc,
		DBMONEY *	mnyptr,
		DBCHAR *	digit,
		DBBOOL *	zero
	)

Get the least significant digit of a DBMONEY value, represented as a character.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
mnyptr	input the money amount, and output: mnyptr divided by 10.
digit	the character value (between '0' and '9') of the rightmost digit in mnyptr.
zero	output: TRUE if mnyptr is zero on output, else FALSE.

Return values

SUCCEED

Always.

See Also

dbconvert(), dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

Remarks

Unimplemented and likely to remain so. We'd be amused to learn anyone wants this function.

Todo:

Unimplemented.

RETCODE dbmnyscale	(	DBPROCESS *	dbproc,
		DBMONEY *	amount,
		int	multiplier,
		int	addend
	)

Multiply a DBMONEY value by a positive integer, and add an amount.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
amount	starting amount of money, also holds output.
multiplier	amount to multiply amount by.
addend	amount to add to amount, after multiplying by multiplier.

Return values

SUCCEED

Always.

Remarks

This function is goofy.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

Todo:

Unimplemented.

RETCODE dbmnysub	(	DBPROCESS *	dbproc,
		DBMONEY *	m1,
		DBMONEY *	m2,
		DBMONEY *	difference
	)

Subtract two DBMONEY values.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
m1	first operand.
m2	other operand, subtracted from m1.
difference	output: result of computation.

Return values

SUCCEED

Always.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().

Todo:

Unimplemented.

RETCODE dbmnyzero	(	DBPROCESS *	dbproc,
		DBMONEY *	dest
	)

Set a DBMONEY value to zero.

Parameters

dbproc	contains all information needed by db-lib to manage communications with the server.
dest	address of a DBMONEY structure.

Return values

SUCCEED

unless amount is NULL.

See Also

dbmnyadd(), dbmnysub(), dbmnymul(), dbmnydivide(), dbmnyminus(), dbmny4add(), dbmny4sub(), dbmny4mul(), dbmny4divide(), dbmny4minus().