Currency_SetNegativeSymbol()

Examples


The Currency_SetNegativeSymbol() function defines a string to be used as a negative symbol when the specified multiformat value is applied to a currency field.

Syntax

Currency_SetNegativeSymbol(multiformat_value, neg_string)

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. For stand-alone applications, this value must be in the 1000-2999 range.

neg_string A string value to be used as a negative symbol. This string can be up to five characters in length and can include spaces.

Return value

String specified in the neg_string parameter.

Comments

If the Currency_SetNegativeParens() function or the operating system’s default specifies that parentheses should be used to indicate a negative value, then parentheses will be used, regardless of whether the Currency_SetNegativeSymbol() function was used to define a negative string. The negative string 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