Currency_SetNegativeParens()

Examples


The Currency_SetNegativeParens() function defines whether parentheses should be used to denote a negative value when the specified multiformat value is applied to a currency field.

Syntax

Currency_SetNegativeParens(multiformat_value, use_parens)

Parameters

multiformat_value An integer value that you assign to the currency format being defined. If your application is integrating with Microsoft Dynamics GP, this value must be in the 3000-4999 range. If you’re creating a stand-alone application, this value must be in the 1000-2999 range.

use_parens – A boolean value indicating whether parentheses should be used to denote negative currency values:

[spacer]

Value

Description

true

Parentheses will be used.

false

Parentheses won’t be used.


Return value

Boolean specified in the use_parens parameter.

Comments

If this function is used, it will override settings made by the following functions:

 

If this function or the operating system’s default specifies that parentheses should be used for a given multiformat value, then parentheses will be used, regardless of whether the Currency_SetNegativeSymbol() function was used to define a negative string, or the other functions were used to define negative symbol placement. The negative string or symbol placement specified using the other functions won’t be used with the multiformat value until the Currency_SetNegativeParens() function is used to explicitly state that parentheses shouldn’t be used, thus overriding the operating system’s default.


Documentation Feedback