Caché ObjectScript Reference - InterSystems Documentation

DescriptionThe $INUMBER function validates the numeric value fnumber using the formats specifiedin format. It then converts it to the internal Caché format.If fnumber does not correspond to the specified format and you have not specified erropt,Caché generates an error. If you have specified erropt, an invalidnumeric value returns the erropt string.Parametersformat$INUMBERThe possible format codes are as follows. You can specify them singly or in combination toinstruct $INUMBER to adhere strictly to the format rules. If no format codes are entered,$INUMBER will be as flexible as possible in validating fnumber (see Null Format ProvidesMaximum Flexibility for more information).Code+-PLT,.DescriptionMandatory sign. It can be either leading or trailing unless restricted by eitheran “L” or a “T” format code.Unsigned. No sign may be present in fnumber.Negative numbers must be enclosed in parentheses. Non-negative numbersmust be unsigned, and may have or omit leading and trailing spaces.Leading sign. Sign, if present, must precede the numerical portion of fnumber.Parentheses are not permitted.Trailing sign. Sign, if present, must follow the numerical portion of fnumber.Parentheses are not permitted.Expects fnumber to use the format specified by properties in the currentlocale. The NumericGroupSeparator (“,” by default) may or may not appearin fnumber, but if present, it must consistently appear every NumericGroupSize(3 by default) digits to the left of the decimal point.Requires European numeric group separators (“.”) and European decimalsymbols (“,”) regardless of the current locale. It also requires the use of thePlusSign and MinusSign from the default locale (“+” and “-” respectively).Periods are optional, but if present must consistently appear every three digits(the value of the NumericGroupSeparator property of the default locale) tothe left of the decimal comma.Caché ObjectScript Reference 225